VisualGearTypes: Add short description for most visual gear types
authorWuzzy
Fri, 09 Feb 2018 20:42:03 +0000
changeset 1162 f42906890b68
parent 1161 5724b3037d0f
child 1163 1893051766fe
VisualGearTypes: Add short description for most visual gear types
VisualGearTypes.wiki
--- a/VisualGearTypes.wiki	Fri Feb 09 03:45:53 2018 +0000
+++ b/VisualGearTypes.wiki	Fri Feb 09 20:42:03 2018 +0000
@@ -6,38 +6,51 @@
 the `TVisualGearType` enumeration: https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l112
 
 = List of visual gear types =
-|| *Variable name* ||
-|| `vgtFlake` ||
-|| `vgtCloud` ||
-|| `vgtExplPart` ||
-|| `vgtExplPart2` ||
-|| `vgtFire` ||
-|| `vgtSmallDamageTag` ||
-|| `vgtTeamHealthSorter` ||
-|| `vgtSpeechBubble` ||
-|| `vgtBubble` ||
-|| `vgtSteam` ||
-|| `vgtAmmo` ||
-|| `vgtSmoke` ||
-|| `vgtSmokeWhite` ||
-|| `vgtShell` ||
-|| `vgtDust` ||
-|| `vgtSplash` ||
-|| `vgtDroplet` ||
-|| `vgtSmokeRing` ||
-|| `vgtBeeTrace` ||
-|| `vgtEgg` ||
-|| `vgtFeather` ||
-|| `vgtHealthTag` ||
-|| `vgtSmokeTrace` ||
-|| `vgtEvilTrace` ||
-|| `vgtExplosion` ||
-|| `vgtBigExplosion` ||
-|| `vgtChunk` ||
-|| `vgtNote` ||
-|| `vgtLineTrail` ||
-|| `vgtBulletHit` ||
-|| `vgtCircle` ||
-|| `vgtSmoothWindBar` ||
-|| `vgtStraightShot` ||
-|| `vgtNoPlaceWarn` ||
\ No newline at end of file
+== 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` || Particles from bee, random colored flower ||
+|| `vgtEgg` || Broken egg shell particle ||
+|| `vgtFeather` || Birdy 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 || 
+
+== 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 ||
+|| `vgtSmoothWindBar` || Changes the wind bar smoothly ||
+|| `vgtAmmo` || Ammo icon display. Appears when collecting a crate ||
+|| `vgtHealthTag` || ??? ||
+|| `vgtTeamHealthSorter` || ??? ||
+|| `vgtSpeechBubble` || ??? ||
+
+== Misc. ==
+|| *Variable name* || *Short description* ||
+|| `vgtLineTrail` || ??? ||