author | Wuzzy |
Mon, 20 May 2019 19:57:32 +0100 | |
changeset 1895 | 93f8269fca27 |
parent 1530 | 288bee4b94d5 |
child 1913 | db5fab5b31da |
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 |
|
1169 | 8 |
= List of visual gear types = |
1175 | 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 |
|
1169 | 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 |
|
1169 | 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 || |
1178 | 41 |
|| `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
|
42 |
|
1169 | 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 |
|| `vgtNoPlaceWarn` || Overlay when the placement of something failed || |
1166 | 47 |
|| `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
|
48 |
|| `vgtSmoothWindBar` || Changes the wind bar smoothly || |
1255 | 49 |
|| `vgtTeamHealthSorter` || When added, updates the sorting of the team health bars || |
1171 | 50 |
|| `vgtHealthTag` || Hedgehog health tag || |
51 |
|| `vgtSmallDamageTag` || Small damage tag after hog damage. || |
|
52 |
|| `vgtSpeechBubble` || Speech bubble with text. Does not work in Lua. || |
|
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
53 |
|
1169 | 54 |
== Misc. == |
1162
f42906890b68
VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents:
798
diff
changeset
|
55 |
|| *Variable name* || *Short description* || |
1181 | 56 |
|| `vgtStraightShot` || Moving sprite || |
1167 | 57 |
|
1169 | 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 |
|
1171 | 63 |
== `vgtCircle` == |
1187 | 64 |
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 | 65 |
|
1186 | 66 |
|
1168 | 67 |
* `dX`: Minimum opacity (0-255) |
68 |
* `dY`: Maximum opacity (0-255) |
|
1185 | 69 |
* `Angle`: Circle style. 1 = Radial gradient (`sprVampiric` sprite). Everything else = Simple line |
1187 | 70 |
* `FrameTicks`: Period length of opacity change. Set to `0` to disable. |
1186 | 71 |
* `State`: Radius |
72 |
* `Timer`: Line thickness (only if `Angle` does not equal `1`) |
|
1167 | 73 |
|
1171 | 74 |
== `vgtAmmo` == |
1167 | 75 |
Displays an ammo icon. |
76 |
||
1182 | 77 |
* `Frame`: !AmmoType ID of ammo to display (see [AmmoTypes]) |
1171 | 78 |
|
1172 | 79 |
== `vgtHealthTag` == |
80 |
A health tag for hedgehogs. But with a few changes, this is also useful to display arbitray numbers on the screen. |
|
81 |
||
82 |
* `Angle`: Scale ratio. `1` = 100% |
|
83 |
* `Frame`: If `0`, it is part of the landscape. If non-zero, it will align to the screen instead |
|
1186 | 84 |
* `State`: Number to display |
1172 | 85 |
* `Timer`: Expiration timer |
86 |
||
1417 | 87 |
== `vgtSmallDamageTag` == |
88 |
Damage indicator, displays a damage value. Looks similar to `vgtHealthTag`, but is smaller. |
|
89 |
||
1171 | 90 |
== `vgtSpeechBubble` == |
91 |
Displays a speech bubble. Use `HogSay` to spawn speech bubbles. |
|
92 |
||
1530 | 93 |
* `Frame`: ID of the gear to which the speech bubble belongs |
1173 | 94 |
* `FrameTicks`: Speech bubble type (`SAY_SAY`, `SAY_THINK` or `SAY_SHOUT`) |
95 |
||
96 |
== `vgtStraightShot` == |
|
97 |
Displays an arbitrary sprite which moves. A straight shot from a firearm like the Desert Eagle. The sprite it uses can be changed, so this can be used to display nearly every sprite. |
|
98 |
||
1174 | 99 |
* `State`: ID of the custom sprite (use an ID from `Sprites`) |
1178 | 100 |
* `FrameTicks`: ??? |
101 |
||
102 |
== `vgtLineTrail` == |
|
103 |
A straight line between two points which briefly fades out. 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 |
|
104 |
||
105 |
* `X`, `Y`: Start point of line |
|
106 |
* `dX`, `dY`: End point of line |
|
107 |
* `Timer`: Life time |