GearTypes.wiki
author almikes@aol.com
Fri, 19 Dec 2014 23:42:18 +0000
changeset 522 2b6da59e5489
parent 499 58b5889fbce4
child 534 f50cf1771b7f
permissions -rw-r--r--
Add SVG template.
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
425
ae373695ee1e Add columns for pos, timer and health (mostly only contain TODOs for now).
almikes@aol.com
parents: 424
diff changeset
     3
This is a list of (hopefully) all gear types, along with a short description and the meaning of severval fields.
ae373695ee1e Add columns for pos, timer and health (mostly only contain TODOs for now).
almikes@aol.com
parents: 424
diff changeset
     4
ae373695ee1e Add columns for pos, timer and health (mostly only contain TODOs for now).
almikes@aol.com
parents: 424
diff changeset
     5
The columns “Pos”, “Tag”, “Timer” and “Health” show the meaning of the gear’s field for the listed gear type. The word “ignored” means that the field in question is not relevant to gears of the gear type. See also `GetGearPos`, `SetGearPos`, `GetTag`, `SetTag`, `GetTimer`, `SetTimer`, `GetHealth`, `SetHealth` in [LuaAPI].
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
     6
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
     7
Please note this list is still mostly TODO. The categories presented here are purely for a better overview here; they do not neccessarily reflect anything in the actual game’s source code.
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
     8
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
     9
== List of gear types ==
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    10
=== Land objects ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    11
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
    12
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    13
|| *Gear type* || *Description* || *Pos* || *Tag* || *Timer* || *Health* ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    14
|| `gtCase` || an ammo, utility or health crate || TODO || TODO || TODO || TODO ||
499
58b5889fbce4 Add description for gtExplosives
almikes@aol.com
parents: 435
diff changeset
    15
|| `gtExplosives` || an explosive barrel || TODO || TODO || TODO || TODO ||
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    16
|| `gtFlake` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    17
|| `gtFlame` || a flame || TODO || between 0-32 (TODO) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    18
|| `gtGrave` || a grave from a dead hedgehog || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    19
|| `gtHedgehog` || a hedgehog || TODO || used for animation. `0` = no animation plays. Other value: animation plays || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    20
|| `gtPortal` || a portal from the portable portal device || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    21
|| `gtTarget` || a target, useful in target practice missions || TODO || TODO || TODO || TODO ||
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    22
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    23
=== Utilities ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    24
A list of “utility” gears.
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    25
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    26
|| *Gear type* || *Description* || *Pos* || *Tag* || *Timer* || *Health* ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    27
|| `gtGirder` || a girder (construction) || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    28
|| `gtJetpack` || a flying saucer || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    29
|| `gtLandGun` || the land spray tool || TODO || power of land spray (`5`-`20`) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    30
|| `gtParachute` || a parachute || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    31
|| `gtResurrector` || resurrection || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    32
|| `gtRope` || a rope || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    33
|| `gtSwitcher` || switch hedgehog || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    34
|| `gtTardis` || a !TimeBox || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    35
|| `gtTeleport` || teleportation || TODO || TODO || TODO || TODO ||
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    36
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    37
=== Weapons and main projectiles ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    38
List of weapons which can be directly used or launched by the players.
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    39
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    40
|| *Gear type* || *Description* || *Pos* || *Tag* || *Timer* || *Health* ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    41
|| `gtAirAttack` || The airplane of an air attack || TODO || direction of airplane (`-1` = left, `1` = right) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    42
|| `gtBallGun` || a ballgun || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    43
|| `gtBee` || homing bee || TODO || wheather the bee is underwater (`0` = no, `1` = yes) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    44
|| `gtBirdy` || Birdy || TODO || facing direction (`-1` = left, `1` = right) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    45
|| `gtBlowTorch` || a blowtorch || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    46
|| `gtClusterBomb` || a cluster bomb || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    47
|| `gtCake` || a cake || TODO || A timer used for several animations. The final animation (sit down) will cause the cake to explode when the tag reaches `2250`. || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    48
|| `gtDEagleShot` || a shot from a desert eagle || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    49
|| `gtDrill` || drill rocket || TODO || used for drill strike. If `1`, then first impact occoured already || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    50
|| `gtDynamite` || a dynamite || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    51
|| `gtFirePunch` || shoryuken || TODO || Y coordinate || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    52
|| `gtFlamethrower` || a flamethrower || TODO || power of flamethrower (`5`-`20`) || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    53
|| `gtGasBomb` || an old limburger || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    54
|| `gtGrenade` || a grenade || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    55
|| `gtHammer` || a hammer || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    56
|| `gtHellishBomb` || a hellish hand-grenade || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    57
|| `gtIceGun` || a freezer || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    58
|| `gtKamikaze` || an ongoing kamikaze || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    59
|| `gtKnife` || a cleaver || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    60
|| `gtPiano` || piano from piano strike || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    61
|| `gtPickHammer` || a pickhammer || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    62
|| `gtRCPlane` || a RC plane || TODO || dX speed??? || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    63
|| `gtMolotov` || a molotov cocktail || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    64
|| `gtMortar` || a mortar || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    65
|| `gtMine` || a mine || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    66
|| `gtSeduction` || seduction || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    67
|| `gtShell` || a bazooka shell (projectile) || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    68
|| `gtShotgunShot` || a shot from a shotgun || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    69
|| `gtShover` || used by baseball bat (TODO) || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    70
|| `gtSineGunShot` || a shot from the sine gun || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    71
|| `gtSMine` || a sticky mine || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    72
|| `gtSniperRifleShot` || a shot from the sniper rifle || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    73
|| `gtSnowball` || a mudball || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    74
|| `gtWatermelon` || a watermelon bomb, still intact || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    75
|| `gtWhip` || a whip || TODO || TODO || TODO || TODO ||
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    76
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    77
=== Secondary projectiles ===
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    78
Projectiles that can’t be directly fired but are generated by other weapon gears.
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    79
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    80
|| *Gear type* || *Description* || *Pos* || *Tag* || *Timer* || *Health* ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    81
|| `gtAirBomb` || a bomb from the air attack or the RC plane || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    82
|| `gtBall` || a ball from the ball gun || TODO || Color: `0`=red, `1`=green, `2`=cyan, `3`=yellow, `4`=violet, `5`=pink, `6`=orange, `7`=lime, `8`=white || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    83
|| `gtCluster` || a cluster from the cluster bomb or the mortar || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    84
|| `gtEgg` || an egg from Birdy || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    85
|| `gtHammerHit` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    86
|| `gtMelonPiece` || a cluster from a watermelon bomb || TODO|| TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    87
|| `gtNapalmBomb` || a bomb from the napalmn strike, will burst into fire || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    88
|| `gtPoisonCloud` || a poisonous cloud, makes hedgehogs sick on contact || TODO || TODO || TODO || TODO ||
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    89
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    90
=== Other ===
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    91
|| *Gear type* || *Description* || *Pos* || *Tag* || *Timer* || *Health* ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    92
|| `gtAddAmmo` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    93
|| `gtATStartGame` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    94
|| `gtATFinishGame` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    95
|| `gtGenericFaller` || TODO || TODO || TODO || TODO || TODO ||
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    96
|| `gtWaterUp` || If added, water will rise. || _ignored_ || Number of pixels the water still has to rise. By default, the tag will have an initial value of `47`. The gear will be removed when the tag equals `0`. || TODO || TODO ||
422
1e8c89d93ea9 Alphbetically sort gear types and put them into semantic categories.
almikes@aol.com
parents: 420
diff changeset
    97
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
    98
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
    99
== Source ==
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   100
Here is an excerpt from the Hedgewars source code:
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   101
{{{
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   102
    TGearType = (gtFlame, gtHedgehog, gtMine, gtCase, gtExplosives, // these gears should be avoided when searching a spawn place
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   103
        gtGrenade, gtShell, gtGrave, gtBee, // 8
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   104
        gtShotgunShot, gtPickHammer, gtRope, // 11
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   105
        gtDEagleShot, gtDynamite, gtClusterBomb, gtCluster, gtShover, // 16
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   106
        gtFirePunch, gtATStartGame, // 18
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   107
        gtATFinishGame, gtParachute, gtAirAttack, gtAirBomb, gtBlowTorch, // 23
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   108
        gtGirder, gtTeleport, gtSwitcher, gtTarget, gtMortar, // 28
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   109
        gtWhip, gtKamikaze, gtCake, gtSeduction, gtWatermelon, gtMelonPiece, // 34
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   110
        gtHellishBomb, gtWaterUp, gtDrill, gtBallGun, gtBall, gtRCPlane, // 40
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   111
        gtSniperRifleShot, gtJetpack, gtMolotov, gtBirdy, // 44
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   112
        gtEgg, gtPortal, gtPiano, gtGasBomb, gtSineGunShot, gtFlamethrower, // 50
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   113
        gtSMine, gtPoisonCloud, gtHammer, gtHammerHit, gtResurrector, // 55
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   114
        gtNapalmBomb, gtSnowball, gtFlake, {gtStructure,} gtLandGun, gtTardis, // 61
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   115
        gtIceGun, gtAddAmmo, gtGenericFaller, gtKnife); // 65
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   116
}}}
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   117
For a current list of the gears look at `hedgewars/uTypes.pas` at
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   118
the `TGearType` enumeration.
349
f6b3a80a6f92 Update line number for the link to uTypes.pas
Caironater@gmail.com
parents: 348
diff changeset
   119
http://code.google.com/p/hedgewars/source/browse/hedgewars/uTypes.pas#92
420
55be67135696 Put gear types into a table, along with a description and tag description.
almikes@aol.com
parents: 349
diff changeset
   120
435
9e434185289a Restructure page, add typographic improvements
almikes@aol.com
parents: 426
diff changeset
   121
Note: `gtBomb` and `gtShell` were named `gtAmmo_Bomb` and `gtAmmo_Grenade` before 0.9.14.