States.wiki
author Wuzzy
Wed, 11 Jul 2018 13:39:34 +0100
changeset 1443 d25ab95f2311
parent 1233 5776338a1613
child 2093 6edb9964990d
permissions -rw-r--r--
LuaAPI: deprecate lfCurrentHog
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
     1
#summary List of states gears can be in
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
     2
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
     3
This is a list of states gears can be in:
429
63844466ea5f Add summary
almikes@aol.com
parents: 357
diff changeset
     4
740
1f6471e2e082 States: Add title
Wuzzy
parents: 587
diff changeset
     5
= List of states =
1f6471e2e082 States: Add title
Wuzzy
parents: 587
diff changeset
     6
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
     7
|| *Gear state* || *Description* ||
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
     8
|| `gstHHDriven` || Hedgehog is controlled by current player ||
825
e6a6cfe308d4 States: gstFrozen vs heFrozen
Wuzzy
parents: 798
diff changeset
     9
|| `gstChooseTarget` || Used for hedgehogs; if set, player can select a target with the cursor (e.g. for homing bee, air attack, etc.) ||
783
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    10
|| `gstHHJumping` || Used to indicate when a hedgehog is doing the long jump ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    11
|| `gstHHHJump` || Used to indicate when a hedgehog is doing the high jump ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    12
|| `gstHHThinking` || Thought bubble animation plays for hedgehog (used for AI players) ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    13
|| `gstHHDeath` || Hedgehog is dying ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    14
|| `gstHHGone` || Set if hedgehog is going to teleport away from the battlefield because the player left the game (in network play) ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    15
|| `gstWinner` || This is good for indicating hedgehogs they did well. Represented by a stupid grin. ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    16
|| `gstLoser` || This is good for indicating hedgehogs screwed up ||
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
    17
|| `gstMoving` || Gear is moving / in mid-air ||
783
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    18
|| `gstAttacked` || Set for hedgehogs after they have finished their attack (including all shots). Not used in infinite attack mode ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    19
|| `gstAttacking` || Used to indicate when a hedgehog is currently attacking (player holds down attack key). Also used for triggered mines ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    20
|| `gstCollision` || Used to indicate the gear has just collided with something. Used internally for many checks and stuff ||
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    21
|| `gstDrowning` || Gear is drowning ||
785
d801bd3aca18 States: add link
Wuzzy
parents: 784
diff changeset
    22
|| `gsttmpFlag` || Used for various purposes, its meaning depends on the gear type (see [GearTypes]) ||
784
19fc31fe4094 States: fix syntax
Wuzzy
parents: 783
diff changeset
    23
|| `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` ||
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
    24
|| `gstAnimation` || Hedgehog plays an animation ||
1233
5776338a1613 States: Edited via web interface
Wuzzy
parents: 825
diff changeset
    25
|| `gstWait` || ??? ||
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
    26
|| `gstNotKickable` || Hedgehog can't be knocked away by various means (i.e. rope-knocking) ||
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
    27
|| `gstInvisible` || Gear is invisible ||
783
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    28
|| `gstSubmersible` || Gear can swim underwater ||
825
e6a6cfe308d4 States: gstFrozen vs heFrozen
Wuzzy
parents: 798
diff changeset
    29
|| `gstFrozen` || Gear is frozen. This state is not for hedgehogs; for hedgehogs, use `SetEffect` and `GetEffect` with `effect=heFrozen` instead ||
783
c4b171741ee3 States: Add documentation for most gear states
Wuzzy
parents: 740
diff changeset
    30
|| `gstNoGravity` || If set, gear is not subject to gravity (does not work for all gears) ||
584
9e5ad14e0afb Some ad-hoc descriptions for some gear states. I hope they are not too wrong.
almikes@aol.com
parents: 429
diff changeset
    31
1233
5776338a1613 States: Edited via web interface
Wuzzy
parents: 825
diff changeset
    32
See https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas#l195 for a current list.