hwkb: comparison GearTypes.wiki

equal deleted inserted replaced

-:61a8cbc2d624
+:e19b53dd5770
 == 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.
+Note: The gear value “`Boom`” will be introduced in Hedgewars 0.9.23.
 === Land objects ===
 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.
 ==== `gtCase` ====
 An ammo, utility or health crate.
 * `Pos`: Crate type: 1=ammo crate, 2=health crate, 4=utility crate
 * `Tag`: Used for the appear animation
 * `Health`: Amount of health contained in a health crate
+* `Boom`: Explosion size and damage (default: 25)
 ==== `gtExplosives` ====
 An explosive barrel. It has its own invisible health, like a hedgehog. On low health levels smoke comes out of the barrel.
 * `Health`: “health” of the barrel: Starts at 60, explodes at 0.
+* `Boom`: Explosion size and damage (default: 75)
 ==== `gtFlake` ====
 A snowflake which might become part of the terrain.
 ==== `gtFlame` ====
 TODO: Flame size.
 * `Pos`: Some unknown value between 0-32 (TODO)
 * `FlightTime`: If set to `0`, this flame can hurt hedgehogs even in mid-air. By default, the FlightTime is a non-zero value.
+* `Boom`: Damage and size of destroyed land (default: 2)
 ==== `gtGrave` ====
 A grave from a dead hedgehog.
 * `Health`: Used when being resurrected.
 ==== `gtHedgehog` ====
 A hedgehog.
 * `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays
 * `Health`: Hedgehog's health.
+* `Boom`: Explosion size and damage caused when the hedgehog dies (default: 30)
 TODO: Write more about hedgehogs.
 ==== `gtPortal` ====
 A portal from the portable portal device.
 === Weapons and main projectiles ===
 Gears of weapons which can be directly used or launched by the players.
 ==== `gtAirAttack` ====
-The airplane of an airborne attack.
+The airplane of an airborne attack. It can drop either missiles (`gtAirBomb`), mines (`gtMine`), napalm missiles (`gtNapalmBomb`) or drill rockets (`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)
 * `Pos`: Air friction. Higher values mean slower movement.
 * `Timer`: Time left until possible detonation (in milliseconds). Default value depends on game scheme.
 * `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.
 * `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
 * `Power`: Speed in which it seeks and follows hedgehogs.
-* `Karma`: Explosion size and damage. Default: 30
+* `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. This weapon is timer-based.
+A ballgun. It throws 51 balls (`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`.
 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.
 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.
 * `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. 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 (`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)
 ==== `gtBlowTorch` ====
 A blowtorch. This utility is entirely timer-based.
 * `Timer`: Remaining usage time in ms, default is 7500.
+* `Boom`: Damage caused when burning a hedgehog or an object. Default: 2
 ==== `gtClusterBomb` ====
-A cluster bomb.
+A cluster bomb. Spawns several `gtCluster` gears on detonation.
+* `Boom`: Explosion size and damage. Default: 20
 ==== `gtCake` ====
 A cake.
 * `Tag`: A timer used for several animations. The final animation (sit down) will cause the cake to explode when the tag reaches `2250`.
 * `Health`: Remaining walking time, default is 2048. Note: the cake uses its own time unit.
+* `Boom`: Explosion size and damage. Default: 75
 ==== `gtDEagleShot` ====
 A shot from a Desert Eagle.
 * `Health`: How deep the bullet digs into land. Default: 50.
+* `Boom`: Damage. Default: 7
 ==== `gtDrill` ====
 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).
 The type of drill rocket is stored in the gear state. If `gsttmpFlag` is set (e.g. {{{band(GetState(yourDrillGear), gsttempFlag) == 0}}} evaluates to `true`), it is a launched drill rocket, otherwise it is a drill rocket from the drill strike.
 * `Tag`: Used for drill strike. If `1`, then first impact occoured already.
 * `Timer`: Detonation timer (in ms)
+* `Boom`: Explosion size and damage. Default: 50 for launched drill rocket, 30 for drill rocket from drill strike
 ==== `gtDynamite` ====
 A dynamite.
 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.
 * `Tag`: Displayed animation frame.
 * `Timer`: Detonation timer (in ms). Default: 5000.
+* `Boom`: Explosion size and damage. Default: 75
 ==== `gtFirePunch` ====
 A hedgehog which performs the Shoryuken attack.
 * `Tag`: Current Y coordinate of the hedgehog.
+* `Boom`: Damage. Default: 30
 ==== `gtFlamethrower` ====
 A flamethrower.
 * `Tag`: Current spitting power of flamethrower (`5`-`20`)
 ==== `gtGrenade` ====
 A grenade.
 * `Timer`: Detonation timer (in milliseconds).
+* `Boom`: Explosion size and damage. Default: 50
 ==== `gtHammer` ====
-A hammer. See also `gtHammerHit` for the actual hit of the hammer.
+A hammer attack. This gear is for taking away the health. See also `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)
 ==== `gtHellishBomb` ====
 A hellish hand-grenade.
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
+* `Boom`: Explosion size and damage. Default: 90
 ==== `gtIceGun` ====
 A freezer.
 * `Health`: Remaining fuel. `1000` is for 100% fuel
 ==== `gtKamikaze` ====
 A hedgehog which is doing a kamikaze attack.
 * `Health`: Remaining travel range. Default: 2048
+* `Boom`: Damage of a hit and damage and explosion size of the final explosion. Default: 30
 ==== `gtKnife` ====
 A cleaver.
+* `Boom`: Scaling value for the impact damage. The actual damage does not linearly scale. Default: 40000
 ==== `gtPiano` ====
-A piano from piano strike.
+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.
-* `Tag`: Number of remaining terrain bounces. Default: 5. If this number reaches 0, the piano will not collide anymore and directly fall into the water.
+* `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
+* `Boom`: Explosion size and damage of a single explosion of a single impact. Default: 80
 ==== `gtPickHammer` ====
 A pickhammer. This gear is entirely timer-based.
 * `Timer`: Remaining usage time (in milliseconds). Default: 4000
+* `Boom`: Damage per hit. Default: 6
 ==== `gtRCPlane` ====
-An RC plane.
+An RC plane. It can drop missiles (`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.
+A molotov cocktail. Creates several flames (`gtFlame`) on impact.
 ==== `gtMortar` ====
-A mortar.
+A mortar. On impact it spawns a few `gtCluster` gears.
+* `Boom`: Explosion size and damage of the main mortar projectile only. Default: 20
 ==== `gtMine` ====
 A land mine.
 If the gear state flag `gstAttacking` is set, mine has been activated and is about to explode (if it is not a dud).
 * `Timer`: Detonation timer (after activation).
 * `Health`: If `0`, mine is a dud.
+* `Boom`: Explosion size and damage. Default: 50
 ==== `gtSeduction` ====
 A hedgehog trying to seduce others.
 * `Radius`: Effect range of seduction in pixels. Default: 250. Note that this does not change the drawn circle
 ==== `gtShell` ====
 A bazooka shell (projectile).
+* `Boom`: Explosion size and damage. Default: 50
 ==== `gtShotgunShot` ====
 A shot from a shotgun. It is invisible and only can be noticed by its effects.
+* `Boom`: Damage. Default: 25
 ==== `gtShover` ====
 Used by baseball bat.
+* `Boom`: Damage. Default: 30
 ==== `gtSineGunShot` ====
 A shot from the sine gun.
 * `Radius`: The thickness of the sine gun shot.
+* `Boom`: Damage. Default: 35
 ==== `gtSMine` ====
 A sticky mine.
 If the gear state flag `gstAttacking` is set, the sticky mine has been activated and is about to explode.
 * `Timer`: Detonation timer after it was activated (in milliseconds). Default: 500
+* `Boom`: Explosion size and damage. Default: 30
 ==== `gtSniperRifleShot` ====
 A shot from the sniper rifle.
 * `Health`: How deep the bullet digs into land. Default: 50
+* `Boom`: Scaling value of the damage caused (not the actual damage). A higher value leads to higher damage. Default: 100000
 ==== `gtSnowball` ====
 A mudball.
+* `Boom`: Pushing power (just an arbitrary value for scaling). Default: 200000
 ==== `gtWatermelon` ====
-A watermelon bomb, still intact.
+A watermelon bomb, still intact. It spawns several `gtMelonPiece` gears when it explodes.
 * `Timer`: Detonation timer (in milliseconds).
 ==== `gtWhip` ====
 A whip.
+* `Boom`: Damage. Default: 30
 === 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 or the RC plane.
+A bomb from the air attack (`gtAirAttack`) or the RC plane (`gtRCPlane`).
+* `Boom`: Explosion size and damage. Default: 30
 ==== `gtBall` ====
-A ball from the ball gun
+A ball from the ball gun (`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 or the mortar
+A cluster from the cluster bomb (`gtClusterBomb`) or the mortar (`gtMortar`).
+* `Boom`: Explosion size and damage
 ==== `gtEgg` ====
-An egg from Birdy.
+An egg from Birdy (`gtBirdy`)
+* `Boom`: Size of destroyed land and damage. Default: 10
 ==== `gtHammerHit` ====
 A hit from the hammer.
 * `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.
+A cluster from a watermelon bomb (`gtWatermelon`)
+* `Boom`: Explosion size and damage.
 ==== `gtNapalmBomb` ====
-A bomb from the napalmn strike, will burst into fire.
+A bomb from the napalmn strike (`gtAirAttack`), will burst into fire.
 * `Timer`: Detonation timer (in milliseconds). Default: 1000
 ==== `gtPoisonCloud` ====
-A poisonous cloud, makes hedgehogs sick on contact.
+A poisonous cloud, makes hedgehogs sick on contact. Is normally created by `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 has been collected.
+Used to add some weapon or utilty to a hedgehog. The gear is added when a crate (`gtCase`) has been collected.
 ==== `gtATStartGame` ====
 TODO. The purpose of this gear is not clear yet.
 ==== `gtATFinishGame` ====

changeset 707	e19b53dd5770
parent 703	7d343af36e43
child 708	b6493acb50a4