# HG changeset patch
# User Wuzzy
# Date 1457491506 0
# Node ID c4b171741ee3b9ffe0acee8a3a751ea3f2912e81
# Parent  0fba851eb618b0005a57bde8a7dca7e27623970a
States: Add documentation for most gear states

diff -r 0fba851eb618 -r c4b171741ee3 States.wiki
--- a/States.wiki	Wed Mar 09 01:27:00 2016 +0000
+++ b/States.wiki	Wed Mar 09 02:45:06 2016 +0000
@@ -5,28 +5,28 @@
 = List of states =
 
 || *Gear state* || *Description* ||
-|| `gstDrowning` || Gear is drowning ||
 || `gstHHDriven` || Hedgehog is controlled by current player ||
+|| `gstHHChooseTarget` || Used for hedgehogs; if set, player can select a target with the cursor (e.g. for homing bee, air attack, etc.) ||
+|| `gstHHJumping` || Used to indicate when a hedgehog is doing the long jump ||
+|| `gstHHHJump` || Used to indicate when a hedgehog is doing the high jump ||
+|| `gstHHThinking` || Thought bubble animation plays for hedgehog (used for AI players) ||
+|| `gstHHDeath` || Hedgehog is dying ||
+|| `gstHHGone` || Set if hedgehog is going to teleport away from the battlefield because the player left the game (in network play) ||
+|| `gstWinner` || This is good for indicating hedgehogs they did well. Represented by a stupid grin. ||
+|| `gstLoser` || This is good for indicating hedgehogs screwed up ||
 || `gstMoving` || Gear is moving / in mid-air ||
-|| `gstAttacked` || ||
-|| `gstAttacking` || ||
-|| `gstCollision` || ||
-|| `gstHHChooseTarget` || ||
-|| `gstHHJumping` || ||
-|| `gsttmpFlag` || ||
-|| `gstHHThinking` || ||
-|| `gstNoDamage` || Hedgehog is invulnerable ||
-|| `gstHHHJump` || ||
+|| `gstAttacked` || Set for hedgehogs after they have finished their attack (including all shots). Not used in infinite attack mode ||
+|| `gstAttacking` || Used to indicate when a hedgehog is currently attacking (player holds down attack key). Also used for triggered mines ||
+|| `gstCollision` || Used to indicate the gear has just collided with something. Used internally for many checks and stuff ||
+|| `gstDrowning` || Gear is drowning ||
+|| `gsttmpFlag` || Used for various purposes, its meaning depends on the gear type (see GearTypes) ||
+|| `gstNoDamage` || Gear does not take damage from explosions and attacks like shoryuken and will not be pushed by them. For the invulnerability shield used by hedgehogs, use `SetEffect`
 || `gstAnimation` || Hedgehog plays an animation ||
-|| `gstHHDeath` || Hedgehog is dying ||
-|| `gstWinner` || This is good for indicating hedgehogs they did well. Represented by a stupid grin. ||
 || `gstWait` || ||
 || `gstNotKickable` || Hedgehog can't be knocked away by various means (i.e. rope-knocking) ||
-|| `gstLoser` || This is good for indicating hedgehogs screwed up ||
-|| `gstHHGone` || ||
 || `gstInvisible` || Gear is invisible ||
-|| `gstSubmersible` || ||
-|| `gstFrozen` || Gear is frozen. ||
-|| `gstNoGravity` || ||
+|| `gstSubmersible` || Gear can swim underwater ||
+|| `gstFrozen` || Gear is frozen ||
+|| `gstNoGravity` || If set, gear is not subject to gravity (does not work for all gears) ||
 
 See http://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas#l195 for a current list).
\ No newline at end of file