VisualGearTypes.wiki
author Wuzzy
Fri, 09 Feb 2018 21:07:20 +0000
changeset 1169 f36679317ec0
parent 1168 032b2771c757
child 1170 7d2d66c50ad5
permissions -rw-r--r--
VisualGearTypes: Fix captions

#summary List of all visual gear types

This is a list of available visual gear types, as of 0.9.23.

For a current list of the visual gear types look at `hedgewars/uTypes.pas` at
the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l115

= List of visual gear types =
== Environment ===
|| *Variable name* || *Short description* ||
|| `vgtFlake` || Theme flake ||
|| `vgtChunk` || Theme chunk (spawns when blowing up land) ||
|| `vgtCloud` || Cloud ||
|| `vgtDust` || Dust cloud (e.g. of mudball) ||
|| `vgtSplash` || Water splash ||
|| `vgtDroplet` || Water droplet ||
|| `vgtBubble` || Underwater bubble ||
|| `vgtSteam` || Steam cloud (when fire hits water) ||
|| `vgtFire` || Small decorative/harmless flame ||
|| `vgtSmoke` || Gray smoke cloud ||
|| `vgtSmokeWhite` || White smoke cloud ||

== Explosion  ==
|| *Variable name* || *Short description* ||
|| `vgtExplosion` || Small explosion (complete animation) ||
|| `vgtBigExplosion` || Big explosion (complete animation which also makes screen shake) ||
|| `vgtExplPart` || Small explosion particle, part of explosion animation ||
|| `vgtExplPart2` || Another small explosion particle, part of explosion animation ||
|| `vgtSmokeRing` || Smoke ring, part of explosion animation ||

== Weapons and projectiles ==
|| *Variable name* || *Short description* ||
|| `vgtNote` || Piano note ||
|| `vgtBeeTrace` || Random colored flower (bee particle) ||
|| `vgtEgg` || Broken egg shell particle ||
|| `vgtFeather` || Birdy's feather ||
|| `vgtSmokeTrace` || Strange smoke-like cloud from mortar ||
|| `vgtEvilTrace` || Strange red cloud from hellish hand-grenade ||
|| `vgtShell` || Bullet shell ||
|| `vgtBulletHit` || Bullet impact animation ||
|| `vgtStraightShot` || Shot line from firearms like Desert Eagle. Also used to render arbitrary sprites like the “+” particles for gaining health || 

== HUD ==
|| *Variable name* || *Short description* ||
|| `vgtCircle` || Simple circle. Highly configurable! ||
|| `vgtSmallDamageTag` || Small damage tag after hog damage. Useful to display a number in the game ||
|| `vgtNoPlaceWarn` || Overlay when the placement of something failed ||
|| `vgtAmmo` || Briefly displays an ammo icon. Appears when collecting a crate ||
|| `vgtSmoothWindBar` || Changes the wind bar smoothly ||
|| `vgtHealthTag` || ??? ||
|| `vgtTeamHealthSorter` || ??? ||
|| `vgtSpeechBubble` || ??? ||

== Misc. ==
|| *Variable name* || *Short description* ||
|| `vgtLineTrail` || ??? ||

= Detailed visual gear reference =
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.

This section is still under construction!

= `vgtCircle` =
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.

 * `dX`: Minimum opacity (0-255)
 * `dY`: Maximum opacity (0-255)
 * `FrameTicks`: ???
 * `State`: Radius
 * `Timer`: Thickness

= `vgtAmmo` =
Displays an ammo icon.

 * `State`: [AmmoType] ID of ammo to display