hwkb: comparison GearTypes.wiki

equal deleted inserted replaced

-:19f1fe382e5f
+:60505ed50289
 This is a short overview and a brief description of all gears.
 === Land objects ===
 || *Gear type* || *Description* ||
 || [GearTypes#gtCase `gtCase`] || An ammo, utility or health crate ||
-|| `gtExplosives` || An explosive barrel ||
+|| [GearTypes#gtExplosives `gtExplosives`] || An explosive barrel ||
-|| `gtFlake` || A snowflake or a land spray flake ||
+|| [GearTypes#gtFlake `gtFlake`] || A snowflake or a land spray flake ||
-|| `gtFlame` || A flame ||
+|| [GearTypes#gtFlame `gtFlame`] || A flame ||
-|| `gtGrave` || A grave ||
+|| [GearTypes#gtGrave `gtGrave`] || A grave ||
-|| `gtHedgehog` || A hedgehog ||
+|| [GearTypes#gtHedgehog `gtHedgehog`] || A hedgehog ||
-|| `gtPortal` || A portal from the portable portal device ||
+|| [GearTypes#gtPortal `gtPortal`] || A portal from the portable portal device ||
-|| `gtTarget` || A target ||
+|| [GearTypes#gtTarget `gtTarget`] || A target ||
 === Utilities ===
 || *Gear type* || *Description* ||
-|| `gtGirder` || An attempt to place a construction or rubber ||
+|| [GearTypes#gtGirder `gtGirder`] || An attempt to place a construction or rubber ||
-|| `gtJetpack` || A flying saucer ||
+|| [GearTypes#gtJetpack `gtJetpack`] || A flying saucer ||
-|| `gtLandGun` || The land spray tool ||
+|| [GearTypes#gtLandGun `gtLandGun`] || The land spray tool ||
-|| `gtParachute` || A parachute ||
+|| [GearTypes#gtParachute `gtParachute` || A parachute ||
-|| `gtResurrector` || Resurrection ||
+|| [GearTypes#gtResurrector `gtResurrector`] || Resurrection ||
-|| `gtRope` || A rope ||
+|| [GearTypes#gtRope `gtRope`] || A rope ||
-|| `gtSwitcher` || Switch hedgehog ||
+|| [GearTypes#gtSwitcher `gtSwitcher`] || Switch hedgehog ||
-|| `gtTardis` || A !TimeBox ||
+|| [GearTypes#gtTardis `gtTardis`] || A !TimeBox ||
-|| `gtTeleport` || Teleportation ||
+|| [GearTypes#gtTeleport `gtTeleport`] || Teleportation ||
 === Weapons and main projectiles ===
 || *Gear type* || *Description* ||
-|| `gtAirAttack` || The airplane of an airborne attack ||
+|| [GearTypes#gtAirAttack `gtAirAttack`] || The airplane of an airborne attack ||
-|| `gtAirMine` || An air mine ||
+|| [GearTypes#gtAirMine `gtAirMine`] || An air mine ||
-|| `gtBallGun` || A ballgun ||
+|| [GearTypes#gtBallGun `gtBallGun`] || A ballgun ||
-|| `gtBee` || Homing bee ||
+|| [GearTypes#gtBee `gtBee`] || Homing bee ||
-|| `gtBirdy` || Birdy ||
+|| [GearTypes#gtBirdy `gtBirdy`] || Birdy ||
-|| `gtBlowTorch` || A blowtorch ||
+|| [GearTypes#gtBlowTorch `gtBlowTorch`] || A blowtorch ||
-|| `gtClusterBomb` || A cluster bomb ||
+|| [GearTypes#gtClusterBomb `gtClusterBomb`] || A cluster bomb ||
-|| `gtCake` || A cake ||
+|| [GearTypes#gtCake `gtCake`] || A cake ||
-|| `gtDEagleShot` || A shot from a Desert Eagle ||
+|| [GearTypes#gtDEagleShot `gtDEagleShot`] || A shot from a Desert Eagle ||
-|| `gtDrill` || Drill rocket ||
+|| [GearTypes#gtDrill `gtDrill`] || Drill rocket ||
-|| `gtDynamite` || A dynamite ||
+|| [GearTypes#gtDynamite `gtDynamite`] || A dynamite ||
-|| `gtFirePunch` || Shoryuken ||
+|| [GearTypes#gtFirePunch `gtFirePunch`] || Shoryuken ||
-|| `gtFlamethrower` || A flamethrower ||
+|| [GearTypes#gtFlamethrower `gtFlamethrower`] || A flamethrower ||
-|| `gtGasBomb` || An old limburger ||
+|| [GearTypes#gtGasBomb `gtGasBomb`] || An old limburger ||
-|| `gtGrenade` || A grenade ||
+|| [GearTypes#gtGrenade `gtGrenade`] || A grenade ||
-|| `gtHammer` || A gear dealing hammer damage ||
+|| [GearTypes#gtHammer `gtHammer`] || A gear dealing hammer damage ||
-|| `gtHellishBomb` || A hellish hand-grenade ||
+|| [GearTypes#gtHellishBomb `gtHellishBomb`] || A hellish hand-grenade ||
-|| `gtIceGun` || A freezer ||
+|| [GearTypes#gtIceGun `gtIceGun`] || A freezer ||
-|| `gtKamikaze` || An ongoing kamikaze ||
+|| [GearTypes#gtKamikaze `gtKamikaze`] || An ongoing kamikaze ||
-|| `gtKnife` || A cleaver ||
+|| [GearTypes#gtKnife `gtKnife`] || A cleaver ||
-|| `gtPiano` || Piano from piano strike ||
+|| [GearTypes#gtPiano `gtPiano`] || Piano from piano strike ||
-|| `gtPickHammer` || A pickhammer ||
+|| [GearTypes#gtPickHammer `gtPickHammer`] || A pickhammer ||
-|| `gtRCPlane` || A RC plane ||
+|| [GearTypes#gtRCPlane `gtRCPlane`] || A RC plane ||
-|| `gtMolotov` || A molotov cocktail ||
+|| [GearTypes#gtMolotov `gtMolotov`] || A molotov cocktail ||
-|| `gtMortar` || A mortar ||
+|| [GearTypes#gtMortar `gtMortar`] || A mortar ||
-|| `gtMine` || A mine ||
+|| [GearTypes#gtMine `gtMine`] || A mine ||
-|| `gtSeduction` || Seduction ||
+|| [GearTypes#gtSeduction `gtSeduction`] || Seduction ||
-|| `gtShell` || A bazooka shell (projectile) ||
+|| [GearTypes#gtShell `gtShell`] || A bazooka shell (projectile) ||
-|| `gtShotgunShot` || A shot from a shotgun ||
+|| [GearTypes#gtShotgunShot `gtShotgunShot`] || A shot from a shotgun ||
-|| `gtShover` || Used by baseball bat. ||
+|| [GearTypes#gtShover `gtShover`] || Used by baseball bat ||
-|| `gtSineGunShot` || A shot from the sine gun ||
+|| [GearTypes#gtSineGunShot `gtSineGunShot`] || A shot from the sine gun ||
-|| `gtSMine` || A sticky mine ||
+|| [GearTypes#gtSMine `gtSMine`] || A sticky mine ||
-|| `gtSniperRifleShot` || A shot from the sniper rifle ||
+|| [GearTypes#gtSniperRifleShot `gtSniperRifleShot`] || A shot from the sniper rifle ||
-|| `gtSnowball` || A mudball ||
+|| [GearTypes#gtSnowball `gtSnowball`] || A mudball ||
-|| `gtWatermelon` || A watermelon bomb, still intact ||
+|| [GearTypes#gtWatermelon `gtWatermelon`] || A watermelon bomb, still intact ||
-|| `gtWhip` || A whip ||
+|| [GearTypes#gtWhip `gtWhip`] || A whip ||
 === Secondary projectiles ===
 || *Gear type* || *Description* ||
-|| `gtAirBomb` || A bomb from the air attack or the RC plane ||
+|| [GearTypes#gtAirBomb `gtAirBomb`] || A bomb from the air attack or the RC plane ||
-|| `gtBall` || A ball from the ball gun ||
+|| [GearTypes#gtBall `gtBall`] || A ball from the ball gun ||
-|| `gtCluster` || A cluster from the cluster bomb or the mortar ||
+|| [GearTypes#gtCluster `gtCluster`] || A cluster from the cluster bomb or the mortar ||
-|| `gtEgg` || An egg from Birdy ||
+|| [GearTypes#gtEgg `gtEgg`] || An egg from Birdy ||
-|| `gtHammerHit` || A hammer digging into land ||
+|| [GearTypes#gtHammerHit `gtHammerHit`] || A hammer digging into land ||
-|| `gtMelonPiece` || A cluster from a watermelon bomb ||
+|| [GearTypes#gtMelonPiece `gtMelonPiece`] || A cluster from a watermelon bomb ||
-|| `gtNapalmBomb` || A bomb from the napalmn strike ||
+|| [GearTypes#gtNapalmBomb `gtNapalmBomb`] || A bomb from the napalmn strike ||
-|| `gtPoisonCloud` || A poisonous cloud ||
+|| [GearTypes#gtPoisonCloud `gtPoisonCloud`] || A poisonous cloud ||
 === Other ===
 || *Gear type* || *Description* ||
-|| `gtAddAmmo` || Adds a weapon or utilty to a hedgehog. ||
+|| [GearTypes#gtAddAmmo `gtAddAmmo`] || Adds a weapon or utilty to a hedgehog. ||
-|| `gtATStartGame` || Created at the start of the game.  ||
+|| [GearTypes#gtATStartGame `gtATStartGame`] || Created at the start of the game.  ||
-|| `gtATFinishGame` || Created at the end of the game. Fades out the screen and exits the game. ||
+|| [GearTypes#gtATFinishGame `gtATFinishGame`] || Created at the end of the game. Fades out the screen and exits the game. ||
-|| `gtGenericFaller` || TODO ||
+|| [GearTypes#gtGenericFaller `gtGenericFaller`] || TODO ||
-|| `gtWaterUp` || Causes water to rise. ||
+|| [GearTypes#gtWaterUp `gtWaterUp`] || Causes water to rise. ||
 == Long descriptions and values ==
 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.
 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.
 * `Health`: “health” of the barrel: Starts at 60, explodes at 0.
 * `Boom`: Explosion size and damage (default: 75)
 ==== `gtFlake` ====
-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`).
+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#gtLandSpray `gtLandSpray`]).
 If the gear state flag `gsttmpFlag` is set, it is a flake from a land spray, otherwise, it is a snowflake.
 ==== `gtFlame` ====
 A single flame.
 === Utilities ===
 The gears used by various utilities.
 ==== `gtGirder` ====
-This gear is created when a player tried to place construction or rubber somewhere which may or may not have been successful.
+This gear is created when a player tried to place construction or rubber somewhere. Placement may or may not have been successful.
-* `State`: Orientation and size coded as a number. See Lua API documentation on `onGirderPlacement` or `onRubberPlacement` for the meaning of the number
+* `State`: Orientation and size coded as a number. See Lua API documentation on `onGirderPlacement` or `onRubberPlacement` for the meaning of the number.
 If you expect a successful placement including information regarding building type, position and orientation, use the functions `onGirderPlacement` and `onRubberPlacement`, respectively.
 ==== `gtJetpack` ====
 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.
 * `Health`: Amount of remaining fuel. `2000` denotes 100% fuel.
 ==== `gtLandGun` ====
-The land spray tool. Creates `gtFlake` gears.
+The land spray tool. Creates [GearTypes#gtFlake `gtFlake`] gears.
 * `Tag`: Spitting power of land spray (`5`-`20`).
 * `Health`: Amount of fuel. `1000` denotes 100% fuel.
 ==== `gtParachute` ====
 === Weapons and main projectiles ===
 Gears of weapons which can be directly used or launched by the players.
 ==== `gtAirAttack` ====
-The airplane of an airborne attack. It can drop either missiles (`gtAirBomb`), mines (`gtMine`), napalm missiles (`gtNapalmBomb`) or drill rockets (`gtDrill`)
+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`])
 * `Pos`: Type of airborne attack: `0` = Air Attack, `1` = Mine Strike, `2` = Napalm, `3` = Drill Strike
 * `Tag`: Direction of airplane: `-1` = left, `1` = right
 * `Health`: Number of bombs/mines/drills left (default: 6)
 * `Damage`: Distance (in pixels) between two dropped bombs/mines/drills (default: 30)
 * `Power`: Speed in which it seeks and follows hedgehogs.
 * `Karma`: Explosion size and damage (in 0.9.22). Default: 30
 * `Boom`: Explosion size and damage (in 0.9.23). Default: 25
 ==== `gtBallGun` ====
-A ballgun. It throws 51 balls (`gtBall`) by default. This weapon is timer-based.
+A ballgun. It throws 51 balls ([GearTypes#gtBall `gtBall`]) by default. This weapon is timer-based.
 * `Timer`: Remaining usage time (in ms), default is 5001. One ball is fired every 100ms.
 ==== `gtBee` ====
 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`.
 * `Tag`: Whether the bee is underwater (`0` = no, `1` = yes). This is used for the sound effect.
 * `Timer`: Remaining time (in milliseconds) either of the pre-homing phase or the homing phase.
 * `Boom`: Explosion size and damage. Default: 50
 ==== `gtBirdy` ====
-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.
+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.
 * `Tag`: Facing direction (`-1` = left, `1` = right)
 * `Health`: “Flapping energy” left, default is 2000
 * `FlightTime`: Number of eggs left (default: 2)
 * `Timer`: Remaining usage time in ms, default is 7500.
 * `Radius`: Hit radius. Things inside this radius will be hit. Default: 15
 * `Boom`: Damage caused when burning a hedgehog or an object. Default: 2
 ==== `gtClusterBomb` ====
-A cluster bomb. Spawns several `gtCluster` gears on detonation.
+A cluster bomb. Spawns several [GearTypes#gtCluster `gtCluster`] gears on detonation.
 * `Boom`: Explosion size and damage. Default: 20
 ==== `gtCake` ====
 A cake.
 * `Tag`: Current Y coordinate of the hedgehog.
 * `Radius`: Hit radius. Default: 15
 * `Boom`: Damage. Default: 30
 ==== `gtFlamethrower` ====
-A flamethrower.
+A flamethrower creates both sticky and non-sticky [GearTypes#gtFlame `gtFlame`] gears.
 * `Tag`: Current spitting power of flamethrower (`5`-`20`)
 * `Health`: Remaining fuel. `500` is for 100% fuel.
 ==== `gtGasBomb` ====
-An old limburger. Will spawn several `gtPoisonCloud` gears on detonation.
+An old limburger. Will spawn several [GearTypes#gtPoisonCloud `gtPoisonCloud`] gears on detonation.
 * `Timer`: Detonation timer (in milliseconds).
 ==== `gtGrenade` ====
 A grenade.
 * `Timer`: Detonation timer (in milliseconds).
 * `Boom`: Explosion size and damage. Default: 50
 ==== `gtHammer` ====
-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.
+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.
 * `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)
 * `Radius`: Stuff inside this radius will be hit and be subject to hammer damage and digging. Default: 20
 ==== `gtHellishBomb` ====
-A hellish hand-grenade.
+A hellish hand-grenade. It creates several sticky and non-sticky flames ([GearTypes#gtFlame `gtFlame`) on detonation.
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
 * `Boom`: Explosion size and damage. Default: 90
 ==== `gtIceGun` ====
 * `Timer`: Remaining usage time (in milliseconds). Default: 4000
 * `Radius`: Width of dug land. Default: 10
 * `Boom`: Damage per hit. Default: 6
 ==== `gtRCPlane` ====
-An RC plane. It can drop missiles (`gtAirBomb`).
+An RC plane. It can drop missiles ([GearTypes#gtAirBomb `gtAirBomb`]).
 * `Tag`: dX speed??? (The purpose of the `Tag` is not clear yet)
 * `Timer`: Remaining fly time (in milliseconds). Default: 15000
 * `Health`: Number of missiles on board. Default: 3
 * `Tint`: RGBA color of RC plane (default: clan color)
 * `Boom`: Explosion size and damage when the RC plane crashes. Default: 25
 ==== `gtMolotov` ====
-A molotov cocktail. Creates several flames (`gtFlame`) on impact.
+A molotov cocktail. Creates several flames ([GearTypes#gtFlame `gtFlame`]) on impact.
 ==== `gtMortar` ====
-A mortar. On impact it spawns a few `gtCluster` gears.
+A mortar. On impact it spawns a few [GearTypes#gtCluster `gtCluster`] gears.
 * `Boom`: Explosion size and damage of the main mortar projectile only. Default: 20
 ==== `gtMine` ====
 A land mine.
 A mudball.
 * `Boom`: Pushing power (just an arbitrary value for scaling). Default: 200000
 ==== `gtWatermelon` ====
-A watermelon bomb, still intact. It spawns several `gtMelonPiece` gears when it explodes.
+A watermelon bomb, still intact. It spawns several [GearTypes#gtMelonPiece `gtMelonPiece`] gears when it explodes.
 * `Timer`: Detonation timer (in milliseconds).
 * `Boom`: Explosion size and damage. Default: 75
 ==== `gtWhip` ====
 === Secondary projectiles ===
 Gears for projectiles that can’t be directly fired but are generated by other weapon gears.
 ==== `gtAirBomb` ====
-A bomb from the air attack (`gtAirAttack`) or the RC plane (`gtRCPlane`).
+A bomb from the air attack ([GearTypes#gtAirAttack `gtAirAttack`]) or the RC plane ([GearTypes#gtRCPlane `gtRCPlane`]).
 * `Boom`: Explosion size and damage. Default: 30
 ==== `gtBall` ====
-A ball from the ball gun (`gtBallgun`).
+A ball from the ball gun ([GearTypes#gtBallgun `gtBallgun`]).
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
 * `Boom`: Explosion size and damage. Default: 40
 * `Tag`: Color: `0`=red, `1`=green, `2`=cyan, `3`=yellow, `4`=violet, `5`=pink, `6`=orange, `7`=lime, `8`=white
 ==== `gtCluster` ====
-A cluster from the cluster bomb (`gtClusterBomb`) or the mortar (`gtMortar`).
+A cluster from the cluster bomb ([GearTypes#gtClusterBomb `gtClusterBomb`]) or the mortar ([GearTypes#gtMortar `gtMortar`]).
 * `Boom`: Explosion size and damage. Default: 25
 ==== `gtEgg` ====
-An egg from Birdy (`gtBirdy`)
+An egg from Birdy ([GearTypes#gtBirdy `gtBirdy`])
 * `Boom`: Size of destroyed land and damage. Default: 10
 ==== `gtHammerHit` ====
-Created when a hammer hit something. This gear will dig into the ground. See also `gtHammer` for hammer damage.
+Created when a hammer hit something. This gear will dig into the ground. See also [GearTypes#gtHammer `gtHammer`] for hammer damage.
 * `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.
 ==== `gtMelonPiece` ====
-A cluster from a watermelon bomb (`gtWatermelon`)
+A cluster from a watermelon bomb ([GearTypes#gtWatermelon `gtWatermelon`])
 * `Boom`: Explosion size and damage. Default: 75
 ==== `gtNapalmBomb` ====
-A bomb from the napalmn strike (`gtAirAttack`), will burst into fire.
+A bomb from napalmn ([GearTypes#gtAirAttack `gtAirAttack`]), will burst into fire.
 * `Timer`: Detonation timer (in milliseconds). Default: 1000
 ==== `gtPoisonCloud` ====
-A poisonous cloud, makes hedgehogs sick on contact. Is normally created by `gtGasBomb`.
+A poisonous cloud, makes hedgehogs sick on contact. Is normally created by [GearTypes#gtGasBomb `gtGasBomb`].
 * `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.
 === Other ===
 Gears which don't fit into any other category.
 ==== `gtAddAmmo` ====
-Used to add some weapon or utilty to a hedgehog. The gear is added when a crate (`gtCase`) has been collected.
+Used to add some weapon or utilty to a hedgehog. The gear is added when a crate ([GearTypes#gtCase `gtCase`]) has been collected.
 ==== `gtATStartGame` ====
 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.
 ==== `gtATFinishGame` ====

changeset 847	60505ed50289
parent 846	19f1fe382e5f
child 848	fd0c8a52cf31