#summary API for writing Lua scripts in Hedgewars.

#labels Featured

== Introduction ==

Version 0.9.13 of Hedgewars introduced the ability to use Lua scripts to modify Hedgewars behaviour for different maps without having to recompile the whole game. The till then used triggers (only appeared in training maps) were removed.

Lua is an easy to learn scripting language that’s implemented using open source libraries. If you’d like to learn more about Lua, have a look at [http://www.lua.org Lua's official homepage]. Even though its easy to learn syntax this wiki page won't explain all basics of using Lua, e.g. declaring variables or using control structures. There are tons of step-by-step tutorials and documentation available on the internet. Just throw “Lua” into your favourite search engine and give it a try.

=== About this wiki page ===

This page tends to become outdated. For a list of undocumented functions, see [http://hw.ercatec.net/docs/lua_wiki_check.php].

<wiki:toc max_depth="4" />

== Overview ==

=== How Hedgewars handles Lua scripts ===

As of Version 0.9.20, Hedgewars supports Lua scripts for two similar tasks: Define tutorial missions, campaign missions or provide special map behaviour for precreated maps. It is also used for multiplayer scripts to create new game styles.

=== Tutorial missions ===

Tutorial missions are located within text files inside `share/hedgewars/Data/Missions/Training`. The game will list all files with the lua extension inside this directory in the Training selection screen. You’ll find some premade example scripts within this directory that contain several comments on the script lines and what they do.

See [Missions] for details.

=== Special maps ===

In addition to tutorial missions predrawn maps (maps not created using the random map creator) may contain a single lua script file named `map.lua`. If it’s there, it will be used once the map is played. This way it’s possible to play maps alone or over the internet using custom goals. Mission maps can be found in singleplayer mode under the “training” button and in multiplayer mode, it is selectable as a map type.

See also [PresetMaps] for more information about such maps.

=== How Lua scripts are used ===

Several parts of script files are executed multiple times. In general, the whole script file is read while loading the map. Declarations as well as function calls outside functions are executed at once. Later on the game will call special predefined function names at special occassions such as the creation of new game objects (called “gears”).

=== Important things to know ===

It is possible to play missions in multiplayer. However this requires all participating players to have the exact same version of the map files, including the `map.lua` script file. If this isn’t the case the game will probably desync and “kick” at least the one player using a different version of the map files. To avoid problems when running prepackaged maps, you should never modify any maps provided with the Hedgewars default package. Instead, create a copy of the existing map and modify this one. Feel free to share your work on the forums.

Another thing to note is the current status of our scripting implementation. Similar to the whole game, this is still work in progress and we can’t guarantee that scripts working in this version will run in future revisions of the game as we might extend, change or rename parts of the scripting engine.

=== Global variables/constants ===

Global variables are used by the game to interact with the scripts by passing and retrieving their values. While some of the variables are never read by the engine some allow you to modify the engine’s behaviour, e.g. the theme to be used for the current map.

=== Functions called by the game: Event handlers ===

After successfully loading the Lua script the game will call the following functions on different occasions. To be used, they have to use the exact same name as defined below.

== Data types ==

This section defines some commonly used non-primitive parameter types which are used in multiple functions. This section is a bit incomplete at the moment.

=== Color ===

Some functions take a `color` parameter.

Colors are stored in RGB or RGBA format and are specified as a three- or four-byte number, respecively.

In 3-byte (RGB) colors, each byte represents a color component. The value 0 means no intensity and 255 is largest intensity of the component.

The first byte is for the red component, the second byte for the green component and the third byte for the blue component.

Four-byte (RGBA) colors use the first 3 bytes for the color components (like for the 3-byte colors) and the fourth byte is used for opacity, where 255 means maximum opacity and 0 means fully transparent (also called the “alpha channel”).

Specifying the color number becomes much easier if you write it in hexadecimal notation.

Examples for RGB (3-byte) colors:

<code language="lua">

c = 0x000000 -- black (R, G, B are all 0)

c = 0xFF0000 -- red

c = 0x00FF00 -- green

c = 0x0000FF -- blue

c = 0xFFFFFF -- white

c = 0x808080 -- gray (50%)</code>

== Globally available variables and constants ==

The following variables are made available by Hedgewars in Lua and can be used to quickly query a value. Lua scripts schould normally *not* write to these variables, only read from them.

=== General variables and constants ===

Here are some unsorted variables or constants which are available in Lua. You shouldn’t write to most of them.

|| *Identifier* || *Description* ||

|| `LAND_WIDTH` || The width of the landscape in pixels ||

|| `LAND_HEIGHT` || The height of the landscape in pixels ||

|| `WaterLine` || The y position of the water, used to determine at which position stuff drowns. Use `SetWaterLine` to change. ||

|| `ClansCount` || Number of clans in the game (teams with the same color belong to one clan) ||

|| `TeamsCount` || Number of teams in the game ||

|| `TurnTimeLeft` || Number of game ticks (milliseconds) left until the current turn ends. You can change this variable directly. ||

|| `GameTime` || Number of total game ticks ||

|| `TotalRounds` || Number of rounds that have passed ||

|| `CurrentHedgehog` || The hedgehog gear that is currently in play ||

=== !GameFlags ===

The !GameFlags are used to store simple boolean settings of the game.

You can read/modify them using the [LuaAPI#GameFlags_functions GameFlags-Functions].

|| *Identifier* || *Description (active state)* ||

|| `gfOneClanMode` || Used when only one clan is in the game. This game flag is primarily used for training missions. ||

|| `gfMultiWeapon` || TODO (Used in training missions.) ||

|| `gfForts` || Fort Mode ||

|| `gfDivideTeams` || The teams will start at opposite sites of the terrain. Two clans maximum. ||

|| `gfBorder` || An indestructible border is active around the map. ||

|| `gfBottomBorder` || There is an indestructable border at the bottom of the map. ||

|| `gfShoppaBorder` || The terrain edge will be replaced by a decorative black/yellow “danger stripe”. This has no gameplay effect. ||

|| `gfSolidLand` || The terrain is indestructible. ||

|| `gfLowGravity` || The gravity is low. ||

|| `gfLaserSight` || A laser sight is almost always active. ||

|| `gfInvulnerable` || All hedgehogs are invulnerable. ||

|| `gfVampiric` || All hedgehogs become vampires and get 80% of the damage they deal as health. ||

|| `gfKarma` || Attackers share the damage they deal to enemies. ||

|| `gfArtillery` || Hedgehogs can’t walk. ||

|| `gfRandomOrder` || The game is played in random order. ||

|| `gfPlaceHog` || Placement mode: At the beginning of the round, all hedgehogs are placed manually first. ||

|| `gfKing` || King Mode: One hedgehog per team becomes their king, if the king dies, the team loses. ||

|| `gfSharedAmmo` || Teams in the same clan share their ammo. ||

|| `gfDisableGirders` || No girders will be created in random maps ||

|| `gfDisableLandObjects` || No land objects will be created in random maps ||

|| `gfAISurvival` || Computer-controlled hedgehogs will be revived after they die. ||

|| `gfInfAttack` || Attacks don’t end the turn. ||

|| `gfResetWeps` || The weapons will be reset to the initial state each turn. ||

|| `gfPerHogAmmo` || Each hedgehog has its own weapon stash. ||

|| `gfDisableWind` || There is no wind. ||

|| `gfMoreWind` || There is always strong wind. ||

|| `gfTagTeam` || Tag Team: Teams in the same clan share their turn time. ||

|| `gfResetHealth` || The health of all living hedgehogs is reset at the end of each turn. ||

=== Land flags ===

The land flags denote several types of terrain. Like all flags, they can be combined at will.

|| *Identifier* || *Meaning* ||

|| `lfIce` || Slippery terrain, hogs will slide on it. ||

|| `lfBouncy` || Bouncy terrain, hogs and some other gears will bounce off when they collide with it. ||

|| `lfIndestructible` || Almost indestructible terrain, most weapons will not destroy it. ||

|| `lfNormal` || Normal destroyable terrain. Note that this is only actually the case when no other land flag is set. ||

=== More constants ===

More constants are at at [GearTypes Gear Types] , [AmmoTypes Ammo Types], [Sounds], [States], [Sprites], [VisualGearTypes Visual Gear Types].

== Event handlers ==

Lua scripts are supposed to _define_ these functions to do something. The functions are then _called_ by Hedgewars when a certain even has occoured.

=== <tt>onGameInit()</tt> ===

This function is called before the game loads its resources. One can modify various game variables here:

 * <tt>Seed = 0</tt> - sets the seed of the random number generator

 * <tt>!GameFlags</tt> - all !GameFlags combined as a bitmask. See [LuaAPI#GameFlags_functions] for easier manipulation of !GameFlags

 * <tt>Ready = 5000</tt> - the ready timer at the start of the round (in milliseconds)

 * <tt>Delay = 0</tt> - delay between each round in ms

 * <tt>!GetAwayTime = 100</tt> set the retreat time in percent

 * <tt>!TurnTime = 60000</tt> - set the turn time in ms

 * <tt>!CaseFreq = 0</tt> - frequency of crate drops

 * <tt>!HealthCaseProb = 35</tt> - chance of receiving a health crate

 * <tt>!HealthCaseAmount = 25</tt> - amount of health in a health crate

 * <tt>!DamagePercent = 100</tt> - percent of damage to inforce

 * <tt>!MinesNum = 0</tt> - number of mines being placed (before 0.9.14 !LandAdds)

 * <tt>!MinesTime = 3000</tt> - time for a mine to explode from activated (in milliseconds), -1000 for random

 * <tt>!MineDudPercent = 0</tt> - chance of mine being a dud

 * <tt>Explosives = 0</tt> - number of explosives being placed

 * <tt>!SuddenDeathTurns = 30</tt> - turns until sudden death begins

 * <tt>!WaterRise = 47</tt> - height of water rise at sudden death in pixels

 * <tt>!HealthDecrease = 5</tt> - amount of health decreased on sudden death

 * <tt>Map = "Bamboo"</tt> - the map being played

 * <tt>Theme = "Bamboo"</tt> - the theme to be used

 * <tt>!MapGen</tt> - type of map generator. One of `mgRandom`, `mgMaze`, `mgPerlin`, `mgDrawn`.

 * <tt>!TemplateFilter</tt> - _unknown meaning_

 * <tt>!TemplateNumber</tt> - _unknown meaning_

 * <tt>!MapFeatureSize</tt> - Used by random maps to determine its “curvyness” or complexity. This value can be set by the user with the slider under the random map preview in the game setup screen. The user-set value ranges from 1 (leftmost position) to 25 (rightmost position).

If you want to add teams or hogs manually you have to do it here. If you want to draw your own map using `AddPoint` and `FlushPoints`, you have to do this within this function as well.

=== <tt>onGameStart()</tt> ===

This function is called when the first round starts.

Can be used to show the mission and for more setup, for example initial target spawning.

=== <tt>onPreviewInit()</tt> (0.9.21) ===

This function is called when the map preview in the frontend is initialized. This happens when the script is selected or you change a map generator parameter.

It is useful for scripts which create their own maps (see `AddPoint` and `FlushPoints`). If you create a map in this function, a preview will be generated from this map and is exposed to the frontend.

=== <tt>onParameters()</tt> (0.9.21) ===

This function is called when the script parameters (as specified in the game scheme) become available. The script parameter string is stored in the global variable `ScriptParam`.

Please note that it is normally not safe to call many of the other functions inside this function, this function is called very early in the game, only use this to initialize variables and other internal stuff like that.

*Tip*: If you use the Params library  (`/Scripts/Params.lua`), you can make the task of dissecting the string into useful values a bit easier, but it’s not required. (The Params library is not documented yet, however).

*Tip*: If you use this callback, make sure to document the interpretation of the parameters so others know how to set the parameters properly.

=== <tt>onGameTick()</tt> ===

This function is called on every game tick, i.e. 1000 times a second. If you just need to check on something periodically, consider `onGameTick20`.

=== <tt>onGameTick20()</tt> ===

This function is called every 20 game ticks, which equals 50 times a second. It reduces Lua overhead for simple monitoring that doesn’t need to happen every single tick.

=== <tt>onNewTurn()</tt> ===

This function calls at the start of every turn.

=== <tt>onGearAdd(gearUid)</tt> ===

This function is called when a new gear is added. Useful in combination with `GetGearType(gearUid)`.

=== <tt>onGearDelete(gearUid)</tt> ===

This function is called when a new gear is deleted. Useful in combination with `GetGearType(gearUid)`.

=== <tt>onGearDamage(gearUid, damage)</tt> ===

This function is called when a gear is damaged.

Example:

<code language="lua">    function onGearDamage(gear, damage)

        if (GetGearType(gear) == gtHedgehog) then

            -- adds a message saying, e.g. "Hoggy H took 25 points of damage"

            AddCaption(GetHogName(gear) .. ' took ' .. damage .. ' points of damage')

        end

    end</code>

=== <tt>onGearResurrect(gearUid) </tt> ===

This function is called when a gear is resurrected. CPU Hogs will resurrect if the !GameFlag `gfAISurvival` is enabled. Alternatively, specific gears can have `heResurrectable` set to true via `SetEffect`.

=== <tt>onAmmoStoreInit()</tt> ===

This function is called when the game is initialized to request the available ammo and ammo probabilities. Use `SetAmmo` here.

=== <tt>onNewAmmoStore(team/clan index, hog index)</tt> ===

This function is identical to `onAmmoStoreInit` in function, but is called once per ammo store.  This allows different ammo sets for each clan, team or hedgehog depending on the mode.

If `gfSharedAmmo` is set, the parameters passed are the clan index, and `-1`, and the function will be called once for each clan.

If `gfPerHogAmmo` is set, the parameters passed are the team index and the hog index in that team, and the function will be called once for each hedgehog.

If neither is set, the parameters passed are the team index and `-1`, and the function will be called once for each team.

These indexes can be used to look up details of the clan/team/hedgehog prior to gear creation. Routines to do these lookups will be created as needed.

If you add this hook, the expectation is that you will call SetAmmo appropriately. Any values from `onAmmoStoreInit` are ignored.

=== <tt>onGearWaterSkip(gear)</tt> (0.9.21) ===

This function is called when the gear `gear` skips over water.

=== <tt>onScreenResize()</tt> (0.9.16) ===

This function is called when you resize the screen. Useful place to put a redraw function for any `vgtHealthTags` you're using.

=== <tt>onAttack()</tt> ===

This function is called when your Hedgehog attacks.

=== <tt>onHJump()</tt> ===

This function is called when you press the high jump key.

=== <tt>onLJump()</tt> ===

This function is called when you press the long jump key.

=== <tt>onPrecise()</tt> ===

This function is called when you press the precise key.

=== <tt>onLeft()</tt> ===

This function is called when you press the left key.

=== <tt>onRight()</tt> ===

This function is called when you press the right key.

=== <tt>onUp()</tt> ===

This function is called when you press the up key.

=== <tt>onDown()</tt> ===

This function is called when you press the down key.

=== <tt>onAttackUp()</tt> ===

This function is called when you release the attack key.

=== <tt>onDownUp()</tt> ===

This function is called when you release the down key.

=== <tt>onHogAttack(ammoType)</tt> ===

This function is called when you press the attack key. Beginning with 0.9.21, the parameter `ammoType` is provided. It contains the ammo type of the weapon used for the attack.

=== <tt>onLeftUp()</tt> ===

This function is called when you release the left key.

=== <tt>onPreciseUp()</tt> ===

This function is called when you release the precise key.

=== <tt>onRightUp()</tt> ===

This function is called when you release the right key.

=== <tt>onSetWeapon(msgParam)</tt> ===

It is get called when a weapon is selected or switched.

`msgParam` tells you which ammo type was selected.

=== <tt>onSlot(msgParam)</tt> ===

This function is called when one of the weapon slot keys has been pressed.

`msgParam` tells the slot number minus 1 (i.e. `0` is for slot number 1, `1` is for slot number 2, etc.).

=== <tt>onSwitch()</tt> ===

This function is called when a hog is switched to another.

=== <tt>onTaunt(msgParam)</tt> ===

This function is called when the player uses an animated emote for example by using the chat commands `/wave`, `/juggle`, etc.

`msgParam` tells you which animation was played:

|| *`msgParam`* || *Animation* || *Associated chat command* ||

|| 0 || Rolling up || `/rollup` ||

|| 1 || Sad face || `/sad` ||

|| 2 || Waving hand || `/wave` ||

|| 3 || Stupid winner's grin / “Awesome” face || `/hurrah` ||

|| 4 || Peeing || `/ilovelotsoflemonade` ||

|| 5 || Shrug || `/shrug` ||

|| 6 || Juggling || `/juggle` ||

=== <tt>onTimer(msgParam)</tt> ===

This function is called when one of the timer keys is pressed.

`msgParams` tells the set timer in seconds (i.e. `3` for the 3 seconds timer key).

=== <tt>onUpUp()</tt> ===

This function is called when you release the up key.

=== <tt>onHogHide()</tt> (0.9.16) ===

This function is called when a hedgehog is hidden (removed from the map).

=== <tt>onHogRestore()</tt> (0.9.16) ===

This function is called when a hedgehog is restored (unhidden).

=== <tt>onSpritePlacement(spriteId, centerX, centerY)</tt> (0.9.21) ===

This function is called when a [Sprites Sprite] has been placed.

`spriteID` is the type of the sprite, you find a list at [Sprites Sprites]. `centerX` and `centerY` are the coordinates of the center of the sprite.

=== <tt>onGirderPlacement(frameIdx, centerX, centerY)</tt> (0.9.21) ===

This function is called when a girder has been placed.

`frameIdx` is an integer and declares the length and orientation of the girder:

|| *`frameIdx`* || *Length* || *Orientation* ||

|| 0 || short || horizontal ||

|| 1 || short || decreasing right ||

|| 2 || short || vertical ||

|| 3 || short || increasing right ||

|| 4 || long || horizontal ||

|| 5 || long || decreasing right ||

|| 6 || long || vertical ||

|| 7 || long || increasing right ||

`centerX` and `centerY` are the coordinates of the girder’s center.

=== <tt>onRubberPlacement(frameIdx, centerX, centerY)</tt> (0.9.21) ===

This function is called when a rubber has been placed.

`frameIdx` is an integer which stands for the orientation of the rubber.

|| *`frameIdx`* || *Orientation* ||

|| 0 || horizontal ||

|| 1 || decreasing right ||

|| 2 || vertical ||

|| 3 || increasing right ||

`centerX` and `centerY` are the coordinates of the rubber’s center.

== Functions for creating gears ==

=== <tt>!AddGear(x, y, gearType, state, dx, dy, timer)</tt> ===

This creates a new gear at position x,y (measured from top left) of kind `gearType` (see [GearTypes Gear Types]). The initial velocities are `dx` and `dy`. All arguments are numbers. The function returns the `uid` of the gear created. Gears can have multple states at once: `state` is a bitmask, the flag variables can be found in [States].

Example:

<code language="lua">    local gear = AddGear(0, 0, gtTarget, 0, 0, 0, 0)

    FindPlace(gear, true, 0, LAND_WIDTH)</code>

=== <tt>!AddVisualGear(x, y, visualGearType, state, critical)</tt> ===

This creates a new visual gear at position x,y (measured from top left) of kind `visualGearType` (see [VisualGearTypes Visual Gear Types]). The function returns the `uid` of the visual gear created.  Set `critical` to `true` if the visual gear is crucial to game play. Use `false` if it is just an effect, and can be skipped when in fast-forward mode (such as when joining a room). A critical visual gear will always be created, a non-critical one may fail. Most visual gears delete themselves. 

Example:

<code language="lua">  -- adds an non-critical explosion at position 1000,1000. Returns 0 if it was not created.

    vgear = AddVisualGear(1000, 1000, vgtExplosion, 0, false) 

</code>

=== <tt>!SpawnHealthCrate(x, y)</tt> ===

Spawns a health crate at the specified position. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

=== <tt>!SpawnAmmoCrate(x, y, ammoType)</tt> ===

Spawns an ammo crate at the specified position with content of ammoType (see [AmmoTypes Ammo Types]). If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

Because by default settings the number of ammo in crates is zero it has to be increased to at least one with `SetAmmo` first, see the example:

Example:

<code language="lua">    SetAmmo(amGrenade, 0, 0, 0, 1) -- see below

    SpawnAmmoCrate(0, 0, amGrenade) -- x=y=0 means random position on map</code>

=== <tt>!SpawnUtilityCrate(x, y, ammoType)</tt> ===

Spawns an utility crate at specified position with content of ammoType. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

Example:

<code language="lua">    SetAmmo(amLaserSight, 0, 0, 0, 1)

    SpawnUtilityCrate(0, 0, amLaserSight)</code>

=== <tt>!SpawnFakeAmmoCrate(x, y, explode, poison) </tt> ===

Spawns a crate at the specified coordinates which looks exactly like a real ammo crate but contains not any ammo. It can be use useful for scripted events or to create a trap. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

`explode` and `poison` are booleans.

If `explode` is `true`, the crate will explode when collected.

If `poison` is `true`, the collector will be poisoned.

Example:

<code language="lua">SpawnFakeAmmoCrate(500, 432, false, false) -- Spawns a fake ammo crate at the coordinates (500, 434) without explosion and poison.

</code>

=== <tt>!SpawnFakeHealthCrate(x, y, explode, poison) </tt> ===

Spawns a crate at the specified coordinates which looks exactly like a real health crate but it will not heal the player. It can be use useful for scripted events or to create a trap. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

`explode` and `poison` are booleans.

If `explode` is `true`, the crate will explode when collected.

If `poison` is `true`, the collector will be poisoned.

=== <tt>!SpawnFakeUtilityCrate(x, y, explode, poison) </tt> ===

Spawns a crate at the specified coordinates which looks exactly like a real utility crate but contains not any ammo. It can be use useful for scripted events or to create a trap. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land).

`explode` and `poison` are booleans.

If `explode` is `true`, the crate will explode when collected.

If `poison` is `true`, the collector will be poisoned.

=== <tt>!AddHog(hogname, botlevel, health, hat)</tt> ===

Adds a new hedgehog for current team (last created one with the `AddTeam` function), with bot level and specified health, also hat.

`botlevel` ranges from `0` to `5`, where `0` denotes a human player and `1` to `5` denote the skill level of a bot, where `1` is strongest and `5` is the weakest. Note that this is the reverse order of how the bot level is displayed in the game.

*Warning*: This works only for singleplayers training missions for now and will desync multiplayer games.

Example:

<code language="lua">    local player = AddHog("HH 1", 0, 100, "NoHat") -- botlevel 0 means human player

    SetGearPosition(player, 1500, 1000)</code>

== Functions to get gear properties ==

=== <tt>!GetGearType(gearUid)</tt> ===

This function returns one of [GearTypes Gear Types] for the specified gear.

=== <tt>!GetGearPosition(gearUid)</tt> ===

Returns x,y coordinates for the specified gear.

=== <tt>!GetGearRadius(gearUid)</tt> ===

Returns radius for the specified gear.

=== <tt>!GetGearVelocity(gearUid)</tt> ===

Returns a tuple of dx,dy values for the specified gear.

=== <tt>!GetFlightTime(gearUid)</tt> ===

Returns the `FlightTime` of the specified gear. The `FlightTime` is a gear varialbe used to store a general time interval. The precise meaning of the `FlightTime` depends on the gear type.

For example: The `FlightTime` of a hedgehog (`gtHedgehog`) is the time since they last have stood on solid ground. For most projectile gear types (i.e. `gtShell`), it stores the time after it has been launched.

=== <tt>!GetGearElasticity(gearUid) </tt> ===

Returns the elasticity of the specified gear. The elasticity normally determines how strong the gear will bounce after collisions, where higher elasticity is for stronger bounces.

This is also useful for determining if a hog is on a rope or not. If a hog is attached to a rope, or is busy firing one, the elasticity of the rope will be non-zero.

=== <tt>!GetGearFriction(gearUid) </tt> ===

Returns the friction of the specified gear. The friction normally determines how well the gear will slide on terrain. Higher values are for increased sliding properties.

=== <tt>!GetHogClan(gearUid)</tt> ===

Returns the clan ID of the specified hedgehog gear.

=== <tt>!GetHogTeamName(gearUid)</tt> ===

Returns the name of the specified hedgehog gear’s team.

=== <tt>!GetHogName(gearUid)</tt> ===

Returns the name of the specified hedgehog gear.

=== <tt>!GetEffect(gearUid, effect)</tt> ===

Returns the state of given effect for the given hedgehog gear.

See `SetEffect` for further details.

=== <tt>!GetHogHat(gearUid)</tt> ===

Returns the hat of the specified hedgehog gear.

=== <tt>!GetHogFlag(gearUid)</tt> (0.9.22) ===

Returns the name of the flag of the team of the specified hedgehog gear.

=== <tt>!GetHogGrave(gearUid)</tt> (0.9.22) ===

Returns the name of the grave of the team of the specified hedgehog gear.

=== <tt>!GetHogVoicepack(gearUid)</tt> (0.9.22) ===

Returns the name of the voicepack of the team of the specified hedgehog gear.

=== <tt>!GetAmmoCount(gearUid, ammoType) (0.9.16)</tt> ===

Returns the ammo count of the specified ammo type for the specified hedgehog gear.

=== <tt>!GetGearTarget(gearUid, x, y)  (0.9.16)</tt> ===

Returns the x and y coordinate of target-based weapons/utilities. 

<b>Note:</b>: This can’t be used in `onGearAdd()` but must be called after gear creation. 

=== <tt>GetX(gearUid)</tt> ===

Returns x coordinate of the gear.

=== <tt>GetY(gearUid)</tt> ===

Returns y coordinate of the gear.