diff -r f84aa8f2b2cc -r 2a0dab3480fc GearTypes.wiki --- a/GearTypes.wiki Fri Jan 01 21:09:05 2016 +0000 +++ b/GearTypes.wiki Fri Jan 01 21:11:16 2016 +0000 @@ -103,14 +103,14 @@ ==== `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 + * `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 ==== `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. + * `Health`: “health” of the barrel: Starts at 60, explodes at 0. ==== `gtFlake` ==== A snowflake which might become part of the terrain. @@ -126,21 +126,21 @@ ==== `gtGrave` ==== A grave from a dead hedgehog. -* `Health`: Used when being resurrected. + * `Health`: Used when being resurrected. ==== `gtHedgehog` ==== A hedgehog. -* `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays -* `Health`: Hedgehog's health. + * `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays + * `Health`: Hedgehog's health. TODO: Write more about hedgehogs. ==== `gtPortal` ==== A portal from the portable portal device. -* `Tag`: Portal state. 0=orange flying, 1=orange placed, 2=blue flying, 3=blue placed -* `Timer`: Remaining existance time (portals will disappear after end of turn). + * `Tag`: Portal state. 0=orange flying, 1=orange placed, 2=blue flying, 3=blue placed + * `Timer`: Remaining existance time (portals will disappear after end of turn). ==== `gtTarget` ==== A target, useful in target practice missions. @@ -155,13 +155,13 @@ ==== `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. + * `Health`: Amount of remaining fuel. `2000` denotes 100% fuel. ==== `gtLandGun` ==== The land spray tool. -* `Tag`: Spitting power of land spray (`5`-`20`). -* `Health`: Amount of fuel. `1000` denotes 100% fuel. || + * `Tag`: Spitting power of land spray (`5`-`20`). + * `Health`: Amount of fuel. `1000` denotes 100% fuel. || ==== `gtParachute` ==== A parachute. @@ -169,13 +169,13 @@ ==== `gtResurrector` ==== A hedgehog which does perform a resurrection. -* `Radius`: Effect range of resurrection in pixels (default: 100). Note that this does not change the drawn circle + * `Radius`: Effect range of resurrection in pixels (default: 100). Note that this does not change the drawn circle ==== `gtRope` ==== A rope. -* `Tag` Rope style: `0`=classic white segments (default), `1`=simple line which can be colored with `Tint`. -* `Tint`: Rope color as RGBA. This only works if `Tag` equals `1` + * `Tag` Rope style: `0`=classic white segments (default), `1`=simple line which can be colored with `Tint`. + * `Tint`: Rope color as RGBA. This only works if `Tag` equals `1` ==== `gtSwitcher` ==== Switch hedgehog. @@ -183,9 +183,9 @@ ==== `gtTardis` ==== A !TimeBox. It works in several phases and an internal timer. -* `Pos`: Current phase. The value `4` is used when the !TimeBox is currently time-travelling (has completely turned invisible). -* `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 -* `Tint`: RGBA color (default: clan color) + * `Pos`: Current phase. The value `4` is used when the !TimeBox is currently time-travelling (has completely turned invisible). + * `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 + * `Tint`: RGBA color (default: clan color) TODO: Add more information for the other phases. @@ -198,11 +198,11 @@ ==== `gtAirAttack` ==== The airplane of an airborne attack. -* `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) -* `Tint`: RGBA color of airplane (default: clan color) + * `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) + * `Tint`: RGBA color of airplane (default: clan color) ==== `gtAirMine` ==== 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. @@ -212,17 +212,17 @@ If the gear state flag `gstAttacking` is set, the air mine is activated and is about to explode. 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. -* `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 + * `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 ==== `gtBallGun` ==== A ballgun. This weapon is timer-based. -* `Timer`: Remaining usage time (in ms), default is 5001. One ball is fired every 100ms. + * `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`. @@ -230,20 +230,20 @@ 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. + * `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. ==== `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. -* `Tag`: Facing direction (`-1` = left, `1` = right) -* `Health`: “Flapping energy” left, default is 2000 -* `FlightTime`: Number of eggs left (default: 2) + * `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. + * `Timer`: Remaining usage time in ms, default is 7500. ==== `gtClusterBomb` ==== A cluster bomb. @@ -251,49 +251,49 @@ ==== `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. + * `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. ==== `gtDEagleShot` ==== A shot from a Desert Eagle. -* `Health`: How deep the bullet digs into land. Default: 50. + * `Health`: How deep the bullet digs into land. Default: 50. ==== `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) + * `Tag`: Used for drill strike. If `1`, then first impact occoured already. + * `Timer`: Detonation timer (in ms) ==== `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. + * `Tag`: Displayed animation frame. + * `Timer`: Detonation timer (in ms). Default: 5000. ==== `gtFirePunch` ==== A hedgehog which performs the Shoryuken attack. -`Tag`: Current Y coordinate of the hedgehog. + * `Tag`: Current Y coordinate of the hedgehog. ==== `gtFlamethrower` ==== A flamethrower. -* `Tag`: Current spitting power of flamethrower (`5`-`20`) -* `Health`: Remaining fuel. `500` is for 100% fuel. + * `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. -* `Timer`: Detonation timer (in milliseconds). + * `Timer`: Detonation timer (in milliseconds). ==== `gtGrenade` ==== A grenade. -* `Timer`: Detonation timer (in milliseconds). + * `Timer`: Detonation timer (in milliseconds). ==== `gtHammer` ==== A hammer. See also `gtHammerHit` for the actual hit of the hammer. @@ -301,17 +301,17 @@ ==== `gtHellishBomb` ==== A hellish hand-grenade. -* `Timer`: Detonation timer (in milliseconds). Default: 5000 + * `Timer`: Detonation timer (in milliseconds). Default: 5000 ==== `gtIceGun` ==== A freezer. -* `Health`: Remaining fuel. `1000` is for 100% fuel + * `Health`: Remaining fuel. `1000` is for 100% fuel ==== `gtKamikaze` ==== A hedgehog which is doing a kamikaze attack. -* `Health`: Remaining travel range. Default: 2048 + * `Health`: Remaining travel range. Default: 2048 ==== `gtKnife` ==== A cleaver. @@ -319,20 +319,20 @@ ==== `gtPiano` ==== A piano from piano strike. -* `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. Default: 5. If this number reaches 0, the piano will not collide anymore and directly fall into the water. ==== `gtPickHammer` ==== A pickhammer. This gear is entirely timer-based. -* `Timer`: Remaining usage time (in milliseconds). Default: 4000 + * `Timer`: Remaining usage time (in milliseconds). Default: 4000 ==== `gtRCPlane` ==== An RC plane. -* `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) + * `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) ==== `gtMolotov` ==== A molotov cocktail. @@ -345,16 +345,16 @@ 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. + * `Timer`: Detonation timer (after activation). + * `Health`: If `0`, mine is a dud. ==== `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 + * `Radius`: Effect range of seduction in pixels. Default: 250. Note that this does not change the drawn circle ==== `gtShell` ==== -A bazooka shell (projectile). + A bazooka shell (projectile). ==== `gtShotgunShot` ==== A shot from a shotgun. It is invisible and only can be noticed by its effects. @@ -365,19 +365,19 @@ ==== `gtSineGunShot` ==== A shot from the sine gun. -* `Radius`: The thickness of the sine gun shot. + * `Radius`: The thickness of the sine gun shot. ==== `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 + * `Timer`: Detonation timer after it was activated (in milliseconds). Default: 500 ==== `gtSniperRifleShot` ==== A shot from the sniper rifle. -* `Health`: How deep the bullet digs into land. Default: 50 + * `Health`: How deep the bullet digs into land. Default: 50 ==== `gtSnowball` ==== A mudball. @@ -385,7 +385,7 @@ ==== `gtWatermelon` ==== A watermelon bomb, still intact. -* `Timer`: Detonation timer (in milliseconds). + * `Timer`: Detonation timer (in milliseconds). ==== `gtWhip` ==== A whip. @@ -399,8 +399,8 @@ ==== `gtBall` ==== A ball from the ball gun -* `Timer`: Detonation timer (in milliseconds). Default: 5000 -* `Tag`: Color: `0`=red, `1`=green, `2`=cyan, `3`=yellow, `4`=violet, `5`=pink, `6`=orange, `7`=lime, `8`=white + * `Timer`: Detonation timer (in milliseconds). Default: 5000 + * `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 @@ -411,20 +411,20 @@ ==== `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. + * `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. ==== `gtNapalmBomb` ==== A bomb from the napalmn strike, will burst into fire. -* `Timer`: Detonation timer (in milliseconds). Default: 1000 + * `Timer`: Detonation timer (in milliseconds). Default: 1000 ==== `gtPoisonCloud` ==== A poisonous cloud, makes hedgehogs sick on contact. -* `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. + * `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.