--- a/VisualGearTypes.wiki Fri Feb 09 20:53:02 2018 +0000
+++ b/VisualGearTypes.wiki Fri Feb 09 21:03:46 2018 +0000
@@ -5,8 +5,8 @@
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 ==
+== List of visual gear types ==
+=== Environment ===
|| *Variable name* || *Short description* ||
|| `vgtFlake` || Theme flake ||
|| `vgtChunk` || Theme chunk (spawns when blowing up land) ||
@@ -20,7 +20,7 @@
|| `vgtSmoke` || Gray smoke cloud ||
|| `vgtSmokeWhite` || White smoke cloud ||
-== Explosion ==
+=== Explosion ===
|| *Variable name* || *Short description* ||
|| `vgtExplosion` || Small explosion (complete animation) ||
|| `vgtBigExplosion` || Big explosion (complete animation which also makes screen shake) ||
@@ -28,7 +28,7 @@
|| `vgtExplPart2` || Another small explosion particle, part of explosion animation ||
|| `vgtSmokeRing` || Smoke ring, part of explosion animation ||
-== Weapons and projectiles ==
+=== Weapons and projectiles ===
|| *Variable name* || *Short description* ||
|| `vgtNote` || Piano note ||
|| `vgtBeeTrace` || Random colored flower (bee particle) ||
@@ -40,7 +40,7 @@
|| `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 ==
+=== 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 ||
@@ -51,6 +51,23 @@
|| `vgtTeamHealthSorter` || ??? ||
|| `vgtSpeechBubble` || ??? ||
-== Misc. ==
+=== Misc. ===
|| *Variable name* || *Short description* ||
|| `vgtLineTrail` || ??? ||
+
+== Detailed visual gear reference ==
+Here you will find more detailed attribute references for the visual gears. This section is still under construction!
+
+== `vgtCircle` ==
+A simple circle. 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
\ No newline at end of file