author | Wuzzy |
Wed, 21 Jun 2023 13:33:14 +0000 | |
changeset 2246 | 9cee5aab336d |
parent 2217 | 50275983a97a |
permissions | -rw-r--r-- |
431 | 1 |
#summary List of all visual gear types |
2077
514babfbad9e
Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents:
2069
diff
changeset
|
2 |
This is a list of available visual gear types. |
697 | 3 |
|
4 |
For a current list of the visual gear types look at `hedgewars/uTypes.pas` at |
|
1163 | 5 |
the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115 |
695 | 6 |
|
1169 | 7 |
= List of visual gear types = |
1175 | 8 |
== Environment == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
9 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
10 |
|| `vgtFlake` || Theme flake || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
11 |
|| `vgtChunk` || Theme chunk (spawns when blowing up land) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
12 |
|| `vgtCloud` || Cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
13 |
|| `vgtDust` || Dust cloud (e.g. of mudball) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
14 |
|| `vgtSplash` || Water splash || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
15 |
|| `vgtDroplet` || Water droplet || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
16 |
|| `vgtBubble` || Underwater bubble || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
17 |
|| `vgtSteam` || Steam cloud (when fire hits water) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
18 |
|| `vgtFire` || Small decorative/harmless flame || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
19 |
|| `vgtSmoke` || Gray smoke cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
20 |
|| `vgtSmokeWhite` || White smoke cloud || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
21 |
|
1169 | 22 |
== Explosion == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
23 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
24 |
|| `vgtExplosion` || Small explosion (complete animation) || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
25 |
|| `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
|
26 |
|| `vgtExplPart` || Small explosion particle, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
27 |
|| `vgtExplPart2` || Another small explosion particle, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
28 |
|| `vgtSmokeRing` || Smoke ring, part of explosion animation || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
29 |
|
1169 | 30 |
== Weapons and projectiles == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
31 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
32 |
|| `vgtNote` || Piano note || |
1163 | 33 |
|| `vgtBeeTrace` || Random colored flower (bee particle) || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
34 |
|| `vgtEgg` || Broken egg shell particle || |
1163 | 35 |
|| `vgtFeather` || Birdy's feather || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
36 |
|| `vgtSmokeTrace` || Strange smoke-like cloud from mortar || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
37 |
|| `vgtEvilTrace` || Strange red cloud from hellish hand-grenade || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
38 |
|| `vgtShell` || Bullet shell || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
39 |
|| `vgtBulletHit` || Bullet impact animation || |
1178 | 40 |
|| `vgtLineTrail` || Straight shot line from e.g. desert eagle and the likes || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
41 |
|
1169 | 42 |
== HUD == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
43 |
|| *Variable name* || *Short description* || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
44 |
|| `vgtCircle` || Simple circle. Highly configurable! || |
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
45 |
|| `vgtNoPlaceWarn` || Overlay when the placement of something failed || |
1166 | 46 |
|| `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
|
47 |
|| `vgtSmoothWindBar` || Changes the wind bar smoothly || |
1255 | 48 |
|| `vgtTeamHealthSorter` || When added, updates the sorting of the team health bars || |
1171 | 49 |
|| `vgtHealthTag` || Hedgehog health tag || |
50 |
|| `vgtSmallDamageTag` || Small damage tag after hog damage. || |
|
2065 | 51 |
|| `vgtSpeechBubble` || Speech bubble with text. || |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
52 |
|
1169 | 53 |
== Misc. == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
54 |
|| *Variable name* || *Short description* || |
1181 | 55 |
|| `vgtStraightShot` || Moving sprite || |
1167 | 56 |
|
1169 | 57 |
= Detailed visual gear reference = |
1168 | 58 |
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. |
59 |
||
2061 | 60 |
If not specified otherwise, the visual gear values have the meaning as defined in `SetVisualGearValues` (See [LuaGears]). |
61 |
||
1168 | 62 |
This section is still under construction! |
1167 | 63 |
|
1171 | 64 |
== `vgtCircle` == |
1187 | 65 |
A simple circle which doesn't move. It is one of the few visual gears which is not removed automatically. It can be drawn in 2 different styles. With `dX`, `dY` and `FrameTicks`, you can set the circle to pulsate in opacity. |
1167 | 66 |
|
1186 | 67 |
|
1168 | 68 |
* `dX`: Minimum opacity (0-255) |
69 |
* `dY`: Maximum opacity (0-255) |
|
2066 | 70 |
* `Angle`: Circle style. 1 = Radial gradient (`sprVampiric` sprite). 0 = Simple circular line |
1187 | 71 |
* `FrameTicks`: Period length of opacity change. Set to `0` to disable. |
1186 | 72 |
* `State`: Radius |
73 |
* `Timer`: Line thickness (only if `Angle` does not equal `1`) |
|
1167 | 74 |
|
1171 | 75 |
== `vgtAmmo` == |
1167 | 76 |
Displays an ammo icon. |
77 |
||
1182 | 78 |
* `Frame`: !AmmoType ID of ammo to display (see [AmmoTypes]) |
1171 | 79 |
|
1172 | 80 |
== `vgtHealthTag` == |
2206
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
81 |
A health/damage tag for hedgehogs. It shows a whole number surrounded by a simple border. `dX` and `dY` can be used for moving it around. |
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
82 |
|
2208 | 83 |
This is shown at the end of a turn to show the total damage received by each hedgehog in that turn, or when a hedgehog drowned. |
2206
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
84 |
But this visual gear is also very useful to show an arbitrary whole number on the screen. |
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
85 |
|
2214 | 86 |
By default, it is white and moves upwards a few pixels before it disappears. Set `dX` and `dY` to 0 to disable movement. If this visual gear was spawned below the water line (`Y>WaterLine`), it will disappear as soon `Y-10<WaterLine` is `true` and `Timer` is ignored. |
1172 | 87 |
|
2213
bed46cba92ef
VisualGearTypes: `Angle` only effectful if `Frame` is non-zero (HealthTag)
Wuzzy
parents:
2212
diff
changeset
|
88 |
* `Angle`: Scale ratio (only has an effect if `Frame` is non-zero). `0` or `1` = 100% |
1913 | 89 |
* `Frame`: If `0`, its position is relative to the landscape. If non-zero, it will align to the screen instead |
2216 | 90 |
* `State`: Number to display (must be a whole number). NOTE: Can only be set in the same tick in which it was spawned, not later |
2214 | 91 |
* `Timer`: Expiration timer (not used if spawned below water line (`Y>WaterLine`)) |
2206
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
92 |
* `Tint`: Color of number and border |
2213
bed46cba92ef
VisualGearTypes: `Angle` only effectful if `Frame` is non-zero (HealthTag)
Wuzzy
parents:
2212
diff
changeset
|
93 |
* `Scale`: Unused. Use `Angle` for scaling instead |
1172 | 94 |
|
1417 | 95 |
== `vgtSmallDamageTag` == |
2205 | 96 |
NOTE: Due to a bug, this cannot currently be used in Lua scripts. |
97 |
||
2206
4bf9ae7d9739
VisualGearTypes: Improve Health/damage tag documentation
Wuzzy
parents:
2205
diff
changeset
|
98 |
Damage indicator, displays a damage value. Hedgewars uses this as the "small" damage tag used to instantly show damage of a single hit. |
1417 | 99 |
|
2212 | 100 |
Looks and behaves similar to `vgtHealthTag`, but is slightly smaller. |
101 |
||
1171 | 102 |
== `vgtSpeechBubble` == |
2065 | 103 |
Displays a speech bubble with text. In Lua, you cannot change the text after this has been created. Use `HogSay` in Lua to spawn a speech bobble properly. |
1171 | 104 |
|
1530 | 105 |
* `Frame`: ID of the gear to which the speech bubble belongs |
1173 | 106 |
* `FrameTicks`: Speech bubble type (`SAY_SAY`, `SAY_THINK` or `SAY_SHOUT`) |
2065 | 107 |
* (Text is stored internally that cannot be accessed by Lua) |
1173 | 108 |
|
109 |
== `vgtStraightShot` == |
|
2064 | 110 |
Displays an arbitrary sprite which moves in a random direction (can be overwritten in `dX` and `dY`) and fades out after a short time. |
1173 | 111 |
|
2060 | 112 |
* `State`: ID of the custom sprite (use an ID from [Sprites]) (default: `sprSnowDust`) |
113 |
* `Frame`: Frame of custom sprite (default: 0) |
|
2068 | 114 |
* `FrameTicks`: Life time in milliseconds (default: random between 750 and 2000) |
1178 | 115 |
|
116 |
== `vgtLineTrail` == |
|
2217 | 117 |
A straight thin yellowish line between two points which fades out after some time. As if a bullet has been fired. A `vgtLineTrail` has a start and an end point. The default `Timer` is too low so you must set it manually |
1178 | 118 |
|
119 |
* `X`, `Y`: Start point of line |
|
120 |
* `dX`, `dY`: End point of line |
|
2067 | 121 |
* `Timer`: Life time (default: 0) |
2077
514babfbad9e
Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents:
2069
diff
changeset
|
122 |
* `Tint`: Opacity (0-255). The color itself can't be changed |