VisualGearTypes.wiki
author Wuzzy
Sat, 07 Dec 2019 11:23:22 +0000
changeset 2123 7df4304efaef
parent 2077 514babfbad9e
permissions -rw-r--r--
LuaGears: Explain heResurrected better
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
431
ccd3a6afa564 Add summary
almikes@aol.com
parents: 351
diff changeset
     1
#summary List of all visual gear types
ccd3a6afa564 Add summary
almikes@aol.com
parents: 351
diff changeset
     2
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2069
diff changeset
     3
This is a list of available visual gear types.
697
855ce0af8245 Add slightly more description
Wuzzy
parents: 696
diff changeset
     4
855ce0af8245 Add slightly more description
Wuzzy
parents: 696
diff changeset
     5
For a current list of the visual gear types look at `hedgewars/uTypes.pas` at
1163
1893051766fe VisualGearTypes: More text
Wuzzy
parents: 1162
diff changeset
     6
the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115
695
ab2e242986c3 Put everything into a nice table
Wuzzy
parents: 651
diff changeset
     7
1169
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
     8
= List of visual gear types =
1175
09d5758cc4e5 VisualGearTypes: another typo
Wuzzy
parents: 1174
diff changeset
     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
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
    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
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
    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
1893051766fe VisualGearTypes: More text
Wuzzy
parents: 1162
diff changeset
    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
1893051766fe VisualGearTypes: More text
Wuzzy
parents: 1162
diff changeset
    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
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
    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
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
    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
23e6891cd2c0 VisualGearTypes: more typo fixes
Wuzzy
parents: 1164
diff changeset
    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
64a6028803d4 VisualGearTypes: Fix vgtTeamHealthSorter
Wuzzy
parents: 1187
diff changeset
    49
|| `vgtTeamHealthSorter` || When added, updates the sorting of the team health bars ||
1171
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    50
|| `vgtHealthTag` || Hedgehog health tag ||
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    51
|| `vgtSmallDamageTag` || Small damage tag after hog damage. ||
2065
5d8cecc058bf VisualGearTypes: Update SpeechBubble
Wuzzy
parents: 2064
diff changeset
    52
|| `vgtSpeechBubble` || Speech bubble with text. ||
1162
f42906890b68 VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents: 798
diff changeset
    53
1169
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
    54
== Misc. ==
1162
f42906890b68 VisualGearTypes: Add short description for most visual gear types
Wuzzy
parents: 798
diff changeset
    55
|| *Variable name* || *Short description* ||
1181
1a54b7c00b23 VisualGearTypes: moving sprite
Wuzzy
parents: 1180
diff changeset
    56
|| `vgtStraightShot` || Moving sprite || 
1167
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    57
1169
f36679317ec0 VisualGearTypes: Fix captions
Wuzzy
parents: 1168
diff changeset
    58
= Detailed visual gear reference =
1168
032b2771c757 VisualGearTypes: Add vgtCircle and vgtAmmo
Wuzzy
parents: 1167
diff changeset
    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.
032b2771c757 VisualGearTypes: Add vgtCircle and vgtAmmo
Wuzzy
parents: 1167
diff changeset
    60
2061
893f86b6138b VisualGearTypes: Clarify default gear values
Wuzzy
parents: 2060
diff changeset
    61
If not specified otherwise, the visual gear values have the meaning as defined in `SetVisualGearValues` (See [LuaGears]).
893f86b6138b VisualGearTypes: Clarify default gear values
Wuzzy
parents: 2060
diff changeset
    62
1168
032b2771c757 VisualGearTypes: Add vgtCircle and vgtAmmo
Wuzzy
parents: 1167
diff changeset
    63
This section is still under construction!
1167
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    64
1171
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    65
== `vgtCircle` ==
1187
70628fea6065 VisualGearTypes: detail vgtCircle
Wuzzy
parents: 1186
diff changeset
    66
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
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    67
1186
883d411ac1bd VisualGearTypes: resort
Wuzzy
parents: 1185
diff changeset
    68
1168
032b2771c757 VisualGearTypes: Add vgtCircle and vgtAmmo
Wuzzy
parents: 1167
diff changeset
    69
 * `dX`: Minimum opacity (0-255)
032b2771c757 VisualGearTypes: Add vgtCircle and vgtAmmo
Wuzzy
parents: 1167
diff changeset
    70
 * `dY`: Maximum opacity (0-255)
2066
c82278e86aa5 VisualGearTypes: Use 0 for circular line
Wuzzy
parents: 2065
diff changeset
    71
 * `Angle`: Circle style. 1 = Radial gradient (`sprVampiric` sprite). 0 = Simple circular line
1187
70628fea6065 VisualGearTypes: detail vgtCircle
Wuzzy
parents: 1186
diff changeset
    72
 * `FrameTicks`: Period length of opacity change. Set to `0` to disable.
1186
883d411ac1bd VisualGearTypes: resort
Wuzzy
parents: 1185
diff changeset
    73
 * `State`: Radius
883d411ac1bd VisualGearTypes: resort
Wuzzy
parents: 1185
diff changeset
    74
 * `Timer`: Line thickness (only if `Angle` does not equal `1`)
1167
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    75
1171
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    76
== `vgtAmmo` ==
1167
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    77
Displays an ammo icon.
0fef28e4ee0d VisualGearTypes: add vgtCircle and vgtAmmo
Wuzzy
parents: 1166
diff changeset
    78
1182
4c72f5881fa4 VisualGearTypes: link ammotype
Wuzzy
parents: 1181
diff changeset
    79
 * `Frame`: !AmmoType ID of ammo to display (see [AmmoTypes])
1171
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    80
1172
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    81
== `vgtHealthTag` ==
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    82
A health tag for hedgehogs. But with a few changes, this is also useful to display arbitray numbers on the screen.
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    83
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    84
 * `Angle`: Scale ratio. `1` = 100%
1913
db5fab5b31da VisualGearTypes: Clarify vgtHealthTag's Frame
Wuzzy
parents: 1530
diff changeset
    85
 * `Frame`: If `0`, its position is relative to the landscape. If non-zero, it will align to the screen instead
1186
883d411ac1bd VisualGearTypes: resort
Wuzzy
parents: 1185
diff changeset
    86
 * `State`: Number to display
1172
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    87
 * `Timer`: Expiration timer
929d65ba07e6 VisualGearTypes: fix syntax
Wuzzy
parents: 1171
diff changeset
    88
1417
969b75121c88 VisualGearTypes: vgtSmallDamageTag stub
Wuzzy
parents: 1255
diff changeset
    89
== `vgtSmallDamageTag` ==
969b75121c88 VisualGearTypes: vgtSmallDamageTag stub
Wuzzy
parents: 1255
diff changeset
    90
Damage indicator, displays a damage value. Looks similar to `vgtHealthTag`, but is smaller.
969b75121c88 VisualGearTypes: vgtSmallDamageTag stub
Wuzzy
parents: 1255
diff changeset
    91
2065
5d8cecc058bf VisualGearTypes: Update SpeechBubble
Wuzzy
parents: 2064
diff changeset
    92
The parameters are the saem as for `vgtHealthTag`.
5d8cecc058bf VisualGearTypes: Update SpeechBubble
Wuzzy
parents: 2064
diff changeset
    93
1171
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    94
== `vgtSpeechBubble` ==
2065
5d8cecc058bf VisualGearTypes: Update SpeechBubble
Wuzzy
parents: 2064
diff changeset
    95
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
211e1f8ec3cb VisualGearTypes: Add vgtHealthTag
Wuzzy
parents: 1170
diff changeset
    96
1530
288bee4b94d5 VisualGearTypes: Add Frame to vgtSpeechBubble
Wuzzy
parents: 1418
diff changeset
    97
 * `Frame`: ID of the gear to which the speech bubble belongs
1173
bb717cb60483 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1172
diff changeset
    98
 * `FrameTicks`: Speech bubble type (`SAY_SAY`, `SAY_THINK` or `SAY_SHOUT`)
2065
5d8cecc058bf VisualGearTypes: Update SpeechBubble
Wuzzy
parents: 2064
diff changeset
    99
 * (Text is stored internally that cannot be accessed by Lua)
1173
bb717cb60483 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1172
diff changeset
   100
bb717cb60483 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1172
diff changeset
   101
== `vgtStraightShot` ==
2064
61552dc89169 VisualGearTypes: remove blabla
Wuzzy
parents: 2061
diff changeset
   102
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
bb717cb60483 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1172
diff changeset
   103
2060
55ea190450ec VisualGearTypes: Update vgtStraightShot
Wuzzy
parents: 1913
diff changeset
   104
 * `State`: ID of the custom sprite (use an ID from [Sprites]) (default: `sprSnowDust`)
55ea190450ec VisualGearTypes: Update vgtStraightShot
Wuzzy
parents: 1913
diff changeset
   105
 * `Frame`: Frame of custom sprite (default: 0)
2068
b519bdd96f11 VisualGearTypes: fix default vgtStraightShot timer
Wuzzy
parents: 2067
diff changeset
   106
 * `FrameTicks`: Life time in milliseconds (default: random between 750 and 2000)
1178
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
   107
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
   108
== `vgtLineTrail` ==
2067
ab22c7756ad0 VisualGearTypes: Add Tint for vgtLineTrail
Wuzzy
parents: 2066
diff changeset
   109
A straight line between two points which fades out after some time, has a slight yellowish color. 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
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
   110
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
   111
 * `X`, `Y`: Start point of line
58ef0e44ea88 VisualGearTypes: vgtStraightShot
Wuzzy
parents: 1177
diff changeset
   112
 * `dX`, `dY`: End point of line
2067
ab22c7756ad0 VisualGearTypes: Add Tint for vgtLineTrail
Wuzzy
parents: 2066
diff changeset
   113
 * `Timer`: Life time (default: 0)
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2069
diff changeset
   114
 * `Tint`: Opacity (0-255). The color itself can't be changed