GearTypes.wiki
author Wuzzy
Mon, 17 Apr 2017 15:46:13 +0100
changeset 971 23149c3caaba
parent 970 0b7d2858fb21
child 998 f6ed8749f20b
permissions -rw-r--r--
Dependencies: Update PhysFS versions
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
426
278b97ba739c Add summary
almikes@aol.com
parents: 425
diff changeset
     1
#summary List of all gear types
278b97ba739c Add summary
almikes@aol.com
parents: 425
diff changeset
     2
737
94cab3991e06 GearTypes: Add title
Wuzzy
parents: 716
diff changeset
     3
= Gear types =
94cab3991e06 GearTypes: Add title
Wuzzy
parents: 716
diff changeset
     4
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
     5
This is a list and overview of all gear types.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
     6
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
     7
This page is split in two parts: The first part is a short list, the second part gives a longer description for all gear types and also describes the meaning of the gear values (such as timer, pos, health, etc.).
425
ae373695ee1e Add columns for pos, timer and health (mostly only contain TODOs for now).
almikes@aol.com
parents: 424
diff changeset
     8
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
     9
Please note this page is still a work in progess. The categories presented here are purely for a better overview here; they do not neccessarily reflect anything in the actual game’s source code.
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
    10
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    11
A “TODO” means that this particular section is not yet finished and may be not accurate.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    12
703
7d343af36e43 decrease TOC depth
Wuzzy
parents: 702
diff changeset
    13
<wiki:toc max_depth="3" />
702
530c4aefa069 Add table of contents
Wuzzy
parents: 701
diff changeset
    14
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    15
== List of gear types ==
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    16
This is a short overview and a brief description of all gears.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    17
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    18
=== Land objects ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    19
|| *Gear type* || *Description* ||
846
19f1fe382e5f GearTypes: Add internal link
Wuzzy
parents: 842
diff changeset
    20
|| [GearTypes#gtCase `gtCase`] || An ammo, utility or health crate ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    21
|| [GearTypes#gtExplosives `gtExplosives`] || An explosive barrel ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    22
|| [GearTypes#gtFlake `gtFlake`] || A snowflake or a land spray flake ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    23
|| [GearTypes#gtFlame `gtFlame`] || A flame ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    24
|| [GearTypes#gtGrave `gtGrave`] || A grave ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    25
|| [GearTypes#gtHedgehog `gtHedgehog`] || A hedgehog ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    26
|| [GearTypes#gtPortal `gtPortal`] || A portal from the portable portal device ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    27
|| [GearTypes#gtTarget `gtTarget`] || A target ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    28
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    29
=== Utilities ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    30
|| *Gear type* || *Description* ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    31
|| [GearTypes#gtGirder `gtGirder`] || An attempt to place a construction or rubber ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    32
|| [GearTypes#gtJetpack `gtJetpack`] || A flying saucer ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    33
|| [GearTypes#gtLandGun `gtLandGun`] || The land spray tool ||
848
fd0c8a52cf31 GearTypes: fix bad parachute link
Wuzzy
parents: 847
diff changeset
    34
|| [GearTypes#gtParachute `gtParachute`] || A parachute ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    35
|| [GearTypes#gtResurrector `gtResurrector`] || Resurrection ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    36
|| [GearTypes#gtRope `gtRope`] || A rope ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    37
|| [GearTypes#gtSwitcher `gtSwitcher`] || Switch hedgehog ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    38
|| [GearTypes#gtTardis `gtTardis`] || A !TimeBox ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    39
|| [GearTypes#gtTeleport `gtTeleport`] || Teleportation ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    40
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    41
=== Weapons and main projectiles ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    42
|| *Gear type* || *Description* ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    43
|| [GearTypes#gtAirAttack `gtAirAttack`] || The airplane of an airborne attack ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    44
|| [GearTypes#gtAirMine `gtAirMine`] || An air mine ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    45
|| [GearTypes#gtBallGun `gtBallGun`] || A ballgun ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    46
|| [GearTypes#gtBee `gtBee`] || Homing bee ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    47
|| [GearTypes#gtBirdy `gtBirdy`] || Birdy ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    48
|| [GearTypes#gtBlowTorch `gtBlowTorch`] || A blowtorch ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    49
|| [GearTypes#gtClusterBomb `gtClusterBomb`] || A cluster bomb ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    50
|| [GearTypes#gtCake `gtCake`] || A cake ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    51
|| [GearTypes#gtDEagleShot `gtDEagleShot`] || A shot from a Desert Eagle ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    52
|| [GearTypes#gtDrill `gtDrill`] || Drill rocket ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    53
|| [GearTypes#gtDynamite `gtDynamite`] || A dynamite ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    54
|| [GearTypes#gtFirePunch `gtFirePunch`] || Shoryuken ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    55
|| [GearTypes#gtFlamethrower `gtFlamethrower`] || A flamethrower ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    56
|| [GearTypes#gtGasBomb `gtGasBomb`] || An old limburger ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    57
|| [GearTypes#gtGrenade `gtGrenade`] || A grenade ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    58
|| [GearTypes#gtHammer `gtHammer`] || A gear dealing hammer damage ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    59
|| [GearTypes#gtHellishBomb `gtHellishBomb`] || A hellish hand-grenade ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    60
|| [GearTypes#gtIceGun `gtIceGun`] || A freezer ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    61
|| [GearTypes#gtKamikaze `gtKamikaze`] || An ongoing kamikaze ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    62
|| [GearTypes#gtKnife `gtKnife`] || A cleaver ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    63
|| [GearTypes#gtPiano `gtPiano`] || Piano from piano strike ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    64
|| [GearTypes#gtPickHammer `gtPickHammer`] || A pickhammer ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    65
|| [GearTypes#gtRCPlane `gtRCPlane`] || A RC plane ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    66
|| [GearTypes#gtMolotov `gtMolotov`] || A molotov cocktail ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    67
|| [GearTypes#gtMortar `gtMortar`] || A mortar ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    68
|| [GearTypes#gtMine `gtMine`] || A mine ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    69
|| [GearTypes#gtSeduction `gtSeduction`] || Seduction ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    70
|| [GearTypes#gtShell `gtShell`] || A bazooka shell (projectile) ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    71
|| [GearTypes#gtShotgunShot `gtShotgunShot`] || A shot from a shotgun ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    72
|| [GearTypes#gtShover `gtShover`] || Used by baseball bat ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    73
|| [GearTypes#gtSineGunShot `gtSineGunShot`] || A shot from the sine gun ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    74
|| [GearTypes#gtSMine `gtSMine`] || A sticky mine ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    75
|| [GearTypes#gtSniperRifleShot `gtSniperRifleShot`] || A shot from the sniper rifle ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    76
|| [GearTypes#gtSnowball `gtSnowball`] || A mudball ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    77
|| [GearTypes#gtWatermelon `gtWatermelon`] || A watermelon bomb, still intact ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    78
|| [GearTypes#gtWhip `gtWhip`] || A whip ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    79
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    80
=== Secondary projectiles ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    81
|| *Gear type* || *Description* ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    82
|| [GearTypes#gtAirBomb `gtAirBomb`] || A bomb from the air attack or the RC plane ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    83
|| [GearTypes#gtBall `gtBall`] || A ball from the ball gun || 
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    84
|| [GearTypes#gtCluster `gtCluster`] || A cluster from the cluster bomb or the mortar ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    85
|| [GearTypes#gtEgg `gtEgg`] || An egg from Birdy ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    86
|| [GearTypes#gtHammerHit `gtHammerHit`] || A hammer digging into land ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    87
|| [GearTypes#gtMelonPiece `gtMelonPiece`] || A cluster from a watermelon bomb ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    88
|| [GearTypes#gtNapalmBomb `gtNapalmBomb`] || A bomb from the napalmn strike ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    89
|| [GearTypes#gtPoisonCloud `gtPoisonCloud`] || A poisonous cloud ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    90
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    91
=== Other ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    92
|| *Gear type* || *Description* ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    93
|| [GearTypes#gtAddAmmo `gtAddAmmo`] || Adds a weapon or utilty to a hedgehog. ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    94
|| [GearTypes#gtATStartGame `gtATStartGame`] || Created at the start of the game.  ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    95
|| [GearTypes#gtATFinishGame `gtATFinishGame`] || Created at the end of the game. Fades out the screen and exits the game. || 
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    96
|| [GearTypes#gtGenericFaller `gtGenericFaller`] || TODO || 
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    97
|| [GearTypes#gtWaterUp `gtWaterUp`] || Causes water to rise. ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    98
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    99
== Long descriptions and values ==
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   100
This section gives longer description of the various gear types and how their values (i.e. tag, pos, timer, health, etc.) are interpreted. The gear values are pretty chaotic, so they are described for each gear seperately. Use the various setter and getter functions for gears to modifiy the gear values.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   101
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   102
In Lua, use the functions `GetGearPos`, `SetGearPos`, `GetTag`, `SetTag`, `GetTimer`, `SetTimer`, `GetHealth`, `SetHealth`, `GetFlightTime`, `SetFlightTime`, `GetGearValues` and `SetGearValues` to query or modify the gear values.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   103
Note: The gear value “`Boom`” will be introduced in Hedgewars 0.9.23.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   104
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   105
=== Land objects ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   106
This is a list of gears which usually stay on the land for a long time and stay for several rounds and can’t normally directly placed by players.
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   107
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   108
==== `gtCase` ====
880
edb64d05684e GearTypes: Fix some spelling mistakes
Wuzzy
parents: 879
diff changeset
   109
An ammo, utility, health or even a fake crate.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   110
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   111
If the crate has just been collected, the gear message flag `gmDestroy` will be set before `onGearDelete` is called.
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   112
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   113
 * `Pos`: Crate type: 1=ammo crate, 2=health crate, 4=utility crate (also see below)
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   114
 * `Tag`: Used for the appear animation
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   115
 * `Health`: Amount of health contained in a health crate
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   116
 * `Boom`: Explosion size and damage (default: 25)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   117
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   118
We recommend you to use `SpawnAmmoCrate` and the like to crate crate gears instead of `AddGear`. Also note that `SpawnAmmoCrate` and `SpawnUtilityCrate` are the only way to set a crate's ammo in Lua, it can not be changed or read afterwards.
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   119
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   120
Advanced crate types: If you just care about normal crates, the values 1, 2 and 4 mentioned above are all you need to know. But Hedgewars supports a few crate variants which can be spawned with `SpawnFakeAmmoCrate` and the like. The `Pos` parameter is in reality a sum of several flags which need to be added up for the final type.
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   121
|| *Pos flag* || *Meaning* ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   122
|| `0x1` || Ammo crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   123
|| `0x2` || Health crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   124
|| `0x4` || Utility crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   125
|| `0x8` || Fake crate, looks like a normal crate but does not actually contain health or ammo ||
880
edb64d05684e GearTypes: Fix some spelling mistakes
Wuzzy
parents: 879
diff changeset
   126
|| `0x10` || Booby trap: When the player collects this crate it will explode ||
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   127
|| `0x20` || Poison trap: When the player collects this crate the player will be poisoned ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   128
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   129
All crates *must* have exactly one of the flags `0x1`, `0x2` or `0x4` set. Everything else can be combined at will.
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   130
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   131
Examples:
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   132
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   133
 * Pos = 0x1: Ammo crate
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   134
 * Pos = 0x9: Fake ammo crate (0x1 + 0x8)
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   135
 * Pos = 0x2A: Fake health crate with poison trap (0x2 + 0x8 + 0x20)
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   136
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   137
==== `gtExplosives` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   138
An explosive barrel. It has its own invisible health, like a hedgehog. On low health levels smoke comes out of the barrel.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   139
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   140
 * `Health`: “health” of the barrel: Starts at 60, explodes at 0.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   141
 * `Boom`: Explosion size and damage (default: 75)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   142
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   143
==== `gtFlake` ====
850
284d32236865 GearTypes: Fix landgun link
Wuzzy
parents: 849
diff changeset
   144
A little object which will, when colliding with the terrain, become part of the terrain. It is either a snowflake generated by the theme (examples are the Snow and Christmas themes) or a flake created by a land spray ([GearTypes#gtLandGun `gtLandGun`]).
712
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   145
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   146
If the gear state flag `gsttmpFlag` is set, it is a flake from a land spray, otherwise, it is a snowflake.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   147
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   148
==== `gtFlame` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   149
A single flame.
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   150
In the main game, there are two kinds of flames: Sticky ones and non-sticky ones. Non-sticky ones will quickly burn through land and are guaranteed to be destroyed at the end of a turn. Sticky flames may live through multiple turns and burn very slowly through land. Sticky flames die based on time.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   151
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   152
Sticky flames have the gear state flag `gsttmpFlag` set, non-sticky ones haven't.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   153
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   154
 * `Tag`: Current animation frame (0-32)
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   155
 * `Health`: Size of the flame. Non-sticky flames starts at 5 (largest) and become smaller as they destroy land and damage gears. All flames die when they reach a health of 0.
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   156
 * `FlightTime`: If set to `0`, this flame can damage hedgehogs and other gears even in mid-air. Otherwise, flames don't do damage while they are still falling. By default, the `FlightTime` is a huge non-zero value.
970
0b7d2858fb21 GearTypes: Fix gtFlame dmg
Wuzzy
parents: 969
diff changeset
   157
 * `Boom`: Damage and size of destroyed land (default: 2). Sticky flames always deal `Boom` damage, non-sticky flames deal either `Boom` or sometimes deal 3 times this value as damage.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   158
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   159
==== `gtGrave` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   160
A grave from a dead hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   161
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   162
 * `Health`: If 0, it is not being resurrected. With larger values, it is being resurrected, and the value stands for amount of health the owner of this grave has received so far.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   163
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   164
==== `gtHedgehog` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   165
A hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   166
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   167
Basic attributes are:
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   168
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   169
 * `Health`: Hedgehog's health.
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   170
 * `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   171
 * `Radius`: Collision radius. Default: 9
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   172
 * `Boom`: Explosion size and damage caused when the hedgehog dies (default: 30)
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   173
 * `FlightTime`: Time (in milliseconds) since the hedgehog stood the last time on solid ground
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   174
782
0fba851eb618 GearTypes: cleanup gtHedgehog
Wuzzy
parents: 781
diff changeset
   175
Hedgehogs also make heavy use of the gear state, see [States]. [GearMessages Gear messages] are used for controlling a hedgehogs movement and actions (e.g. moving left, attacking, jumping, etc.)
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   176
782
0fba851eb618 GearTypes: cleanup gtHedgehog
Wuzzy
parents: 781
diff changeset
   177
Please note that hedgehogs have also many other attributes and functions which are specific to hedgehogs only (like name, team name, hat, etc.). You can find many hedgehog-related functions in LuaAPI.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   178
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   179
==== `gtPortal` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   180
A portal from the portable portal device.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   181
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   182
 * `Tag`: Portal state. 0=orange flying, 1=orange placed, 2=blue flying, 3=blue placed
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   183
 * `Timer`: Remaining existance time (portals will disappear after end of turn).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   184
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   185
==== `gtTarget` ====
710
580a83691524 Explain gtTarget
Wuzzy
parents: 709
diff changeset
   186
A target, useful in target practice and similar missions. This is a simple gear which will fall straight down and is destroyed by any form of damage, no matter how small. It is not affected by wind.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   187
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   188
=== Utilities ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   189
The gears used by various utilities.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   190
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   191
==== `gtGirder` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   192
This gear is created when a player tried to place construction or rubber somewhere. Placement may or may not have been successful.
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   193
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   194
 * `State`: Orientation and size coded as a number. See Lua API documentation on `onGirderPlacement` or `onRubberPlacement` for the meaning of the number.
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   195
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   196
If you expect a successful placement including information regarding building type, position and orientation, use the functions `onGirderPlacement` and `onRubberPlacement`, respectively.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   197
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   198
==== `gtJetpack` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   199
A flying saucer. Its fuel is stored in `Health` and starts at 2000, which stands for 100% fuel. The fuel value is reduced whenever the player taps one of the direction keys. The up direction costs 50 fuel and the left and right directions cost 10 fuel.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   200
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   201
 * `Health`: Amount of remaining fuel. `2000` denotes 100% fuel.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   202
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   203
==== `gtLandGun` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   204
The land spray tool. Creates [GearTypes#gtFlake `gtFlake`] gears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   205
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   206
 * `Tag`: Spitting power of land spray (`5`-`20`).
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   207
 * `Health`: Amount of fuel. `1000` denotes 100% fuel.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   208
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   209
==== `gtParachute` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   210
A parachute.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   211
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   212
==== `gtResurrector` ==== 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   213
A hedgehog which does perform a resurrection.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   214
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   215
 * `Radius`: Effect range of resurrection in pixels (default: 100). Note that this does not change the drawn circle
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   216
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   217
==== `gtRope` ====
856
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   218
A rope. There can only be one rope gear at once.
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   219
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   220
The gear state flag `gstCollision` is set when the previous rope shot has hit something and is reset each time a new hook it fired.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   221
856
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   222
 * `X` and `Y`: Position of the nearest “bending point” of the rope (nearest to the rope gun), or the rope hook if rope does not touch anything
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   223
 * `dX`: sine of rope angle, number between -1000000 and 1000000 (correspond to -180° to 180°)
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   224
 * `dY`: negative cosine of rope angle, expressed as number between 0 and 1000000
856
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   225
 * `Elasticity`: If the hog is attached to a rope, or is busy firing one, the elasticity of the rope will be non-rezo. A non-zero number holds the current retracted length of the rope from the nearest “bending point” or the hook, times 10000
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   226
 * `Friction`: Holds the maximum remaning length of the rope measured from the nearest “bending point” or the hook, times 10000. Set this after rope creation to manually set the rope length individually. Note you can set `RopePercent` in `onGameInit` to set the rope length for all ropes at once
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   227
 * `Tag` Rope style: `0`=classic white segments (default), `1`=simple line which can be colored with `Tint`.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   228
 * `Tint`: Rope color as RGBA. This only works if `Tag` equals `1`
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   229
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   230
Note: `dX` and `dY` are returned by the `GetGearVelocity` function.
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   231
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   232
==== `gtSwitcher` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   233
Switch hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   234
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   235
==== `gtTardis` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   236
A !TimeBox. It works in several phases and an internal timer.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   237
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   238
 * `Pos`: Current phase. The value `4` is used when the !TimeBox is currently time-travelling (has completely turned invisible).
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   239
 * `Timer`: Has several meanings, depending on `Pos`. Here's the most imporant one, for `Pos` of `4`: A timer (in milliseconds) containing the remaining time until the !TimeBox returns. The !TimeBox returns when `Timer` reaches 0. Hedgewars decreases the timer only while the same team is playing
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   240
 * `Tint`: RGBA color (default: clan color)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   241
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   242
TODO: Add more information for the other phases.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   243
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   244
==== `gtTeleport` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   245
Teleportation.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   246
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   247
=== Weapons and main projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   248
Gears of weapons which can be directly used or launched by the players.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   249
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   250
==== `gtAirAttack` ====
851
6948d85cf3c9 GearTypes: fix gtDrill link
Wuzzy
parents: 850
diff changeset
   251
The airplane of an airborne attack. It can drop either missiles ([GearTypes#gtAirBomb `gtAirBomb`]), mines ([GearTypes#gtMine `gtMine`]), napalm missiles ([GearTypes#gtNapalmBomb `gtNapalmBomb`]) or drill rockets ([GearTypes#gtDrill `gtDrill`])
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   252
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   253
 * `Pos`: Type of airborne attack: `0` = Air Attack, `1` = Mine Strike, `2` = Napalm, `3` = Drill Strike
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   254
 * `Tag`: Direction of airplane: `-1` = left, `1` = right
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   255
 * `Health`: Number of bombs/mines/drills left (default: 6)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   256
 * `Damage`: Distance (in pixels) between two dropped bombs/mines/drills (default: 30)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   257
 * `Tint`: RGBA color of airplane (default: clan color)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   258
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   259
==== `gtAirMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   260
An air mine. It seeks nearby hedgehogs. If it is in explosion range, its timer activates and will become lower. If the timer reaches 0 and is still in explosion range of a hedgehog, it explodes. But it does not explode if it is out of range, after which the timer is reset and the air mine can be activated again.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   261
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   262
To properly set the timer of an air mine, you must set both `Timer` and `WDTimer`.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   263
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   264
If the gear state flag `gstAttacking` is set, the air mine is activated and is about to explode.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   265
If the gear state flag `gstChooseTarget` is set, the air mine is currently hunting a hedgehog. This should only be read by Lua scripts, setting it from a Lua script has no effect.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   266
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   267
 * `Pos`: Air friction. Higher values mean slower movement. 
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   268
 * `Timer`: Time left until possible detonation (in milliseconds). Default value depends on game scheme.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   269
 * `WDTimer`: Initial timer value (in milliseconds) of an activated air mine. The `Timer` is reset to this value if the air mine gets re-activated.
969
cb6bb484ce2a GearTypes: escape distance of airmines
Wuzzy
parents: 968
diff changeset
   270
 * `Angle`: Range in which it seeks and follows hedgehogs, in pixels. If a hedgehog is within this range, the air mine will start following. Set it to `0xFFFFFFFF` for an infinite seek range. Set to `0` to disable following. This also indirectly sets the escape distance which hog need to reach for the air mine to stop following. It is 6 times this value. Default: 175 (and an implied default escape distance of 1050)
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   271
 * `Power`: Speed in which it seeks and follows hedgehogs.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   272
 * `Karma`: Explosion size and damage (in 0.9.22). Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   273
 * `Boom`: Explosion size and damage (in 0.9.23). Default: 25
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   274
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   275
==== `gtBallGun` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   276
A ballgun. It throws 51 balls ([GearTypes#gtBall `gtBall`]) by default. This weapon is timer-based.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   277
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   278
 * `Timer`: Remaining usage time (in ms), default is 5001. One ball is fired every 100ms.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   279
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   280
==== `gtBee` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   281
A homing bee. The bee works in up to three phases: The first phase is the pre-homing phase lasts 0.5 seconds in which the bee behaves like a normal projectile. In the second phase the bee actually starts homing. This phase can last up to 5 seconds. If the bee did not explode in this time, the bee goes into post-homing phase, stops homing and simply falls. For the first two phases this gear uses `Timer`.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   282
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   283
This gear does not directly store in which phase the bee currently is in, so it is a bit tricky to modify the timer values.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   284
If you just want to modify the pre-homing time, simply set the `Timer` after creation. But if you want to modify the duration of the homing phase, you have somehow track the bee gear and wait until the `Timer` first reaches 0, so you know the bee will now get into its second phase. Now wait one more tick (or more) and set `Timer` to set the maximum flight time in the homing phase.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   285
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   286
 * `Tag`: Whether the bee is underwater (`0` = no, `1` = yes). This is used for the sound effect.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   287
 * `Timer`: Remaining time (in milliseconds) either of the pre-homing phase or the homing phase.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   288
 * `Boom`: Explosion size and damage. Default: 50
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   289
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   290
==== `gtBirdy` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   291
Birdy. Transports hogs and can drop eggs ([GearTypes#gtEgg `gtEgg`]). Birdy works like a flying saucer and depletes energy (stored in `Health`) whenever you tap one of the direction keys. Flapping left and right costs 10 energy, flapping upwards costs 50 energy.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   292
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   293
 * `Tag`: Facing direction (`-1` = left, `1` = right)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   294
 * `Health`: “Flapping energy” left, default is 2000
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   295
 * `FlightTime`: Number of eggs left (default: 2)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   296
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   297
==== `gtBlowTorch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   298
A blowtorch. This utility is entirely timer-based.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   299
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   300
 * `Timer`: Remaining usage time in ms, default is 7500.
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   301
 * `Radius`: Hit radius. Things inside this radius will be hit. Default: 15
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   302
 * `Boom`: Damage caused when burning a hedgehog or an object. Default: 2
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   303
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   304
==== `gtClusterBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   305
A cluster bomb. Spawns several [GearTypes#gtCluster `gtCluster`] gears on detonation.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   306
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   307
 * `Boom`: Explosion size and damage. Default: 20
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   308
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   309
==== `gtCake` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   310
A cake. 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   311
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   312
 * `Tag`: A timer used for several animations. The final animation (sit down) will cause the cake to explode when the tag reaches `2250`.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   313
 * `Health`: Remaining walking time, default is 2048. Note: the cake uses its own time unit.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   314
 * `Boom`: Explosion size and damage. Default: 75
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   315
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   316
==== `gtDEagleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   317
A shot from a Desert Eagle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   318
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   319
 * `Health`: How deep the bullet digs into land. Default: 50.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   320
 * `Boom`: Damage. Default: 7
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   321
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   322
==== `gtDrill` ====
854
d58e744b2909 GearTypes: link to gtAirAttack in gtDrill
Wuzzy
parents: 853
diff changeset
   323
A drill rocket. This is either a launched drill rocket or a small and weaker drill rocket from the drill strike ([GearTypes#gtAirAttack `gtAirAttack`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   324
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   325
The type of drill rocket is stored in the gear state. If `gsttmpFlag` is set (e.g. {{{band(GetState(yourDrillGear), gsttmpFlag) == 0}}} evaluates to `true`), it is a launched drill rocket, otherwise it is a drill rocket from the drill strike.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   326
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   327
 * `Tag`: Used for drill strike. If `1`, then first impact occoured already.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   328
 * `Timer`: Detonation timer (in ms)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   329
 * `Boom`: Explosion size and damage. Default: 50 for launched drill rocket, 30 for drill rocket from drill strike
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   330
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   331
==== `gtDynamite` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   332
A dynamite.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   333
Note: The current animation does not support denotation times above 5 seconds. If you want to have larger times, you have to provide your own dynamite sprite in a sidecar HWP or find another workaround.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   334
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   335
 * `Tag`: Displayed animation frame.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   336
 * `Timer`: Detonation timer (in ms). Default: 5000.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   337
 * `Boom`: Explosion size and damage. Default: 75
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   338
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   339
==== `gtFirePunch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   340
A hedgehog which performs the Shoryuken attack.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   341
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   342
 * `Tag`: Current Y coordinate of the hedgehog.
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   343
 * `Radius`: Hit radius. Default: 15
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   344
 * `Boom`: Damage. Default: 30
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   345
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   346
==== `gtFlamethrower` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   347
A flamethrower creates both sticky and non-sticky [GearTypes#gtFlame `gtFlame`] gears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   348
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   349
 * `Tag`: Current spitting power of flamethrower (`5`-`20`)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   350
 * `Health`: Remaining fuel. `500` is for 100% fuel.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   351
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   352
==== `gtGasBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   353
An old limburger. Will spawn several [GearTypes#gtPoisonCloud `gtPoisonCloud`] gears on detonation.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   354
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   355
 * `Timer`: Detonation timer (in milliseconds).
968
6cb9a810e184 GearTypes: Add gtGasBomb boom
Wuzzy
parents: 941
diff changeset
   356
 * `Boom`: Explosion size and damage. Default: 20
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   357
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   358
==== `gtGrenade` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   359
A grenade.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   360
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   361
 * `Timer`: Detonation timer (in milliseconds).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   362
 * `Boom`: Explosion size and damage. Default: 50
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   363
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   364
==== `gtHammer` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   365
A hammer attack. This gear is for determining which hedgehogs and objects to hit and to reduce health of anything hit. Hedgehogs, mines and barrels can be hit. See also [GearTypes#gtHammerHit `gtHammerHit`] for the digging part.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   366
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   367
 * `Boom`: Damage denominator. The damage caused will be `(1/Boom)*health_of_victim`, e.g. if this value is `4` and the victim has 100 health, the hammer takes away 25 health (one quarter). Default: 3 normally (so one third of the health); 2 if Extra Damage is enabled (so one half of the health)
792
dfb7a269d70b GearTypes: gtHammer radius
Wuzzy
parents: 791
diff changeset
   368
 * `Radius`: Stuff inside this radius will be hit and be subject to hammer damage and digging. Default: 20
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   369
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   370
==== `gtHellishBomb` ====
853
b3c2c6ff4da3 GearTypes: fix broken gtFlame link
Wuzzy
parents: 852
diff changeset
   371
A hellish hand-grenade. It creates several sticky and non-sticky flames ([GearTypes#gtFlame `gtFlame`]) on detonation.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   372
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   373
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   374
 * `Boom`: Explosion size and damage. Default: 90
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   375
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   376
==== `gtIceGun` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   377
A freezer.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   378
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   379
 * `Health`: Remaining fuel. `1000` is for 100% fuel
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   380
 * `Radius`: Freeze radius; Objects and hogs will be frozen within the radius of the freezer beam impact location. Does not affect the size land which will be frozen. Default: 8
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   381
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   382
==== `gtKamikaze` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   383
A hedgehog which is doing a kamikaze attack.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   384
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   385
 * `Health`: Remaining travel range. Default: 2048
855
0878a8e37afb GearTypes: fix typo
Wuzzy
parents: 854
diff changeset
   386
 * `Radius`: Hit radius. Objects and hogs within this distance of the kamikaze hog will be hit. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   387
 * `Boom`: Damage of a hit and damage and explosion size of the final explosion. Default: 30
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   388
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   389
==== `gtKnife` ====
789
6693fdfb6876 GearTypes: cleaver damage
Wuzzy
parents: 788
diff changeset
   390
A cleaver. If the cleaver takes a lot of damage, it might fall down into the water (without colliding with the land) eventually.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   391
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   392
 * `Boom`: Scaling value for the impact damage. The actual damage does not linearly scale. Default: 40000
789
6693fdfb6876 GearTypes: cleaver damage
Wuzzy
parents: 788
diff changeset
   393
 * `Damage`: Holds the damage taken by the cleaver received in the current tick (damage taken *at once*). For each tick, `Damage` is first checked and then reset to 0. If the damage was greater than 30, then there is a chance the cleaver will drop, with the chance increasing with the damage. When `Damage` is over 100, the cleaver will drop for sure.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   394
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   395
==== `gtPiano` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   396
A piano from piano strike. By default, a piano bounces up to 5 times on the terrain, causing 3 big explosions (80 damage each) per impact.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   397
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   398
 * `Tag`: Number of remaining terrain bounces. If this number reaches 0, the piano will not collide anymore and directly fall into the water. Default: 5
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   399
 * `Boom`: Explosion size and damage of a single explosion of a single impact. Default: 80
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   400
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   401
==== `gtPickHammer` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   402
A pickhammer. This gear is entirely timer-based.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   403
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   404
 * `Timer`: Remaining usage time (in milliseconds). Default: 4000
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   405
 * `Radius`: Width of dug land. Default: 10
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   406
 * `Boom`: Damage per hit. Default: 6
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   407
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   408
==== `gtRCPlane` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   409
An RC plane. It can drop missiles ([GearTypes#gtAirBomb `gtAirBomb`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   410
857
ca7261b5c679 GearTypes: Explain Tag for RC plane
Wuzzy
parents: 856
diff changeset
   411
 * `Tag`: Initial flying direction, depends on the facing direction of the hedgehog which launched it. -1: left, 1: right. This is used for rendering. 
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   412
 * `Timer`: Remaining fly time (in milliseconds). Default: 15000
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   413
 * `Health`: Number of missiles on board. Default: 3
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   414
 * `Tint`: RGBA color of RC plane (default: clan color)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   415
 * `Boom`: Explosion size and damage when the RC plane crashes. Default: 25
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   416
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   417
==== `gtMolotov` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   418
A molotov cocktail. Creates several flames ([GearTypes#gtFlame `gtFlame`]) on impact.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   419
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   420
==== `gtMortar` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   421
A mortar. On impact it spawns a few [GearTypes#gtCluster `gtCluster`] gears.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   422
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   423
 * `Boom`: Explosion size and damage of the main mortar projectile only. Default: 20
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   424
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   425
==== `gtMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   426
A land mine.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   427
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   428
If the gear state flag `gstAttacking` is set, mine has been activated and is about to explode (if it is not a dud).
788
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   429
The game will decide whether a mine is a dud or not when the mine timer reaches 0.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   430
788
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   431
 * `Timer`: Detonation timer (after activation). The initial value depends on the game settings.
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   432
 * `Health`: If `0`, mine is a dud, otherwise it is not a dud or has not been triggered yet.
941
6100c2308a82 GearTypes: Add tag to mine
Wuzzy
parents: 882
diff changeset
   433
 * `Tag`: (0.9.23) If `1`, mine timer will be random.
827
231aed2ea8ae GearTypes: Fix mine Damage
Wuzzy
parents: 817
diff changeset
   434
 * `Damage`: If mine has become a dud, this will contain the damage taken by the mine since it was a dud. It starts at 0 and the mine will explode when `Damage` is greater than 35.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   435
 * `Boom`: Explosion size and damage. Default: 50
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   436
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   437
==== `gtSeduction` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   438
A hedgehog trying to seduce others.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   439
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   440
 * `Radius`: Effect range of seduction in pixels. Default: 250. Note that this does not change the drawn circle
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   441
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   442
==== `gtShell` ====
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   443
 A bazooka shell (projectile).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   444
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   445
 * `FlightTime`: Time since the bazooka has been launched
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   446
 * `Boom`: Explosion size and damage. Default: 50
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   447
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   448
==== `gtShotgunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   449
A shot from a shotgun. It is invisible and only can be noticed by its effects.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   450
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   451
 * `Boom`: Damage. Default: 25
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   452
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   453
==== `gtShover` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   454
Used by baseball bat.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   455
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   456
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   457
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   458
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   459
==== `gtSineGunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   460
A shot from the sine gun.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   461
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   462
 * `Radius`: The thickness of the sine gun shot.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   463
 * `Boom`: Damage. Default: 35
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   464
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   465
==== `gtSMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   466
A sticky mine.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   467
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   468
If the gear state flag `gstAttacking` is set, the sticky mine has been activated and is about to explode.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   469
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   470
 * `Timer`: Detonation timer after it was activated (in milliseconds). Default: 500
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   471
 * `Boom`: Explosion size and damage. Default: 30
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   472
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   473
==== `gtSniperRifleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   474
A shot from the sniper rifle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   475
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   476
 * `Health`: How deep the bullet digs into land. Default: 50
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   477
 * `Boom`: Scaling value of the damage caused (not the actual damage). A higher value leads to higher damage. Default: 100000
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   478
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   479
==== `gtSnowball` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   480
A mudball.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   481
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   482
 * `Boom`: Pushing power (just an arbitrary value for scaling). Default: 200000
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   483
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   484
==== `gtWatermelon` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   485
A watermelon bomb, still intact. It spawns several [GearTypes#gtMelonPiece `gtMelonPiece`] gears when it explodes.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   486
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   487
 * `Timer`: Detonation timer (in milliseconds).
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   488
 * `Boom`: Explosion size and damage. Default: 75
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   489
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   490
==== `gtWhip` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   491
A whip.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   492
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   493
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   494
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   495
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   496
=== Secondary projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   497
Gears for projectiles that can’t be directly fired but are generated by other weapon gears.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   498
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   499
==== `gtAirBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   500
A bomb from the air attack ([GearTypes#gtAirAttack `gtAirAttack`]) or the RC plane ([GearTypes#gtRCPlane `gtRCPlane`]).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   501
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   502
 * `Boom`: Explosion size and damage. Default: 30
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   503
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   504
==== `gtBall` ====
849
5d3313b18318 GearTypes: fix typo in ballgun link
Wuzzy
parents: 848
diff changeset
   505
A ball from the ball gun ([GearTypes#gtBallGun `gtBallGun`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   506
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   507
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   508
 * `Boom`: Explosion size and damage. Default: 40
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   509
 * `Tag`: Color: `0`=red, `1`=green, `2`=cyan, `3`=yellow, `4`=violet, `5`=pink, `6`=orange, `7`=lime, `8`=white
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   510
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   511
==== `gtCluster` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   512
A cluster from the cluster bomb ([GearTypes#gtClusterBomb `gtClusterBomb`]) or the mortar ([GearTypes#gtMortar `gtMortar`]).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   513
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   514
 * `Boom`: Explosion size and damage. Default: 25
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   515
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   516
==== `gtEgg` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   517
An egg from Birdy ([GearTypes#gtBirdy `gtBirdy`])
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   518
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   519
 * `Boom`: Size of destroyed land and damage. Default: 10
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   520
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   521
==== `gtHammerHit` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   522
Created when a hammer hit something. This gear will dig into the ground. See also [GearTypes#gtHammer `gtHammer`] for hammer damage.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   523
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   524
 * `Timer`: How deep a successful hammer hit dig into land. 1 is the smallest possible depth. Using the value 0 will dig all the way to the water. Default: 125.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   525
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   526
==== `gtMelonPiece` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   527
A cluster from a watermelon bomb ([GearTypes#gtWatermelon `gtWatermelon`])
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   528
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   529
 * `Boom`: Explosion size and damage. Default: 75
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   530
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   531
==== `gtNapalmBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   532
A bomb from napalmn ([GearTypes#gtAirAttack `gtAirAttack`]), will burst into fire.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   533
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   534
 * `Timer`: Detonation timer (in milliseconds). Default: 1000
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   535
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   536
==== `gtPoisonCloud` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   537
A poisonous cloud, makes hedgehogs sick on contact. Is normally created by [GearTypes#gtGasBomb `gtGasBomb`].
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   538
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   539
 * `Timer`: Remaining “life time” in milliseconds (default: 5000). Note that the current animation does not very well support timers larger than 5 seconds, and the animation is partly hardcoded.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   540
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   541
=== Other ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   542
Gears which don't fit into any other category.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   543
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   544
==== `gtAddAmmo` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   545
Used to add some weapon or utilty to a hedgehog. The gear is added when a crate ([GearTypes#gtCase `gtCase`]) has been collected.
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   546
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   547
==== `gtATStartGame` ====
777
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   548
This gear is created to mark the beginning of the game. It will cause a ticker message to be displayed (“Let's fight!”) and sets some internal stuff.
607
dde757edd995 Rope style
Wuzzy
parents: 606
diff changeset
   549
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   550
==== `gtATFinishGame` ====
778
edd98bc89d83 GearTypes: EndGame
Wuzzy
parents: 777
diff changeset
   551
This gear is created at the end of the game. The gear itself will fade out the screen and cause the game to be closed. Note: If you want to end the game early, we recommend to call the `EndGame` function instad of using this gear.
777
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   552
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   553
 * `Timer`: Fade-out countdown in milliseconds. Fade-out begins at 1000 and finishes at 0.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   554
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   555
==== `gtGenericFaller` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   556
TODO. The purpose of this gear is not clear yet.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   557
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   558
==== `gtWaterUp` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   559
Causes the water to rise.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   560
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   561
`Tag` contains the number of pixels the water still has to rise (default: 47). The gear will be removed when its `Tag` reaches the value 0.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   562
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   563
== Reference ==
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   564
For a current list of the gears look at `hedgewars/uTypes.pas` at
700
d1c283423e5c Linkify
Wuzzy
parents: 699
diff changeset
   565
the `TGearType` enumeration:
852
efcc0feef9ec GearTypes: Remove historic note from the stone age of Hedgewars
Wuzzy
parents: 851
diff changeset
   566
[https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l92]