author | Wuzzy |
Fri, 09 Feb 2018 21:05:04 +0000 | |
changeset 1168 | 032b2771c757 |
parent 1167 | 0fef28e4ee0d |
child 1169 | f36679317ec0 |
permissions | -rw-r--r-- |
431 | 1 |
#summary List of all visual gear types |
2 |
||
1163 | 3 |
This is a list of available visual gear types, as of 0.9.23. |
697 | 4 |
|
5 |
For a current list of the visual gear types look at `hedgewars/uTypes.pas` at |
|
1163 | 6 |
the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115 |
695 | 7 |
|
1167 | 8 |
== List of visual gear types == |
9 |
=== Environment === |
|
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
10 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
11 |
|| `vgtFlake` || Theme flake || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
12 |
|| `vgtChunk` || Theme chunk (spawns when blowing up land) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
13 |
|| `vgtCloud` || Cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
14 |
|| `vgtDust` || Dust cloud (e.g. of mudball) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
15 |
|| `vgtSplash` || Water splash || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
16 |
|| `vgtDroplet` || Water droplet || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
17 |
|| `vgtBubble` || Underwater bubble || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
18 |
|| `vgtSteam` || Steam cloud (when fire hits water) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
19 |
|| `vgtFire` || Small decorative/harmless flame || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
20 |
|| `vgtSmoke` || Gray smoke cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
21 |
|| `vgtSmokeWhite` || White smoke cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
22 |
|
1167 | 23 |
=== Explosion === |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
24 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
25 |
|| `vgtExplosion` || Small explosion (complete animation) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
26 |
|| `vgtBigExplosion` || Big explosion (complete animation which also makes screen shake) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
27 |
|| `vgtExplPart` || Small explosion particle, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
28 |
|| `vgtExplPart2` || Another small explosion particle, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
29 |
|| `vgtSmokeRing` || Smoke ring, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
30 |
|
1167 | 31 |
=== Weapons and projectiles === |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
32 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
33 |
|| `vgtNote` || Piano note || |
1163 | 34 |
|| `vgtBeeTrace` || Random colored flower (bee particle) || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
35 |
|| `vgtEgg` || Broken egg shell particle || |
1163 | 36 |
|| `vgtFeather` || Birdy's feather || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
37 |
|| `vgtSmokeTrace` || Strange smoke-like cloud from mortar || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
38 |
|| `vgtEvilTrace` || Strange red cloud from hellish hand-grenade || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
39 |
|| `vgtShell` || Bullet shell || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
40 |
|| `vgtBulletHit` || Bullet impact animation || |
1164 | 41 |
|| `vgtStraightShot` || Shot line from firearms like Desert Eagle. Also used to render arbitrary sprites like the “+” particles for gaining health || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
42 |
|
1167 | 43 |
=== HUD === |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
44 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
45 |
|| `vgtCircle` || Simple circle. Highly configurable! || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
46 |
|| `vgtSmallDamageTag` || Small damage tag after hog damage. Useful to display a number in the game || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
47 |
|| `vgtNoPlaceWarn` || Overlay when the placement of something failed || |
1166 | 48 |
|| `vgtAmmo` || Briefly displays an ammo icon. Appears when collecting a crate || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
49 |
|| `vgtSmoothWindBar` || Changes the wind bar smoothly || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
50 |
|| `vgtHealthTag` || ??? || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
51 |
|| `vgtTeamHealthSorter` || ??? || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
52 |
|| `vgtSpeechBubble` || ??? || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
53 |
|
1167 | 54 |
=== Misc. === |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
55 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
56 |
|| `vgtLineTrail` || ??? || |
1167 | 57 |
|
58 |
== Detailed visual gear reference == |
|
1168 | 59 |
Here you will find a (more or less) detailed references of the various possible values for the visual gears (for `SetVisualGearValues`). This is useful to customize your visual gears. |
60 |
||
61 |
This section is still under construction! |
|
1167 | 62 |
|
63 |
== `vgtCircle` == |
|
64 |
A simple circle. If you set `dX`, `dY` and `FrameTicks`, the circle pulsates in opacity. |
|
65 |
||
1168 | 66 |
* `dX`: Minimum opacity (0-255) |
67 |
* `dY`: Maximum opacity (0-255) |
|
68 |
* `FrameTicks`: ??? |
|
69 |
* `State`: Radius |
|
70 |
* `Timer`: Thickness |
|
1167 | 71 |
|
72 |
== `vgtAmmo` == |
|
73 |
Displays an ammo icon. |
|
74 |
||
1168 | 75 |
* `State`: [AmmoType] ID of ammo to display |