GearTypes.wiki
author Wuzzy <Wuzzy@disroot.org>
Tue, 28 May 2024 21:34:51 +0200
changeset 2278 b7c1534848dc
parent 2230 61645d84f13e
permissions -rw-r--r--
Revenge taunt actually does not have fallback
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
1858
e08849853ddb GearTypes: Remove WIP note
Wuzzy
parents: 1857
diff changeset
     9
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
703
7d343af36e43 decrease TOC depth
Wuzzy
parents: 702
diff changeset
    11
<wiki:toc max_depth="3" />
702
530c4aefa069 Add table of contents
Wuzzy
parents: 701
diff changeset
    12
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    13
== List of gear types ==
2105
205fc7f87cf4 GearTypes: add newline
Wuzzy
parents: 2077
diff changeset
    14
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    15
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
    16
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    17
=== Land objects ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    18
|| *Gear type* || *Description* ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    19
|| [GearTypes#gtCase `gtCase`] || Crate ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    20
|| [GearTypes#gtExplosives `gtExplosives`] || Barrel ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    21
|| [GearTypes#gtFlake `gtFlake`] || Snowflake or land spray flake ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    22
|| [GearTypes#gtFlame `gtFlame`] || Flame ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    23
|| [GearTypes#gtGrave `gtGrave`] || Grave ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    24
|| [GearTypes#gtHedgehog `gtHedgehog`] || Hedgehog ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    25
|| [GearTypes#gtPortal `gtPortal`] || Portal from the portable portal device ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    26
|| [GearTypes#gtTarget `gtTarget`] || Target ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    27
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    28
=== Utilities ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    29
|| *Gear type* || *Description* ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    30
|| [GearTypes#gtGirder `gtGirder`] || Attempt to place a construction or rubber ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    31
|| [GearTypes#gtJetpack `gtJetpack`] || Flying saucer ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    32
|| [GearTypes#gtLandGun `gtLandGun`] || Land spray tool ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    33
|| [GearTypes#gtParachute `gtParachute`] || Parachute ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    34
|| [GearTypes#gtResurrector `gtResurrector`] || Resurrection ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    35
|| [GearTypes#gtRope `gtRope`] || Rope ||
1154
c51b5a2697d7 GearTypes: rewrite gtSwitcher
Wuzzy
parents: 1153
diff changeset
    36
|| [GearTypes#gtSwitcher `gtSwitcher`] || Switch hedgehog ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    37
|| [GearTypes#gtTardis `gtTardis`] || Time Box ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    38
|| [GearTypes#gtTeleport `gtTeleport`] || Teleportation ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    39
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    40
=== Weapons and main projectiles ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    41
|| *Gear type* || *Description* ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    42
|| [GearTypes#gtAirAttack `gtAirAttack`] || Airplane of an airborne attack ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    43
|| [GearTypes#gtAirMine `gtAirMine`] || Air mine ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    44
|| [GearTypes#gtBallGun `gtBallGun`] || Ballgun ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    45
|| [GearTypes#gtBee `gtBee`] || Homing bee ||
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    46
|| [GearTypes#gtBirdy `gtBirdy`] || Birdy ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    47
|| [GearTypes#gtBlowTorch `gtBlowTorch`] || Blowtorch ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    48
|| [GearTypes#gtClusterBomb `gtClusterBomb`] || Cluster bomb ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    49
|| [GearTypes#gtCake `gtCake`] || Cake ||
1633
4d62b31cddef GearTypes: add gtCreeper, update gtDuck
Wuzzy
parents: 1526
diff changeset
    50
|| [GearTypes#gtCreeper `gtCreeper`] || Creeper (unfinished weapon) ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    51
|| [GearTypes#gtDEagleShot `gtDEagleShot`] || Shot from a Desert Eagle ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    52
|| [GearTypes#gtDrill `gtDrill`] || Drill rocket ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    53
|| [GearTypes#gtDynamite `gtDynamite`] || Dynamite ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    54
|| [GearTypes#gtFirePunch `gtFirePunch`] || Shoryuken ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    55
|| [GearTypes#gtFlamethrower `gtFlamethrower`] || Flamethrower ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    56
|| [GearTypes#gtGasBomb `gtGasBomb`] || Old limburger ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    57
|| [GearTypes#gtGrenade `gtGrenade`] || Grenade ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    58
|| [GearTypes#gtHammer `gtHammer`] || Gear dealing hammer damage ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    59
|| [GearTypes#gtHellishBomb `gtHellishBomb`] || Hellish hand-grenade ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    60
|| [GearTypes#gtIceGun `gtIceGun`] || Freezer ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    61
|| [GearTypes#gtKamikaze `gtKamikaze`] || Hegehog going kamikaze ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    62
|| [GearTypes#gtKnife `gtKnife`] || Cleaver ||
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2059
diff changeset
    63
|| [GearTypes#gtMinigun `gtMinigun`] || Minigun ||
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2059
diff changeset
    64
|| [GearTypes#gtMinigunBullet `gtMinigunBullet`] || Minigun bullet ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    65
|| [GearTypes#gtPiano `gtPiano`] || Piano from piano strike ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    66
|| [GearTypes#gtPickHammer `gtPickHammer`] || Pickhammer ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    67
|| [GearTypes#gtRCPlane `gtRCPlane`] || RC plane ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    68
|| [GearTypes#gtMolotov `gtMolotov`] || Molotov cocktail ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    69
|| [GearTypes#gtMortar `gtMortar`] || Mortar ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    70
|| [GearTypes#gtMine `gtMine`] || Mine ||
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
    71
|| [GearTypes#gtSeduction `gtSeduction`] || Seduction ||
2228
add2fedfddd8 GearTypes: mark sentry as unfinished
Wuzzy
parents: 2227
diff changeset
    72
|| [GearTypes#gtSentry `gtSentry`] || Sentry (unfinished weapon) ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    73
|| [GearTypes#gtShell `gtShell`] || Bazooka shell (projectile) ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    74
|| [GearTypes#gtShotgunShot `gtShotgunShot`] || Shot from a shotgun ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    75
|| [GearTypes#gtShover `gtShover`] || Punch from baseball bat ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    76
|| [GearTypes#gtSineGunShot `gtSineGunShot`] || Shot from the sine gun ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    77
|| [GearTypes#gtSMine `gtSMine`] || Sticky mine ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    78
|| [GearTypes#gtSniperRifleShot `gtSniperRifleShot`] || Shot from the sniper rifle ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    79
|| [GearTypes#gtSnowball `gtSnowball`] || Mudball ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    80
|| [GearTypes#gtWatermelon `gtWatermelon`] || Watermelon bomb (main projectile) ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    81
|| [GearTypes#gtWhip `gtWhip`] || Whip ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    82
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    83
=== Secondary projectiles ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    84
|| *Gear type* || *Description* ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    85
|| [GearTypes#gtAirBomb `gtAirBomb`] || Bomb from air attack or RC plane ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    86
|| [GearTypes#gtBall `gtBall`] || Ball from ball gun || 
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    87
|| [GearTypes#gtCluster `gtCluster`] || Cluster from the cluster bomb or mortar ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    88
|| [GearTypes#gtEgg `gtEgg`] || Egg from Birdy ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    89
|| [GearTypes#gtHammerHit `gtHammerHit`] || Hammer digging into land ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    90
|| [GearTypes#gtMelonPiece `gtMelonPiece`] || Cluster from a watermelon bomb ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    91
|| [GearTypes#gtNapalmBomb `gtNapalmBomb`] || Bomb from the napalm strike ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    92
|| [GearTypes#gtPoisonCloud `gtPoisonCloud`] || Poisonous cloud ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    93
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    94
=== Other ===
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
    95
|| *Gear type* || *Description* ||
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    96
|| [GearTypes#gtAddAmmo `gtAddAmmo`] || Adds a weapon or utilty to a hedgehog ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    97
|| [GearTypes#gtATStartGame `gtATStartGame`] || Created at the start of the game ||
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
    98
|| [GearTypes#gtATFinishGame `gtATFinishGame`] || Created at the end of the game. Fades out the screen and exits the game || 
1213
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
    99
|| [GearTypes#gtGenericFaller `gtGenericFaller`] || Virtual ball || 
1153
a387a3532b8a GearTypes: Shorten gear overview text
Wuzzy
parents: 1152
diff changeset
   100
|| [GearTypes#gtWaterUp `gtWaterUp`] || Causes water to rise ||
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   101
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   102
== Long descriptions and values ==
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   103
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
   104
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   105
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.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   106
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   107
=== Land objects ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   108
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
   109
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   110
==== `gtCase` ====
880
edb64d05684e GearTypes: Fix some spelling mistakes
Wuzzy
parents: 879
diff changeset
   111
An ammo, utility, health or even a fake crate.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   112
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   113
If the crate has just been collected, the gear message flag `gmDestroy` will be set before `onGearDelete` is called.
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   114
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   115
 * `Pos`: Crate type: 1=ammo crate, 2=health crate, 4=utility crate (also see below)
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   116
 * `Tag`: Used for the appear animation
1236
5011c573bded GearTypes: Discourage negative health crates
Wuzzy
parents: 1214
diff changeset
   117
 * `Health`: Amount of health contained in a health crate. This value should not be negative
1028
87a758104dea GearTypes: special value for infinite ammo
Wuzzy
parents: 1027
diff changeset
   118
 * `Power`: Ammo count in an ammo or utility crate. 0: Use weapon scheme default. 100 or greater: infinite (default: 0)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   119
 * `Boom`: Explosion size and damage (default: 25)
1723
2435eaf0770c GearTypes: Add Karma for mines and health crate
Wuzzy
parents: 1719
diff changeset
   120
 * `Karma`: (1.0.0) If `1`, health amount of a health crate can not be viewed in the game with the object information view, but it will be available in demos. If `2`, health amount can never be viewed.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   121
1025
e6c3e90f2373 GearTypes: Add Power setting for crates
Wuzzy
parents: 1005
diff changeset
   122
We recommend you to use `SpawnAmmoCrate` and the like to crate crate gears instead of `AddGear`.
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   123
1273
199ac349aefc GearTypes: crate contents
Wuzzy
parents: 1263
diff changeset
   124
It is not possible to get the ammo type contained in an ammo or utility crate. Note that random crate contents are determined when a hedgehog collects it, not before.
199ac349aefc GearTypes: crate contents
Wuzzy
parents: 1263
diff changeset
   125
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   126
Advanced crate types: If you just care about normal crates, the values 1, 2 and 4 mentioned above are all you need to know. But Hedgewars supports a few crate variants which can be spawned with `SpawnFakeAmmoCrate` and the like. The `Pos` parameter is in reality a sum of several flags which need to be added up for the final type.
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   127
|| *Pos flag* || *Meaning* ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   128
|| `0x1` || Ammo crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   129
|| `0x2` || Health crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   130
|| `0x4` || Utility crate ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   131
|| `0x8` || Fake crate, looks like a normal crate but does not actually contain health or ammo ||
880
edb64d05684e GearTypes: Fix some spelling mistakes
Wuzzy
parents: 879
diff changeset
   132
|| `0x10` || Booby trap: When the player collects this crate it will explode ||
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   133
|| `0x20` || Poison trap: When the player collects this crate the player will be poisoned ||
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   134
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   135
All crates *must* have exactly one of the flags `0x1`, `0x2` or `0x4` set. Everything else can be combined at will.
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   136
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   137
Examples:
882
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   138
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   139
 * Pos = 0x1: Ammo crate
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   140
 * Pos = 0x9: Fake ammo crate (0x1 + 0x8)
0a5904d7ae7a GearTypes: Fix syntax of gtCase examples
Wuzzy
parents: 880
diff changeset
   141
 * Pos = 0x2A: Fake health crate with poison trap (0x2 + 0x8 + 0x20)
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   142
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   143
==== `gtExplosives` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   144
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
   145
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   146
 * `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
   147
 * `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
   148
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   149
==== `gtFlake` ====
850
284d32236865 GearTypes: Fix landgun link
Wuzzy
parents: 849
diff changeset
   150
A little object which will, when colliding with the terrain, become part of the terrain. It is either a snowflake generated by the theme (examples are the Snow and Christmas themes) or a flake created by a land spray ([GearTypes#gtLandGun `gtLandGun`]).
712
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   151
2a001a64d9a2 Better explanation of gtFlake
Wuzzy
parents: 711
diff changeset
   152
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
   153
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   154
==== `gtFlame` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   155
A single flame.
1887
e2abe908d18d GearTypes: rename non-sticky flames to normal flames
Wuzzy
parents: 1886
diff changeset
   156
In the main game, there are two kinds of flames: Normal flames and sticky flames. Normal flames 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
   157
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   158
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
   159
1886
59854f341a79 GearTypes: Fix Tag info
Wuzzy
parents: 1858
diff changeset
   160
 * `Tag`: For sticky flames, this determines the burning time (higher = longer). Burning time in ms = `3000+1500*Tag`. This also sets the “direction” of the animation. If the last binary digit is a 0, the animation is played forwards, otherwise its backwards. `Tag` is initialized with a random value between 0 and 31.
1887
e2abe908d18d GearTypes: rename non-sticky flames to normal flames
Wuzzy
parents: 1886
diff changeset
   161
 * `Health`: Size of the flame. Normal 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.
714
0cbb8f5f1246 Distinction between sticky and non-sticky flames
Wuzzy
parents: 713
diff changeset
   162
 * `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.
1887
e2abe908d18d GearTypes: rename non-sticky flames to normal flames
Wuzzy
parents: 1886
diff changeset
   163
 * `Boom`: Damage and size of destroyed land (default: 2). Sticky flames always deal `Boom` damage, normal flames deal either `Boom` or sometimes deal 3 times this value as damage.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   164
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   165
==== `gtGrave` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   166
A grave from a dead hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   167
1070
a4ef27a698aa GearTypes: Add Pos of gtGrave
Wuzzy
parents: 1061
diff changeset
   168
 * `Pos`: `gearUid` of the dead hedgehog
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   169
 * `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
   170
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   171
==== `gtHedgehog` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   172
A hedgehog.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   173
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   174
Basic attributes are:
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   175
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   176
 * `Health`: Hedgehog's health.
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   177
 * `Tag`: Used for animation. `0` = no animation plays. Other value: animation plays
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   178
 * `Radius`: Collision radius. Default: 9
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   179
 * `Boom`: Explosion size and damage caused when the hedgehog dies (default: 30)
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   180
 * `FlightTime`: Time (in milliseconds) since the hedgehog stood the last time on solid ground
1914
180d42ef766d GearTypes: Add hog damage
Wuzzy
parents: 1912
diff changeset
   181
 * `Damage`: Amount of damage the hog took in this turn. At the end of turn, the health will be reduced accordingly and the `Damage` is reset to 0
1915
a043892f9a4d GearTypes: Hedgehog angle
Wuzzy
parents: 1914
diff changeset
   182
 * `Angle`: Current aiming angle, ranging from 0 to 2024. 0 is 90° (up) and 2024 is -90° (down).
1916
a604b1f25dad GearTypes: FlightTime for gtHedgehog
Wuzzy
parents: 1915
diff changeset
   183
 * `FlightTime`: Amount of time the hedgehog flew after being hit by a baseball bat. If not hit or not in air, this is 0
780
7c3fd495897b GearTypes: update hedgehog info
Wuzzy
parents: 778
diff changeset
   184
782
0fba851eb618 GearTypes: cleanup gtHedgehog
Wuzzy
parents: 781
diff changeset
   185
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
   186
1805
d18970cf6ca2 Update other pages for new Lua documentation structure
Wuzzy <almikes@aol.com>
parents: 1723
diff changeset
   187
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 LuaGears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   188
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   189
==== `gtPortal` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   190
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
   191
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   192
 * `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
   193
 * `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
   194
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   195
==== `gtTarget` ====
710
580a83691524 Explain gtTarget
Wuzzy
parents: 709
diff changeset
   196
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
   197
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   198
=== Utilities ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   199
The gears used by various utilities.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   200
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   201
==== `gtGirder` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   202
This gear is created when a player tried to place construction or rubber somewhere. Placement may or may not have been successful.
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   203
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   204
 * `State`: Orientation and size coded as a number. See Lua API documentation on `onGirderPlacement` or `onRubberPlacement` for the meaning of the number.
795
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   205
0fe2af973d36 GearTypes: Explain gtGirder properly
Wuzzy
parents: 794
diff changeset
   206
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
   207
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   208
==== `gtJetpack` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   209
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
   210
1646
5255f589c12b GearTypes: add infinite globals
Wuzzy
parents: 1633
diff changeset
   211
 * `Health`: Amount of remaining fuel. `2000` denotes 100% fuel. The special value `JETPACK_FUEL_INFINITE` is used for infinite fuel
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   212
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   213
==== `gtLandGun` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   214
The land spray tool. Creates [GearTypes#gtFlake `gtFlake`] gears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   215
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   216
 * `Tag`: Spitting power of land spray (`5`-`20`).
711
7baf50ff47c7 Explain gtGrave
Wuzzy
parents: 710
diff changeset
   217
 * `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
   218
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   219
==== `gtParachute` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   220
A parachute.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   221
2107
3706d67d81b1 GearTypes: Add parachute timer
Wuzzy
parents: 2105
diff changeset
   222
 * `Timer`: Number of milliseconds the parachute has been enabled.
3706d67d81b1 GearTypes: Add parachute timer
Wuzzy
parents: 2105
diff changeset
   223
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   224
==== `gtResurrector` ==== 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   225
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
   226
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   227
 * `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
   228
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   229
==== `gtRope` ====
856
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   230
A rope. There can only be one rope gear at once.
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   231
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   232
The gear state flag `gstCollision` is set when the previous rope shot has hit something and is reset each time a new hook it fired.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   233
856
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   234
 * `X` and `Y`: Position of the nearest “bending point” of the rope (nearest to the rope gun), or the rope hook if rope does not touch anything
9740fae28189 GearTypes: Add more rope parameters
Wuzzy
parents: 855
diff changeset
   235
 * `dX`: sine of rope angle, number between -1000000 and 1000000 (correspond to -180° to 180°)
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   236
 * `dY`: negative cosine of rope angle, expressed as number between 0 and 1000000
1076
51733f19cfe2 GearTypes: fix typo
Wuzzy
parents: 1070
diff changeset
   237
 * `Elasticity`: If the hog is attached to a rope, or is busy firing one, the elasticity of the rope will be non-zero. A non-zero number holds the current retracted length of the rope from the nearest “bending point” or the hook, times 10000
1077
3c08441d5c2e GearTypes: fix another typo
Wuzzy
parents: 1076
diff changeset
   238
 * `Friction`: Holds the maximum remaining length of the rope measured from the nearest “bending point” or the hook, times 10000. Set this after rope creation to manually set the rope length individually. Note you can set `RopePercent` in `onGameInit` to set the rope length for all ropes at once
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   239
 * `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
   240
 * `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
   241
879
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   242
Note: `dX` and `dY` are returned by the `GetGearVelocity` function.
b82b228bd0f1 GearTypes: More detailed explanation on gtCase
Wuzzy
parents: 857
diff changeset
   243
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   244
==== `gtSwitcher` ====
1413
8832f69b198f GearTypes: More gtSwitcher babble
Wuzzy
parents: 1412
diff changeset
   245
This gear handles switching of hedgehogs, represented by spinning arrows. As long this gear exists, hedgehogs can be switched with the Switch Hedgehog key. This gear is destroyed, thus ending hog switching, as soon the hedgehog does something, like walking or choosing a weapon. There must never be more than one `gtSwitcher` gear at once in the game.
1412
225635def24e GearTypes: Update gtSwitcher
Wuzzy
parents: 1273
diff changeset
   246
1413
8832f69b198f GearTypes: More gtSwitcher babble
Wuzzy
parents: 1412
diff changeset
   247
*Note*: To enable hog switching manually from Lua, `AddGear` won't work. You must call `EnableSwitchHog()` instead (only available in 0.9.25 or later). Alternatively, enabling the !GameFlag `gfSwitchHog` enables hog switching automatically on turn start for everyone.
1152
7f70e3b1687f GearTypes: Extend gtSwitcher explanation
Wuzzy
parents: 1148
diff changeset
   248
1413
8832f69b198f GearTypes: More gtSwitcher babble
Wuzzy
parents: 1412
diff changeset
   249
 * `X` and `Y`: Position of the spinning arrows (visual effect only)
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   250
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   251
==== `gtTardis` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   252
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
   253
2183
693d41c055f8 GearTypes: Initial Tardis pos
Wuzzy
parents: 2182
diff changeset
   254
 * `Pos`: Current phase. The initial value is `1`
2181
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   255
     * `1`: Appearing
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   256
     * `2`: Pause (phase in which hedgehog walks in or out)
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   257
     * `3`: Disappearing
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   258
     * `4`: Time-travelling/away (has completely turned invisible)
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   259
 * `Timer`: Has several meanings, depending on the value of `Pos`:
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   260
     * `1`: `Timer` is unused
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   261
     * `2`: `Timer` increases each tick until `Timer > 2000` (plus a small delay), after which `Pos` advances to `3`
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   262
     * `3`: `Timer` is unused
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   263
     * `4`: `Timer` contains remaining time until the !TimeBox returns. The !TimeBox returns when `Timer` reaches 0. Hedgewars decreases the timer only while the same team is playing
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   264
 * `Power`: Used to store the fade-in/fade-out animation state, depending on current value of `Pos`:
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   265
     * `1`: `Power` increases by 1 every 32 ticks, until it reaches 255, at which `Pos` advances to `2`
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   266
     * `2`: `Power` is unused
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   267
     * `3`: `Power` decreases by 1 every 32 ticks, until it reaches 0, at which `Pos` advances to `4`. If the timebox is starting the time-travel, `Timer` is set to a random value (for the return time). It the timebox was returning, the timebox gear is deleted after this
3da12997c5e7 GearTypes: Extend gtTardis info
Wuzzy
parents: 2171
diff changeset
   268
     * `4`: `Power` is unused
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   269
 * `Tint`: RGBA color (default: clan color)
2182
0e10f5421f6d GearTypes: Clarify TimeBox tag
Wuzzy
parents: 2181
diff changeset
   270
 * `Tag`: Will be set to 1 if the associated hegehog dies, took damage or moved before it had a chance to enter the !TimeBox. If this has happened, the timebox usage has failed, and no time-travel will occur. The timebox will just go away without the hedgehog
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   271
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   272
==== `gtTeleport` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   273
Teleportation.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   274
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   275
=== Weapons and main projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   276
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
   277
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   278
==== `gtAirAttack` ====
851
6948d85cf3c9 GearTypes: fix gtDrill link
Wuzzy
parents: 850
diff changeset
   279
The airplane of an airborne attack. It can drop either missiles ([GearTypes#gtAirBomb `gtAirBomb`]), mines ([GearTypes#gtMine `gtMine`]), napalm missiles ([GearTypes#gtNapalmBomb `gtNapalmBomb`]) or drill rockets ([GearTypes#gtDrill `gtDrill`])
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   280
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   281
 * `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
   282
 * `Tag`: Direction of airplane: `-1` = left, `1` = right
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   283
 * `Health`: Number of bombs/mines/drills left (default: 6)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   284
 * `Damage`: Distance (in pixels) between two dropped bombs/mines/drills (default: 30)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   285
 * `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
   286
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   287
==== `gtAirMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   288
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
   289
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   290
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
   291
1713
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   292
States:
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   293
1714
749b203b1fd7 GearTypes: update gsttmpFlag for airmine
Wuzzy
parents: 1713
diff changeset
   294
 * `gsttmpFlag`: The air mine is active and ready to chase. The air mine is only inactive for the first few seconds of its existence, inactivity is indicated by a slightly darker color
1713
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   295
 * `gstAttacking`: The air mine is activated and is about to explode.
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   296
 * `gstChooseTarget`: 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.
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   297
caa20881899a GearTypes: inactive air mine
Wuzzy
parents: 1712
diff changeset
   298
Gear values:
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   299
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   300
 * `Pos`: Air friction. Higher values mean slower movement. 
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   301
 * `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
   302
 * `WDTimer`: Initial timer value (in milliseconds) of an activated air mine. The `Timer` is reset to this value if the air mine gets re-activated.
969
cb6bb484ce2a GearTypes: escape distance of airmines
Wuzzy
parents: 968
diff changeset
   303
 * `Angle`: Range in which it seeks and follows hedgehogs, in pixels. If a hedgehog is within this range, the air mine will start following. Set it to `0xFFFFFFFF` for an infinite seek range. Set to `0` to disable following. This also indirectly sets the escape distance which hog need to reach for the air mine to stop following. It is 6 times this value. Default: 175 (and an implied default escape distance of 1050)
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   304
 * `Power`: Speed in which it seeks and follows hedgehogs.
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2059
diff changeset
   305
 * `Boom`: Explosion size and damage. Default: 25
1723
2435eaf0770c GearTypes: Add Karma for mines and health crate
Wuzzy
parents: 1719
diff changeset
   306
 * `Karma`: (1.0.0) If `1`, mine timer display is hidden when object information view is enabled
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   307
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   308
==== `gtBallGun` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   309
A ballgun. It throws 51 balls ([GearTypes#gtBall `gtBall`]) by default. This weapon is timer-based.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   310
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   311
 * `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
   312
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   313
==== `gtBee` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   314
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
   315
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   316
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
   317
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
   318
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   319
 * `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
   320
 * `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
   321
 * `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
   322
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   323
==== `gtBirdy` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   324
Birdy. Transports hogs and can drop eggs ([GearTypes#gtEgg `gtEgg`]). Birdy works like a flying saucer and depletes energy (stored in `Health`) whenever you tap one of the direction keys. Flapping left and right costs 10 energy, flapping upwards costs 50 energy.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   325
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   326
 * `Tag`: Facing direction (`-1` = left, `1` = right)
1646
5255f589c12b GearTypes: add infinite globals
Wuzzy
parents: 1633
diff changeset
   327
 * `Health`: “Flapping energy” left, default is 2000. The special value `BIRDY_ENERGY_INFINITE` is used for infinite energy
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   328
 * `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
   329
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   330
==== `gtBlowTorch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   331
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
   332
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   333
 * `Timer`: Remaining usage time in ms, default is 7500.
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   334
 * `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
   335
 * `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
   336
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   337
==== `gtClusterBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   338
A cluster bomb. Spawns several [GearTypes#gtCluster `gtCluster`] gears on detonation.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   339
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   340
 * `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
   341
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   342
==== `gtCake` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   343
A cake. 
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   344
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   345
 * `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
   346
 * `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
   347
 * `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
   348
1633
4d62b31cddef GearTypes: add gtCreeper, update gtDuck
Wuzzy
parents: 1526
diff changeset
   349
==== `gtCreeper` ====
4d62b31cddef GearTypes: add gtCreeper, update gtDuck
Wuzzy
parents: 1526
diff changeset
   350
Used for an unfinished weapon that is internally known as the “Creeper”.
4d62b31cddef GearTypes: add gtCreeper, update gtDuck
Wuzzy
parents: 1526
diff changeset
   351
2041
7b22fb878196 GearTypes: Edited via web interface
Wuzzy
parents: 2040
diff changeset
   352
As of 1.0.0, it uses a rubber duck sprite (to be replaced). When released, it tries to walk and hop around on the terrain and tries to find a hog nearby. When it sees one, it will explode in a big explosion.
7b22fb878196 GearTypes: Edited via web interface
Wuzzy
parents: 2040
diff changeset
   353
2043
3cbada2b87a2 GearTypes: creeper name
Wuzzy
parents: 2042
diff changeset
   354
It's still pretty buggy and shouldn't be used for anything yet. It's unclear whether this weapon will ever be used. If this weapon is adopted, the name will probably change.
2042
68dd1e1e543c GearTypes: more creeper
Wuzzy
parents: 2041
diff changeset
   355
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   356
==== `gtDEagleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   357
A shot from a Desert Eagle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   358
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   359
 * `Health`: How deep the bullet digs into land. Default: 50.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   360
 * `Boom`: Damage. Default: 7
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   361
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   362
==== `gtDrill` ====
854
d58e744b2909 GearTypes: link to gtAirAttack in gtDrill
Wuzzy
parents: 853
diff changeset
   363
A drill rocket. This is either a launched drill rocket or a small and weaker drill rocket from the drill strike ([GearTypes#gtAirAttack `gtAirAttack`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   364
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   365
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
   366
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   367
 * `Tag`: Used for drill strike. If `1`, then first impact occoured already.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   368
 * `Timer`: Detonation timer (in ms)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   369
 * `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
   370
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   371
==== `gtDynamite` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   372
A dynamite.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   373
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
   374
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   375
 * `Tag`: Displayed animation frame.
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   376
 * `Timer`: Detonation timer (in ms). Default: 5000.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   377
 * `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
   378
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   379
==== `gtFirePunch` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   380
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
   381
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   382
 * `Tag`: Current Y coordinate of the hedgehog.
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   383
 * `Radius`: Hit radius. Default: 15
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   384
 * `Boom`: Damage. Default: 30
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
==== `gtFlamethrower` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   387
A flamethrower creates both sticky and non-sticky [GearTypes#gtFlame `gtFlame`] gears.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   388
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   389
 * `Tag`: Current spitting power of flamethrower (`5`-`20`)
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   390
 * `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
   391
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   392
==== `gtGasBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   393
An old limburger. Will spawn several [GearTypes#gtPoisonCloud `gtPoisonCloud`] gears on detonation.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   394
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   395
 * `Timer`: Detonation timer (in milliseconds).
968
6cb9a810e184 GearTypes: Add gtGasBomb boom
Wuzzy
parents: 941
diff changeset
   396
 * `Boom`: Explosion size and damage. Default: 20
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   397
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   398
==== `gtGrenade` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   399
A grenade.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   400
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   401
 * `Timer`: Detonation timer (in milliseconds).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   402
 * `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
   403
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   404
==== `gtHammer` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   405
A hammer attack. This gear is for determining which hedgehogs and objects to hit and to reduce health of anything hit. Hedgehogs, mines and barrels can be hit. See also [GearTypes#gtHammerHit `gtHammerHit`] for the digging part.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   406
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   407
 * `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
   408
 * `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
   409
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   410
==== `gtHellishBomb` ====
853
b3c2c6ff4da3 GearTypes: fix broken gtFlame link
Wuzzy
parents: 852
diff changeset
   411
A hellish hand-grenade. It creates several sticky and non-sticky flames ([GearTypes#gtFlame `gtFlame`]) on detonation.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   412
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   413
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   414
 * `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
   415
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   416
==== `gtIceGun` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   417
A freezer.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   418
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   419
 * `Health`: Remaining fuel. `1000` is for 100% fuel
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   420
 * `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
   421
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   422
==== `gtKamikaze` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   423
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
   424
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   425
 * `Health`: Remaining travel range. Default: 2048
855
0878a8e37afb GearTypes: fix typo
Wuzzy
parents: 854
diff changeset
   426
 * `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
   427
 * `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
   428
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   429
==== `gtKnife` ====
789
6693fdfb6876 GearTypes: cleaver damage
Wuzzy
parents: 788
diff changeset
   430
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
   431
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   432
 * `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
   433
 * `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
   434
1263
96a1f208b28e GearTypes: fix links
Wuzzy
parents: 1262
diff changeset
   435
==== `gtMinigun` ====
1262
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   436
A minigun. This gear is added for the full duration of a minigun shooting. Its job is to spawn `gtMinigunBullet`s until it runs out of time.
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   437
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   438
Before it starts shooting, there is a short delay for the “spin-up”. Then the timer is set to `Karma` and the minigun starts shooting until the timer reaches 0 again. Then the gear is destroyed.
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   439
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   440
The minigun is entirely timer-based (see `Karma`).
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   441
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   442
 * `Timer`: Used for two things: 1) Spin-up delay. If this timer reaches 0, minigun starts shooting and timer is set to `Karma`. 2) It shoots bullets until `Timer` is 0 again, after which it is destroyed. Timer starts at 601 by default.
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   443
 * `Karma`: The time of the minigun actually shooting. This is in direct relation to the number of bullets fired. One bullet is fired every 50 milliseconds. Default: 3451 (is equivalent to 70 bullets)
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   444
 * `Tag`: Current frame of minigun image, used for rotation animation and dispensing shells. Value is 0-1.
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   445
 * `WDTimer`: Number of bullets fired
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   446
1263
96a1f208b28e GearTypes: fix links
Wuzzy
parents: 1262
diff changeset
   447
==== `gtMinigunBullet` ====
1261
b9b3dff16331 GearTypes: Add gtMinigunBullet
Wuzzy
parents: 1247
diff changeset
   448
A minigun bullet.
b9b3dff16331 GearTypes: Add gtMinigunBullet
Wuzzy
parents: 1247
diff changeset
   449
b9b3dff16331 GearTypes: Add gtMinigunBullet
Wuzzy
parents: 1247
diff changeset
   450
 * `Boom`: Damage. Default: 2
b9b3dff16331 GearTypes: Add gtMinigunBullet
Wuzzy
parents: 1247
diff changeset
   451
 * `Radius`: Collision detection radius. Default: 1
1262
50795ad481b2 GearTypes: gtMinigun
Wuzzy
parents: 1261
diff changeset
   452
 * `WDTimer`: Bullet number of minigun, set by `gtMinigun`. This is the (`WDTimer`+1)th bullet. E.g. if `WDTimer` is `0`, this means its the first bullet from a minigun.
1261
b9b3dff16331 GearTypes: Add gtMinigunBullet
Wuzzy
parents: 1247
diff changeset
   453
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   454
==== `gtPiano` ====
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   455
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
   456
1490
b5bb0845eaa7 GearTypes: Fix piano parameters
Wuzzy
parents: 1413
diff changeset
   457
 * `Pos`: Number of remaining terrain bounces. If this number reaches 0, the piano will not collide anymore and directly fall into the water. Default: 5
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   458
 * `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
   459
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   460
==== `gtPickHammer` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   461
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
   462
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   463
 * `Timer`: Remaining usage time (in milliseconds). Default: 4000
794
4e2e38787f24 GearTypes: Add more Radius explanations
Wuzzy
parents: 793
diff changeset
   464
 * `Radius`: Width of dug land. Default: 10
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   465
 * `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
   466
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   467
==== `gtRCPlane` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   468
An RC plane. It can drop missiles ([GearTypes#gtAirBomb `gtAirBomb`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   469
857
ca7261b5c679 GearTypes: Explain Tag for RC plane
Wuzzy
parents: 856
diff changeset
   470
 * `Tag`: Initial flying direction, depends on the facing direction of the hedgehog which launched it. -1: left, 1: right. This is used for rendering. 
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   471
 * `Timer`: Remaining fly time (in milliseconds). Default: 15000
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   472
 * `Health`: Number of missiles on board. Default: 3
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   473
 * `Tint`: RGBA color of RC plane (default: clan color)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   474
 * `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
   475
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   476
==== `gtMolotov` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   477
A molotov cocktail. Creates several flames ([GearTypes#gtFlame `gtFlame`]) on impact.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   478
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   479
==== `gtMortar` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   480
A mortar. On impact it spawns a few [GearTypes#gtCluster `gtCluster`] gears.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   481
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   482
 * `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
   483
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   484
==== `gtMine` ====
1719
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   485
A regular mine. The game will decide whether a mine is a dud or not when the mine timer reaches 0.
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   486
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   487
State:
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   488
1719
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   489
 * `gstAttacking`: If set, mine has been activated and is about to explode (if it is not a dud)
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   490
 * `gstWait` if set, the mine will be guaranteed to not be a dud. `gstWait` is automatically set for mines that are placed by hedgehogs via the `amMine` ammo type
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   491
b3b6ed1c822f GearTypes: Add gstWait for gtMine
Wuzzy
parents: 1714
diff changeset
   492
Gear values:
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   493
788
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   494
 * `Timer`: Detonation timer (after activation). The initial value depends on the game settings.
f65141aad185 GearTypes: Dud mine damage
Wuzzy
parents: 782
diff changeset
   495
 * `Health`: If `0`, mine is a dud, otherwise it is not a dud or has not been triggered yet.
1723
2435eaf0770c GearTypes: Add Karma for mines and health crate
Wuzzy
parents: 1719
diff changeset
   496
 * `Tag`: If `1`, mine timer will be random.
827
231aed2ea8ae GearTypes: Fix mine Damage
Wuzzy
parents: 817
diff changeset
   497
 * `Damage`: If mine has become a dud, this will contain the damage taken by the mine since it was a dud. It starts at 0 and the mine will explode when `Damage` is greater than 35.
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   498
 * `Boom`: Explosion size and damage. Default: 50
1723
2435eaf0770c GearTypes: Add Karma for mines and health crate
Wuzzy
parents: 1719
diff changeset
   499
 * `Karma`: (1.0.0) If `1`, mine timer display is hidden when object information view is enabled
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   500
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   501
==== `gtSeduction` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   502
A hedgehog trying to seduce others.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   503
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   504
 * `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
   505
2225
30bf430cde27 GearTypes: Add gtSentry
Wuzzy
parents: 2183
diff changeset
   506
==== `gtSentry` ====
2227
5623b8fb1e6e GearTypes: mention dev version of gtSentry
Wuzzy
parents: 2226
diff changeset
   507
This is an experimental/incomplete gear that puts a sentry on the map. Added in the developer version after 1.0.0. A sentry is an object that looks for nearby hogs and shoots them on sight. This gear is a land object that survives multiple turns. It might also walk around randomly between turns. It can take damage and be destroyed by shooting it.
2225
30bf430cde27 GearTypes: Add gtSentry
Wuzzy
parents: 2183
diff changeset
   508
2229
01c86f6ed8be GearTypes: fix links
Wuzzy
parents: 2228
diff changeset
   509
The associated !AmmoType for this gear is `amSentry`.
2225
30bf430cde27 GearTypes: Add gtSentry
Wuzzy
parents: 2183
diff changeset
   510
2230
61645d84f13e GearTypes: Update gtSentry state
Wuzzy
parents: 2229
diff changeset
   511
Both the !AmmoType and !GearType are not recommended to be used in actual games yet.
2225
30bf430cde27 GearTypes: Add gtSentry
Wuzzy
parents: 2183
diff changeset
   512
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   513
==== `gtShell` ====
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   514
 A bazooka shell (projectile).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   515
713
5b7de589719c Add FlightTime to two gears
Wuzzy
parents: 712
diff changeset
   516
 * `FlightTime`: Time since the bazooka has been launched
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   517
 * `Boom`: Explosion size and damage. Default: 50
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   518
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   519
==== `gtShotgunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   520
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
   521
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   522
 * `Boom`: Damage. Default: 25
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   523
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   524
==== `gtShover` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   525
Used by baseball bat.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   526
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   527
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   528
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   529
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   530
==== `gtSineGunShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   531
A shot from the sine gun.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   532
2129
7c5c59981cf4 GearTypes: Add minimum sine radius
Wuzzy
parents: 2107
diff changeset
   533
 * `Radius`: The thickness of the sine gun shot (must be at least 1)
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   534
 * `Boom`: Damage. Default: 35
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   535
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   536
==== `gtSMine` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   537
A sticky mine.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   538
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   539
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
   540
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   541
 * `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
   542
 * `Boom`: Explosion size and damage. Default: 30
1723
2435eaf0770c GearTypes: Add Karma for mines and health crate
Wuzzy
parents: 1719
diff changeset
   543
 * `Karma`: (1.0.0) If `1`, mine timer display is hidden when object information view is enabled
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   544
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   545
==== `gtSniperRifleShot` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   546
A shot from the sniper rifle.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   547
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   548
 * `Health`: How deep the bullet digs into land. Default: 50
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   549
 * `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
   550
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   551
==== `gtSnowball` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   552
A mudball.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   553
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   554
 * `Boom`: Pushing power (just an arbitrary value for scaling). Default: 200000
2171
aff8f58ef3c4 GearTypes: Snowball density
Wuzzy
parents: 2129
diff changeset
   555
 * `Density`: Density is taken into account in `gfMoreWind` only. Otherwise, wind affects mudball as if `Density` is 1. Default: 0.5
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   556
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   557
==== `gtWatermelon` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   558
A watermelon bomb, still intact. It spawns several [GearTypes#gtMelonPiece `gtMelonPiece`] gears when it explodes.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   559
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   560
 * `Timer`: Detonation timer (in milliseconds).
716
34cbea18b1a8 Add Boom for gtWatermelon
Wuzzy
parents: 714
diff changeset
   561
 * `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
   562
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   563
==== `gtWhip` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   564
A whip.
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   565
793
a9de86e466e2 GearTypes: Hit radii of gtWhip, gtFirePunch, gtShover
Wuzzy
parents: 792
diff changeset
   566
 * `Radius`: Hit radius. Default: 20
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   567
 * `Boom`: Damage. Default: 30
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   568
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   569
=== Secondary projectiles ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   570
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
   571
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   572
==== `gtAirBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   573
A bomb from the air attack ([GearTypes#gtAirAttack `gtAirAttack`]) or the RC plane ([GearTypes#gtRCPlane `gtRCPlane`]).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   574
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   575
 * `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
   576
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   577
==== `gtBall` ====
849
5d3313b18318 GearTypes: fix typo in ballgun link
Wuzzy
parents: 848
diff changeset
   578
A ball from the ball gun ([GearTypes#gtBallGun `gtBallGun`]).
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   579
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   580
 * `Timer`: Detonation timer (in milliseconds). Default: 5000
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   581
 * `Boom`: Explosion size and damage. Default: 40
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   582
 * `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
   583
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   584
==== `gtCluster` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   585
A cluster from the cluster bomb ([GearTypes#gtClusterBomb `gtClusterBomb`]) or the mortar ([GearTypes#gtMortar `gtMortar`]).
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   586
1147
aec26fb3f6fa note about cluster
nemo
parents: 1078
diff changeset
   587
 * `Timer`: Default explosion size and damage on creation.  Prior to the addition of Boom this exclusively controlled the damage for clusterbomb, mortar and melon pieces, and was the main way to make a variable size explosion in lua.  Retained for compatibility.
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   588
 * `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
   589
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   590
==== `gtEgg` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   591
An egg from Birdy ([GearTypes#gtBirdy `gtBirdy`])
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   592
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   593
 * `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
   594
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   595
==== `gtHammerHit` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   596
Created when a hammer hit something. This gear will dig into the ground. See also [GearTypes#gtHammer `gtHammer`] for hammer damage.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   597
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   598
 * `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
   599
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   600
==== `gtMelonPiece` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   601
A cluster from a watermelon bomb ([GearTypes#gtWatermelon `gtWatermelon`])
707
e19b53dd5770 Explain Boom value. Make gear cross-references
Wuzzy
parents: 703
diff changeset
   602
1148
1fbbd733a3c2 add note about melon pieces too
nemo
parents: 1147
diff changeset
   603
 * `Timer`: Default explosion size and damage on creation.  Prior to the addition of Boom this exclusively controlled the damage for clusterbomb, mortar and melon pieces, and was the main way to make a variable size explosion in lua.  Retained for compatibility.
796
445168937988 GearTypes: Default Boom for gtMelonPiece and gtCluster
Wuzzy
parents: 795
diff changeset
   604
 * `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
   605
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   606
==== `gtNapalmBomb` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   607
A bomb from napalmn ([GearTypes#gtAirAttack `gtAirAttack`]), will burst into fire.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   608
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   609
 * `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
   610
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   611
==== `gtPoisonCloud` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   612
A poisonous cloud, makes hedgehogs sick on contact. Is normally created by [GearTypes#gtGasBomb `gtGasBomb`].
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   613
699
2a0dab3480fc Fix syntax of bullet-point lists
Wuzzy
parents: 698
diff changeset
   614
 * `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.
2059
e1f13ff10df0 GearTypes: clarify
Wuzzy
parents: 2058
diff changeset
   615
 * `WDTimer`: (1.0.1-dev) Initial life time (after spawning). Used by the animation
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
   616
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   617
=== Other ===
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   618
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
   619
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   620
==== `gtAddAmmo` ====
847
60505ed50289 GearTypes: Add internal links for all gear names
Wuzzy
parents: 846
diff changeset
   621
Used to add some weapon or utilty to a hedgehog. The gear is added when a crate ([GearTypes#gtCase `gtCase`]) has been collected.
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   622
1027
e50238cb0131 GearTypes: Add gtAddAmmo params
Wuzzy
parents: 1026
diff changeset
   623
 * `Pos`: Ammo classification: 1=weapon, 4=utility
1028
87a758104dea GearTypes: special value for infinite ammo
Wuzzy
parents: 1027
diff changeset
   624
 * `Power`: Ammo count. 0: Use weapon scheme default. 100 or greater: infinite (default: 0)
1027
e50238cb0131 GearTypes: Add gtAddAmmo params
Wuzzy
parents: 1026
diff changeset
   625
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   626
==== `gtATStartGame` ====
1912
94899e4fabe6 GearTypes: Warnings about gtATStartGame and gtATFinishGame
Wuzzy
parents: 1887
diff changeset
   627
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. This gear shouldn't be created in Lua.
607
dde757edd995 Rope style
Wuzzy
parents: 606
diff changeset
   628
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   629
==== `gtATFinishGame` ====
1912
94899e4fabe6 GearTypes: Warnings about gtATStartGame and gtATFinishGame
Wuzzy
parents: 1887
diff changeset
   630
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: This gear shouldn't be created in Lua. If you want to end the game early, we recommend to call the `EndGame` function.
777
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   631
1d4be3844d85 GearTypes: gtATStartGame, gtATFinishGame
Wuzzy
parents: 776
diff changeset
   632
 * `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
   633
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   634
==== `gtGenericFaller` ====
1213
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   635
This gear behaves like a virtual ball. It collides with its surroundings and bounces around but doesn't affect the environment or other gears in any way. It appears as a red circle, unless it is made invisible by setting the gear state. It also supports the gear state `gstNoGravity`. It gets automatically destroyed when its `Timer` is up.
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   636
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   637
The density, elasticity, friction and radius can be changed.
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   638
1214
935c89850888 GearTypes: fix typo
Wuzzy
parents: 1213
diff changeset
   639
 * `Radius`: Radius of the “ball”
935c89850888 GearTypes: fix typo
Wuzzy
parents: 1213
diff changeset
   640
 * `Timer`: Life time in milliseconds. Needs to be set explicitly to a positive value, otherwise the gear just dies instantly
1213
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   641
bcb30b2c3804 GearTypes: gtGenericFaller
Wuzzy
parents: 1184
diff changeset
   642
This gear could be useful for some testing or as a dummy.
698
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   643
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   644
==== `gtWaterUp` ====
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   645
Causes the water to rise.
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   646
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   647
`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
   648
f84aa8f2b2cc Complete rewrite of the page. Now every gear has a nice section
Wuzzy
parents: 635
diff changeset
   649
== Reference ==
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   650
For a current list of the gears look at `hedgewars/uTypes.pas` at
700
d1c283423e5c Linkify
Wuzzy
parents: 699
diff changeset
   651
the `TGearType` enumeration:
2077
514babfbad9e Remove outdated legacy hints as clutter
Wuzzy <almikes@aol.com>
parents: 2059
diff changeset
   652
[https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uTypes.pas#l92]