VisualGearTypes.wiki
changeset 1169 f36679317ec0
parent 1168 032b2771c757
child 1170 7d2d66c50ad5
equal deleted inserted replaced
1168:032b2771c757 1169:f36679317ec0
     3 This is a list of available visual gear types, as of 0.9.23.
     3 This is a list of available visual gear types, as of 0.9.23.
     4 
     4 
     5 For a current list of the visual gear types look at `hedgewars/uTypes.pas` at
     5 For a current list of the visual gear types look at `hedgewars/uTypes.pas` at
     6 the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115
     6 the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115
     7 
     7 
     8 == List of visual gear types ==
     8 = List of visual gear types =
     9 === Environment ===
     9 == Environment ===
    10 || *Variable name* || *Short description* ||
    10 || *Variable name* || *Short description* ||
    11 || `vgtFlake` || Theme flake ||
    11 || `vgtFlake` || Theme flake ||
    12 || `vgtChunk` || Theme chunk (spawns when blowing up land) ||
    12 || `vgtChunk` || Theme chunk (spawns when blowing up land) ||
    13 || `vgtCloud` || Cloud ||
    13 || `vgtCloud` || Cloud ||
    14 || `vgtDust` || Dust cloud (e.g. of mudball) ||
    14 || `vgtDust` || Dust cloud (e.g. of mudball) ||
    18 || `vgtSteam` || Steam cloud (when fire hits water) ||
    18 || `vgtSteam` || Steam cloud (when fire hits water) ||
    19 || `vgtFire` || Small decorative/harmless flame ||
    19 || `vgtFire` || Small decorative/harmless flame ||
    20 || `vgtSmoke` || Gray smoke cloud ||
    20 || `vgtSmoke` || Gray smoke cloud ||
    21 || `vgtSmokeWhite` || White smoke cloud ||
    21 || `vgtSmokeWhite` || White smoke cloud ||
    22 
    22 
    23 === Explosion  ===
    23 == Explosion  ==
    24 || *Variable name* || *Short description* ||
    24 || *Variable name* || *Short description* ||
    25 || `vgtExplosion` || Small explosion (complete animation) ||
    25 || `vgtExplosion` || Small explosion (complete animation) ||
    26 || `vgtBigExplosion` || Big explosion (complete animation which also makes screen shake) ||
    26 || `vgtBigExplosion` || Big explosion (complete animation which also makes screen shake) ||
    27 || `vgtExplPart` || Small explosion particle, part of explosion animation ||
    27 || `vgtExplPart` || Small explosion particle, part of explosion animation ||
    28 || `vgtExplPart2` || Another small explosion particle, part of explosion animation ||
    28 || `vgtExplPart2` || Another small explosion particle, part of explosion animation ||
    29 || `vgtSmokeRing` || Smoke ring, part of explosion animation ||
    29 || `vgtSmokeRing` || Smoke ring, part of explosion animation ||
    30 
    30 
    31 === Weapons and projectiles ===
    31 == Weapons and projectiles ==
    32 || *Variable name* || *Short description* ||
    32 || *Variable name* || *Short description* ||
    33 || `vgtNote` || Piano note ||
    33 || `vgtNote` || Piano note ||
    34 || `vgtBeeTrace` || Random colored flower (bee particle) ||
    34 || `vgtBeeTrace` || Random colored flower (bee particle) ||
    35 || `vgtEgg` || Broken egg shell particle ||
    35 || `vgtEgg` || Broken egg shell particle ||
    36 || `vgtFeather` || Birdy's feather ||
    36 || `vgtFeather` || Birdy's feather ||
    38 || `vgtEvilTrace` || Strange red cloud from hellish hand-grenade ||
    38 || `vgtEvilTrace` || Strange red cloud from hellish hand-grenade ||
    39 || `vgtShell` || Bullet shell ||
    39 || `vgtShell` || Bullet shell ||
    40 || `vgtBulletHit` || Bullet impact animation ||
    40 || `vgtBulletHit` || Bullet impact animation ||
    41 || `vgtStraightShot` || Shot line from firearms like Desert Eagle. Also used to render arbitrary sprites like the “+” particles for gaining health || 
    41 || `vgtStraightShot` || Shot line from firearms like Desert Eagle. Also used to render arbitrary sprites like the “+” particles for gaining health || 
    42 
    42 
    43 === HUD ===
    43 == HUD ==
    44 || *Variable name* || *Short description* ||
    44 || *Variable name* || *Short description* ||
    45 || `vgtCircle` || Simple circle. Highly configurable! ||
    45 || `vgtCircle` || Simple circle. Highly configurable! ||
    46 || `vgtSmallDamageTag` || Small damage tag after hog damage. Useful to display a number in the game ||
    46 || `vgtSmallDamageTag` || Small damage tag after hog damage. Useful to display a number in the game ||
    47 || `vgtNoPlaceWarn` || Overlay when the placement of something failed ||
    47 || `vgtNoPlaceWarn` || Overlay when the placement of something failed ||
    48 || `vgtAmmo` || Briefly displays an ammo icon. Appears when collecting a crate ||
    48 || `vgtAmmo` || Briefly displays an ammo icon. Appears when collecting a crate ||
    49 || `vgtSmoothWindBar` || Changes the wind bar smoothly ||
    49 || `vgtSmoothWindBar` || Changes the wind bar smoothly ||
    50 || `vgtHealthTag` || ??? ||
    50 || `vgtHealthTag` || ??? ||
    51 || `vgtTeamHealthSorter` || ??? ||
    51 || `vgtTeamHealthSorter` || ??? ||
    52 || `vgtSpeechBubble` || ??? ||
    52 || `vgtSpeechBubble` || ??? ||
    53 
    53 
    54 === Misc. ===
    54 == Misc. ==
    55 || *Variable name* || *Short description* ||
    55 || *Variable name* || *Short description* ||
    56 || `vgtLineTrail` || ??? ||
    56 || `vgtLineTrail` || ??? ||
    57 
    57 
    58 == Detailed visual gear reference ==
    58 = Detailed visual gear reference =
    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.
    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 
    60 
    61 This section is still under construction!
    61 This section is still under construction!
    62 
    62 
    63 == `vgtCircle` ==
    63 = `vgtCircle` =
    64 A simple circle. If you set `dX`, `dY` and `FrameTicks`, the circle pulsates in opacity.
    64 A simple circle. It is one of the few visual gears which is not removed automatically. If you set `dX`, `dY` and `FrameTicks`, the circle pulsates in opacity.
    65 
    65 
    66  * `dX`: Minimum opacity (0-255)
    66  * `dX`: Minimum opacity (0-255)
    67  * `dY`: Maximum opacity (0-255)
    67  * `dY`: Maximum opacity (0-255)
    68  * `FrameTicks`: ???
    68  * `FrameTicks`: ???
    69  * `State`: Radius
    69  * `State`: Radius
    70  * `Timer`: Thickness
    70  * `Timer`: Thickness
    71 
    71 
    72 == `vgtAmmo` ==
    72 = `vgtAmmo` =
    73 Displays an ammo icon.
    73 Displays an ammo icon.
    74 
    74 
    75  * `State`: [AmmoType] ID of ammo to display
    75  * `State`: [AmmoType] ID of ammo to display