GearTypes.wiki
author Wuzzy
Fri, 25 Mar 2016 11:48:33 +0000
changeset 799 e2c96c00f9f3
parent 798 30c5f1ebd552
child 817 5d23638ba8b8
permissions -rw-r--r--
TODO: Fix external Qt documentation link
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* ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    20
|| `gtCase` || An ammo, utility or health crate ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    21
|| `gtExplosives` || An explosive barrel ||
712
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
    22
|| `gtFlake` || A snowflake or a land spray flake ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    23
|| `gtFlame` || A flame ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    24
|| `gtGrave` || A grave ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    25
|| `gtHedgehog` || A hedgehog ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    26
|| `gtPortal` || 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
    27
|| `gtTarget` || A target ||
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* ||
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
    31
|| `gtGirder` || An attempt to place a construction or rubber ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    32
|| `gtJetpack` || A flying saucer ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    33
|| `gtLandGun` || The land spray tool ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    34
|| `gtParachute` || A parachute ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    35
|| `gtResurrector` || Resurrection ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    36
|| `gtRope` || A rope ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    37
|| `gtSwitcher` || Switch hedgehog ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    38
|| `gtTardis` || A !TimeBox ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    39
|| `gtTeleport` || Teleportation ||
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* ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    43
|| `gtAirAttack` || The airplane of an airborne attack ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    44
|| `gtAirMine` || An air mine ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    45
|| `gtBallGun` || A ballgun ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    46
|| `gtBee` || Homing bee ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    47
|| `gtBirdy` || Birdy ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    48
|| `gtBlowTorch` || A blowtorch ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    49
|| `gtClusterBomb` || A cluster bomb ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    50
|| `gtCake` || A cake ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    51
|| `gtDEagleShot` || A shot from a Desert Eagle ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    52
|| `gtDrill` || Drill rocket ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    53
|| `gtDynamite` || A dynamite ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    54
|| `gtFirePunch` || Shoryuken ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    55
|| `gtFlamethrower` || A flamethrower ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    56
|| `gtGasBomb` || An old limburger ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    57
|| `gtGrenade` || A grenade ||
791
4d6610c3e9a3 GearTypes: clarify gtHammer and gtHammerHit
Wuzzy
parents: 789
diff changeset
    58
|| `gtHammer` || A gear dealing hammer damage ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    59
|| `gtHellishBomb` || A hellish hand-grenade ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    60
|| `gtIceGun` || A freezer ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    61
|| `gtKamikaze` || An ongoing kamikaze ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    62
|| `gtKnife` || A cleaver ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    63
|| `gtPiano` || Piano from piano strike ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    64
|| `gtPickHammer` || A pickhammer ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    65
|| `gtRCPlane` || A RC plane ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    66
|| `gtMolotov` || A molotov cocktail ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    67
|| `gtMortar` || A mortar ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    68
|| `gtMine` || A mine ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    69
|| `gtSeduction` || Seduction ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    70
|| `gtShell` || A bazooka shell (projectile) ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    71
|| `gtShotgunShot` || A shot from a shotgun ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    72
|| `gtShover` || Used by baseball bat. ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    73
|| `gtSineGunShot` || A shot from the sine gun ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    74
|| `gtSMine` || A sticky mine ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    75
|| `gtSniperRifleShot` || A shot from the sniper rifle ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    76
|| `gtSnowball` || A mudball ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    77
|| `gtWatermelon` || A watermelon bomb, still intact ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    78
|| `gtWhip` || A whip ||
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* ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    82
|| `gtAirBomb` || A bomb from the air attack or the RC plane ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    83
|| `gtBall` || A ball from the ball gun || 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    84
|| `gtCluster` || A cluster from the cluster bomb or the mortar ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    85
|| `gtEgg` || An egg from Birdy ||
791
4d6610c3e9a3 GearTypes: clarify gtHammer and gtHammerHit
Wuzzy
parents: 789
diff changeset
    86
|| `gtHammerHit` || A hammer digging into land ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    87
|| `gtMelonPiece` || A cluster from a watermelon bomb ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    88
|| `gtNapalmBomb` || A bomb from the napalmn strike ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    89
|| `gtPoisonCloud` || A poisonous cloud ||
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* ||
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    93
|| `gtAddAmmo` || Adds a weapon or utilty to a hedgehog. ||
777
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
    94
|| `gtATStartGame` || Created at the start of the game.  ||
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
    95
|| `gtATFinishGame` || Created at the end of the game. Fades out the screen and exits the game. || 
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    96
|| `gtGenericFaller` || TODO || 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    97
|| `gtWaterUp` || Causes water to rise. ||
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` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   109
An ammo, utility or health crate.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   110
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   111
 * `Pos`: Crate type: 1=ammo crate, 2=health crate, 4=utility crate
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   112
 * `Tag`: Used for the appear animation
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   113
 * `Health`: Amount of health contained in a health crate
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   114
 * `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
   115
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   116
==== `gtExplosives` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   117
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
   118
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   119
 * `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
   120
 * `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
   121
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   122
==== `gtFlake` ====
712
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   123
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 (`gtLandSpray`).
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   124
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   125
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
   126
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   127
==== `gtFlame` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   128
A single flame.
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   129
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
   130
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   131
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
   132
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   133
 * `Tag`: Current animation frame (0-32)
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   134
 * `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
   135
 * `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.
709
1a6139c016d9 gtFlame: Boom clarification
Wuzzy
parents: 708
diff changeset
   136
 * `Boom`: Damage and size of destroyed land (default: 2). Larger flames can cause more damage and destroy more land (three or four times as much)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   137
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   138
==== `gtGrave` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   139
A grave from a dead hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   140
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   141
 * `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
   142
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   143
==== `gtHedgehog` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   144
A hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   145
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   146
Basic attributes are:
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   147
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   148
 * `Health`: Hedgehog's health.
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   149
 * `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   150
 * `Radius`: Collision radius. Default: 9
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   151
 * `Boom`: Explosion size and damage caused when the hedgehog dies (default: 30)
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   152
 * `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
   153
782
0fba851eb618 GearTypes: cleanup gtHedgehog
Wuzzy
parents: 781
diff changeset
   154
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
   155
782
0fba851eb618 GearTypes: cleanup gtHedgehog
Wuzzy
parents: 781
diff changeset
   156
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
   157
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   158
==== `gtPortal` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   159
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
   160
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   161
 * `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
   162
 * `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
   163
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   164
==== `gtTarget` ====
710
580a83691524 Explain gtTarget
Wuzzy
parents: 709
diff changeset
   165
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
   166
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   167
=== Utilities ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   168
The gears used by various utilities.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   169
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   170
==== `gtGirder` ====
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   171
This gear is created when a player tried to place construction or rubber somewhere which may or may not have been successful.
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   172
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   173
 * `State`: Orientation and size coded as a number. See Lua API documentation on `onGirderPlacement` or `onRubberPlacement` for the meaning of the number
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   174
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   175
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
   176
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   177
==== `gtJetpack` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   178
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
   179
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   180
 * `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
   181
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   182
==== `gtLandGun` ====
712
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   183
The land spray tool. Creates `gtFlake` gears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   184
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   185
 * `Tag`: Spitting power of land spray (`5`-`20`).
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   186
 * `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
   187
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   188
==== `gtParachute` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   189
A parachute.
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
==== `gtResurrector` ==== 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   192
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
   193
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   194
 * `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
   195
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   196
==== `gtRope` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   197
A rope.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   198
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   199
 * `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
   200
 * `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
   201
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   202
==== `gtSwitcher` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   203
Switch hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   204
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   205
==== `gtTardis` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   206
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
   207
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   208
 * `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
   209
 * `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
   210
 * `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
   211
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   212
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
   213
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   214
==== `gtTeleport` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   215
Teleportation.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   216
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   217
=== Weapons and main projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   218
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
   219
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   220
==== `gtAirAttack` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   221
The airplane of an airborne attack. It can drop either missiles (`gtAirBomb`), mines (`gtMine`), napalm missiles (`gtNapalmBomb`) or drill rockets (`gtDrill`)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   222
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   223
 * `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
   224
 * `Tag`: Direction of airplane: `-1` = left, `1` = right
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   225
 * `Health`: Number of bombs/mines/drills left (default: 6)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   226
 * `Damage`: Distance (in pixels) between two dropped bombs/mines/drills (default: 30)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   227
 * `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
   228
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   229
==== `gtAirMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   230
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
   231
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   232
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
   233
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   234
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
   235
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
   236
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   237
 * `Pos`: Air friction. Higher values mean slower movement. 
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   238
 * `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
   239
 * `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.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   240
 * `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. Default: 175
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   241
 * `Power`: Speed in which it seeks and follows hedgehogs.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   242
 * `Karma`: Explosion size and damage (in 0.9.22). Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   243
 * `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
   244
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   245
==== `gtBallGun` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   246
A ballgun. It throws 51 balls (`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
   247
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   248
 * `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
   249
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   250
==== `gtBee` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   251
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
   252
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   253
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
   254
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
   255
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   256
 * `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
   257
 * `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
   258
 * `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
   259
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   260
==== `gtBirdy` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   261
Birdy. Transports hogs and can drop eggs (`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
   262
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   263
 * `Tag`: Facing direction (`-1` = left, `1` = right)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   264
 * `Health`: “Flapping energy” left, default is 2000
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   265
 * `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
   266
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   267
==== `gtBlowTorch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   268
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
   269
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   270
 * `Timer`: Remaining usage time in ms, default is 7500.
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   271
 * `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
   272
 * `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
   273
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   274
==== `gtClusterBomb` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   275
A cluster bomb. Spawns several `gtCluster` gears on detonation.
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   276
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   277
 * `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
   278
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   279
==== `gtCake` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   280
A cake. 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   281
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   282
 * `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
   283
 * `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
   284
 * `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
   285
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   286
==== `gtDEagleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   287
A shot from a Desert Eagle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   288
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   289
 * `Health`: How deep the bullet digs into land. Default: 50.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   290
 * `Boom`: Damage. Default: 7
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   291
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   292
==== `gtDrill` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   293
A drill rocket. This is either a launched drill rocket or a small drill rocket from the drill strike (which is a bit weaker than the launched one).
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   294
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   295
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
   296
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   297
 * `Tag`: Used for drill strike. If `1`, then first impact occoured already.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   298
 * `Timer`: Detonation timer (in ms)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   299
 * `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
   300
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   301
==== `gtDynamite` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   302
A dynamite.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   303
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
   304
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   305
 * `Tag`: Displayed animation frame.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   306
 * `Timer`: Detonation timer (in ms). Default: 5000.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   307
 * `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
   308
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   309
==== `gtFirePunch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   310
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
   311
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   312
 * `Tag`: Current Y coordinate of the hedgehog.
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   313
 * `Radius`: Hit radius. Default: 15
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   314
 * `Boom`: Damage. Default: 30
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
==== `gtFlamethrower` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   317
A flamethrower. 
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
 * `Tag`: Current spitting power of flamethrower (`5`-`20`)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   320
 * `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
   321
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   322
==== `gtGasBomb` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   323
An old limburger. Will spawn several `gtPoisonCloud` gears on detonation.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   324
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   325
 * `Timer`: Detonation timer (in milliseconds).
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   326
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   327
==== `gtGrenade` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   328
A grenade.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   329
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   330
 * `Timer`: Detonation timer (in milliseconds).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   331
 * `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
   332
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   333
==== `gtHammer` ====
792
dfb7a269d70b GearTypes: gtHammer radius
Wuzzy
parents: 791
diff changeset
   334
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 `gtHammerHit` for the digging part.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   335
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   336
 * `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
   337
 * `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
   338
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   339
==== `gtHellishBomb` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   340
A hellish hand-grenade.
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
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   343
 * `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
   344
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   345
==== `gtIceGun` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   346
A freezer.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   347
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   348
 * `Health`: Remaining fuel. `1000` is for 100% fuel
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   349
 * `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
   350
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   351
==== `gtKamikaze` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   352
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
   353
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   354
 * `Health`: Remaining travel range. Default: 2048
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   355
 * `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
   356
 * `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
   357
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   358
==== `gtKnife` ====
789
6693fdfb6876 GearTypes: cleaver damage
Wuzzy
parents: 788
diff changeset
   359
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
   360
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   361
 * `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
   362
 * `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
   363
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   364
==== `gtPiano` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   365
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
   366
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   367
 * `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
   368
 * `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
   369
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   370
==== `gtPickHammer` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   371
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
   372
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   373
 * `Timer`: Remaining usage time (in milliseconds). Default: 4000
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   374
 * `Radius`: Width of dug land. Default: 10
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   375
 * `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
   376
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   377
==== `gtRCPlane` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   378
An RC plane. It can drop missiles (`gtAirBomb`).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   379
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   380
 * `Tag`: dX speed??? (The purpose of the `Tag` is not clear yet)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   381
 * `Timer`: Remaining fly time (in milliseconds). Default: 15000
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   382
 * `Health`: Number of missiles on board. Default: 3
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   383
 * `Tint`: RGBA color of RC plane (default: clan color)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   384
 * `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
   385
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   386
==== `gtMolotov` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   387
A molotov cocktail. Creates several flames (`gtFlame`) on impact.
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
==== `gtMortar` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   390
A mortar. On impact it spawns a few `gtCluster` gears.
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   391
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   392
 * `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
   393
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   394
==== `gtMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   395
A land mine.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   396
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   397
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
   398
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
   399
788
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   400
 * `Timer`: Detonation timer (after activation). The initial value depends on the game settings.
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   401
 * `Health`: If `0`, mine is a dud, otherwise it is not a dud or has not been triggered yet.
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   402
 * `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` reaches 35 or higher.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   403
 * `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
   404
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   405
==== `gtSeduction` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   406
A hedgehog trying to seduce others.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   407
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   408
 * `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
   409
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   410
==== `gtShell` ====
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   411
 A bazooka shell (projectile).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   412
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   413
 * `FlightTime`: Time since the bazooka has been launched
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   414
 * `Boom`: Explosion size and damage. Default: 50
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   415
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   416
==== `gtShotgunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   417
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
   418
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   419
 * `Boom`: Damage. Default: 25
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   420
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   421
==== `gtShover` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   422
Used by baseball bat.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   423
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   424
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   425
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   426
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   427
==== `gtSineGunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   428
A shot from the sine gun.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   429
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   430
 * `Radius`: The thickness of the sine gun shot.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   431
 * `Boom`: Damage. Default: 35
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   432
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   433
==== `gtSMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   434
A sticky mine.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   435
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   436
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
   437
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   438
 * `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
   439
 * `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
   440
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   441
==== `gtSniperRifleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   442
A shot from the sniper rifle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   443
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   444
 * `Health`: How deep the bullet digs into land. Default: 50
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   445
 * `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
   446
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   447
==== `gtSnowball` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   448
A mudball.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   449
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   450
 * `Boom`: Pushing power (just an arbitrary value for scaling). Default: 200000
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   451
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   452
==== `gtWatermelon` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   453
A watermelon bomb, still intact. It spawns several `gtMelonPiece` gears when it explodes.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   454
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   455
 * `Timer`: Detonation timer (in milliseconds).
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   456
 * `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
   457
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   458
==== `gtWhip` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   459
A whip.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   460
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   461
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   462
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   463
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   464
=== Secondary projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   465
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
   466
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   467
==== `gtAirBomb` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   468
A bomb from the air attack (`gtAirAttack`) or the RC plane (`gtRCPlane`).
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   469
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   470
 * `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
   471
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   472
==== `gtBall` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   473
A ball from the ball gun (`gtBallgun`).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   474
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   475
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   476
 * `Boom`: Explosion size and damage. Default: 40
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   477
 * `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
   478
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   479
==== `gtCluster` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   480
A cluster from the cluster bomb (`gtClusterBomb`) or the mortar (`gtMortar`).
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   481
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   482
 * `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
   483
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   484
==== `gtEgg` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   485
An egg from Birdy (`gtBirdy`)
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   486
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   487
 * `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
   488
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   489
==== `gtHammerHit` ====
791
4d6610c3e9a3 GearTypes: clarify gtHammer and gtHammerHit
Wuzzy
parents: 789
diff changeset
   490
Created when a hammer hit something. This gear will dig into the ground. See also `gtHammer` for hammer damage.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   491
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   492
 * `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
   493
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   494
==== `gtMelonPiece` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   495
A cluster from a watermelon bomb (`gtWatermelon`)
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   496
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   497
 * `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
   498
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   499
==== `gtNapalmBomb` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   500
A bomb from the napalmn strike (`gtAirAttack`), will burst into fire.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   501
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   502
 * `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
   503
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   504
==== `gtPoisonCloud` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   505
A poisonous cloud, makes hedgehogs sick on contact. Is normally created by `gtGasBomb`.
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`: 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
   508
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   509
=== Other ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   510
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
   511
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   512
==== `gtAddAmmo` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   513
Used to add some weapon or utilty to a hedgehog. The gear is added when a crate (`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
   514
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   515
==== `gtATStartGame` ====
777
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   516
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
   517
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   518
==== `gtATFinishGame` ====
778
edd98bc89d83 GearTypes: EndGame
Wuzzy
parents: 777
diff changeset
   519
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
   520
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   521
 * `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
   522
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   523
==== `gtGenericFaller` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   524
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
   525
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   526
==== `gtWaterUp` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   527
Causes the water to rise.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   528
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   529
`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
   530
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   531
== Reference ==
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   532
For a current list of the gears look at `hedgewars/uTypes.pas` at
700
d1c283423e5c Linkify
Wuzzy
parents: 699
diff changeset
   533
the `TGearType` enumeration:
798
30c5f1ebd552 global replace of http with https for hedgewars.org wiki links
nemo
parents: 796
diff changeset
   534
[https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l92]
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   535
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   536
Note: `gtBomb` and `gtShell` were named `gtAmmo_Bomb` and `gtAmmo_Grenade` before 0.9.14.