VisualGearTypes.wiki
changeset 1167 0fef28e4ee0d
parent 1166 23e6891cd2c0
child 1168 032b2771c757
equal deleted inserted replaced
1166:23e6891cd2c0 1167:0fef28e4ee0d
     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 
       
    58 == Detailed visual gear reference ==
       
    59 Here you will find more detailed attribute references for the visual gears. This section is still under construction!
       
    60 
       
    61 == `vgtCircle` ==
       
    62 A simple circle. If you set `dX`, `dY` and `FrameTicks`, the circle pulsates in opacity.
       
    63 
       
    64 * `dX`: Minimum opacity (0-255)
       
    65 * `dY`: Maximum opacity (0-255)
       
    66 * `FrameTicks`: ???
       
    67 * `State`: Radius
       
    68 * `Timer`: Thickness
       
    69 
       
    70 == `vgtAmmo` ==
       
    71 Displays an ammo icon.
       
    72 
       
    73 * `State`: [AmmoType] ID of ammo to display