LuaGears.wiki
author Wuzzy
Fri, 19 Apr 2019 23:43:07 +0100
changeset 1843 5bc2abb28338
parent 1841 2c6019a41474
child 1849 60249ab531df
permissions -rw-r--r--
LuaGUI: Add label
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1759
6725a497c482 LuaGears: Fix summary
Wuzzy
parents: 1758
diff changeset
     1
#summary List of gear-related functions in the Lua API
1841
2c6019a41474 LuaGears: Add label
Wuzzy
parents: 1832
diff changeset
     2
#labels !LuaFunctions
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
= Lua API: Gear functions =
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
     5
This is a list of all functions in the [LuaAPI Lua API] that are related to gears and visual gears.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
     6
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
     7
Gears are dynamic objects or events in the world that affect the gameplay, including hedgehogs, projectiles, weapons, land objects, active utilities and a few more esoteric things. Visual gears are decorational objects which are usually used for purely decorational graphical effects. They have no effect on gameplay. Visual gears are not the same as gears, but they share some similarities.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
     8
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
     9
Refer to [LuaGuide] for a more detailed introduction into gears.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
1758
eda4a2277089 LuaGears: Fix syntax
Wuzzy
parents: 1755
diff changeset
    11
<wiki:toc max_depth="3"/>
1755
b3ce3b8bc36d LuaGears: Add TOC
Wuzzy
parents: 1749
diff changeset
    12
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    13
== Creation ==
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
1832
d975c5b3bc4c LuaGears: Remove mistake from previous commit (test was successful)
Wuzzy
parents: 1831
diff changeset
    15
=== `AddGear(x, y, gearType, state, dx, dy, timer)` ===
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    16
This creates a new gear at position x,y (measured from top left) of kind `gearType` (see [GearTypes Gear Types]).
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    17
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]. `timer` is the initial timer value of the gear. If a particular gear value does not matter, use `0`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    18
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    19
Position, velocity, state and timer can be changed afterwards with the various setter functions.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    20
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    21
Note: If you want to create a hedgehog (`gtHedgehog`), you must call `AddHog` or `AddMissionHog` instead. If you want to spawn a crate (`gtCase`), you must call one of the several “Spawn*Crate” functions (e.g. `SpawnSupplyCrate`) below instead.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    25
<code language="lua">    -- Spawn a target at (0,0) and place it randomly
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    26
    local gear = AddGear(0, 0, gtTarget, 0, 0, 0, 0) -- also use 0 for velocity. Also 0 for state and timer because they don't matter.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
    FindPlace(gear, true, 0, LAND_WIDTH)</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    28
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    29
=== `AddVisualGear(x, y, visualGearType, state, critical [, layer])` ===
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
    30
This attempts to create a new visual gear at position x,y (measured from top left) of kind `visualGearType` (see [VisualGearTypes Visual Gear Types]).
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    31
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    32
The function returns the `uid` of the visual gear created or `nil` if creation failed.  There is no guarantee that a visual gear will spawn.  *IMPORTANT: Do not rely on visual gears to spawn*. *Always* be prepared for this function to return `nil`.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    33
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    34
Set `critical` to `true` if the visual gear is crucial to gameplay and must always be spawned when in-game.  Use `false` if it is just an effect or eye-candy, and its creation can be skipped when in fast-forward mode (such as when joining a room).
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    35
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    36
You can set an optional `layer` to specify which visual gears get drawn on top.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    37
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    38
Most visual gears delete themselves eventually.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    39
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    40
*NOTE:* Visual gears *must* only be used for decorational/informational/rendering purposes. *Never* use the visual gear's internal state to manipulate anything gameplay-related. Visual gears are not safe for reliable storage and using them as that would lead to strange bugs.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    41
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    42
*NOTE:* Since 0.9.25, visual gears will never spawn when Hedgewars is run in a testing mode (i.e. not as the real game), so don't rely for visual gears to spawn even if they're critical.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    43
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    44
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    45
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    46
<code language="lua">  -- adds an non-critical explosion at position 1000,1000. Returns 0 if it was not created.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    47
    local vgear = AddVisualGear(1000, 1000, vgtExplosion, 0, false) 
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    48
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    49
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    50
=== `AddHog(hogname, botlevel, health, hat)` ===
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    51
Adds a new hedgehog for current team (last created one with the `AddTeam` function), with a bot level, an initial health and a hat.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    52
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    53
`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. Note that mixing human-controlled and computer-controlled hedgehogs in the same team is not permitted, but it is permitted to use different computer difficulty levels in the same team.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    54
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    55
Returns the gear ID.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    56
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    57
*Warning*: This only works in singleplayer mode (e.g. missions). Also, Hedgewars only supports up to 64 hedgehogs in a game.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    58
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    59
Example:
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    60
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    61
<code language="lua">    local player = AddHog("HH 1", 0, 100, "NoHat") -- botlevel 0 means human player
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    62
    SetGearPosition(player, 1500, 1000)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    63
    -- hint: If you don't call `SetGearPosition`, the hog spawns randomly</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    64
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    65
=== `AddMissionHog(health)` (0.9.25) ===
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    66
Add a hedgehog for the current team, using the player-chosen team identity when playing in singleplayer missions. The “current team” is the last team that was added with `AddMissionTeam` or `AddTeam`.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    67
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    68
The name and hat match the player's team definition. The hog is also always player-controlled.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    69
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    70
Examples:
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    71
<code language="lua">-- Add player team with 3 hogs
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    72
AddMissionTeam(-1)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    73
AddMissionHog(100)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    74
AddMissionHog(100)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    75
AddMissionHog(100)</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    76
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    77
<code language="lua">-- You can also mix mission hogs with “hardcoded” hogs.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    78
-- This adds a player team with 2 hogs taken from the player team and 1 hog with a hardcoded name, botlevel and hat.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    79
AddMissionTeam(-2)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    80
AddMissionHog(100)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    81
AddMissionHog(100)
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    82
AddHog("My Hardcoded Hog", 0, 100, "NoHat")
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    83
</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
    84
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    85
=== `SpawnHealthCrate(x, y, [, health])` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    86
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). Set `health` for the initial health contained in the health crate. If not set, the default health (`HealthCaseAmount`) is used. Do not use a negative value for `health`.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    87
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    88
=== `SpawnSupplyCrate(x, y, ammoType [, amount])` (0.9.24) ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    89
Spawns an ammo or utility crate at the specified position with the given ammo type and an optional amount (default: 1). The crate type is chosen automatically based on the ammo type.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    90
Otherwise, this function behaves like `SpawnAmmoCrate`.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    91
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
    92
=== `SpawnAmmoCrate(x, y, ammoType [, amount])` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    93
Spawns an ammo crate at the specified position with content of `ammoType` (see [AmmoTypes Ammo Types]). Any `ammoType` is permitted, an ammo crate is spawned even if the ammo is normally defined as an utility.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    94
If `ammoType` is set to `amNothing`, a random weapon (out of the available weapons from the weapon scheme) will be selected. If `x` and `y` are set to 0, the crate will spawn on a random position (but always on land). The `amount` parameter specifies the amount of ammo contained in the crate. If `amount` is `nil` or `0`, the value set by `SetAmmo` is used, or if `SetAmmo` has not been used, it falls back to the weapon scheme's value. If `amount` is equal to or greater than `AMMO_INFINITE`, the amount is infinite.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    95
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    96
Note that in Lua missions, the default number of ammo in crates is 0, so it has to be set to at least 1 with `SetAmmo` first, see the example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    97
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    98
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
    99
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   100
<code language="lua">    SetAmmo(amGrenade, 0, 0, 0, 1) -- grenade ammo crates now contain 1 grenade each
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   101
    SpawnAmmoCrate(0, 0, amGrenade) -- spawn grenade ammo crate at random position</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   102
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   103
=== `SpawnUtilityCrate(x, y, ammoType [, amount])` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   104
Spawns an utility crate with some ammo at the specified position. The function behaves almost like `SpawnAmmoCrate`, the differences are 1) the crate looks different and 2) if `ammoType` is set to `amNothing`, a random utility out of the set of available utilities from the weapon scheme is chosen as content.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   105
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   106
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   107
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   108
<code language="lua">    SetAmmo(amLaserSight, 0, 0, 0, 1)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   109
    SpawnUtilityCrate(0, 0, amLaserSight)</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   110
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   111
=== `SpawnFakeAmmoCrate(x, y, explode, poison) ` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   112
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).
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   113
`explode` and `poison` are booleans.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   114
If `explode` is `true`, the crate will explode when collected.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   115
If `poison` is `true`, the collector will be poisoned.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   116
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   117
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   118
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   119
<code language="lua">SpawnFakeAmmoCrate(500, 432, false, false) -- Spawns a fake ammo crate at the coordinates (500, 434) without explosion and poison.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   120
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   121
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   122
=== `SpawnFakeHealthCrate(x, y, explode, poison) ` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   123
Same as `SpawnFakeAmmoCrate`, except the crate will look like a health crate.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   124
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   125
=== `SpawnFakeUtilityCrate(x, y, explode, poison) ` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   126
Same as `SpawnFakeAmmoCrate`, except the crate will look like an utility crate.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   127
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   128
== Position and velocity ==
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   129
=== `GetGearPosition(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   130
Returns x,y coordinates for the specified gear. Not to be confused with `GetGearPos`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   131
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   132
=== `GetX(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   133
Returns x coordinate of the gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   134
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   135
=== `GetY(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   136
Returns y coordinate of the gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   137
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   138
=== `SetGearPosition(gearUid, x, y)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   139
Places the specified gear exactly at the position (`x`,`y`). Not to be confused with `SetGearPos`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   140
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   141
=== `GetGearVelocity(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   142
Returns a tuple of dx,dy values for the specified gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   143
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   144
=== `SetGearVelocity(gearUid, dx, dy)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   145
Gives the specified gear the velocity of `dx`, `dy`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   146
1793
b549350dca64 LuaGears: Update arg names for CopyPV
Wuzzy
parents: 1792
diff changeset
   147
=== `CopyPV(fromGearUid, toGearUid)` ===
b549350dca64 LuaGears: Update arg names for CopyPV
Wuzzy
parents: 1792
diff changeset
   148
When given two gears as arguments, this sets the position and velocity of `toGearUid` to the position and velocity of `fromGearUid`.
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   149
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   150
=== `FindPlace(gearUid, fall, left, right[, tryHarder])` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   151
Finds a place for the specified gear between x=`left` and x=`right` and places it there. `tryHarder` is optional, setting it to `true`/`false` will determine whether the engine attempts to make additional passes, even attempting to place gears on top of each other.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   152
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   153
Example:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   154
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   155
<code language="lua">    gear = AddGear(...)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   156
    FindPlace(gear, true, 0, LAND_WIDTH) -- places the gear randomly between 0 and LAND_WIDTH</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   157
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   158
== General gear properties ==
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   159
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   160
=== `GetGearType(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   161
This function returns the [GearTypes gear type] for the specified gear, if it exists.  If it doesn't exist, `nil` is returned.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   162
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   163
=== `GetVisualGearType(vgUid)` (0.9.23) ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   164
This function returns the [VisualGearTypes visual gear type] for the specified visual gear, if it exists.  If it doesn't exist, `nil` is returned.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   165
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   166
=== `GetState(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   167
Returns the state of the gear. The gear state is a bitmask which is built out of the variables as shown in [States].
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   168
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   169
This function is usually used in combination with `band` to extract the truth value of a single flag. It is also used together with `SetState` and `bor` in order to activate a single flag.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   170
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   171
Examples:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   172
<code language="lua">
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   173
local state = GetState(gear)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   174
--[[ Stores the full raw bitmask of gear in state. Usually
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   175
useless on its own. ]]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   176
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   177
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   178
<code language="lua">
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   179
isDrowning = band(GetState(CurrentHedgehog),gstDrowning) ~= 0
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   180
--[[ GetState(CurrentHedgehog) returns the state bitmask of
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   181
CurrentHedgehog, gstDrowning is a bitmask where only the
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   182
“drowning” bit is set. band does a bitwise AND on both, if
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   183
it returns a non-zero value, the hedgehog is drowning.]]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   184
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   185
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   186
<code language="lua">
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   187
SetState(CurrentHedgehog, bor(GetState(CurrentHedgehog), gstInvisible))
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   188
--[[ first the state bitmask of CurrentHedgehog is bitwise ORed with
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   189
the gstInvisible flag, thus making the bit responsible for
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   190
invisiblity to become 1. Then the new bitmask is applied to
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   191
CurrentHedgehog, thus making it invisible.]]
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   192
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   193
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   194
=== `SetState(gearUid, state)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   195
Sets the state of the specified gear to the specified `state`. This is a bitmask made out of the variables as seen in [States].
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   196
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   197
This function is often used together with `GetState` and the bitmask utility functions `band` and `bnot` in order to manipulate a single flag.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   198
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   199
Examples:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   200
<code language="lua">
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   201
SetState(CurrentHedgehog, bor(GetState(CurrentHedgehog), gstInvisible))
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   202
--[[ first the state bitmask of CurrentHedgehog is bitwise ORed with
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   203
the gstInvisible flag, thus making the bit responsible for
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   204
invisiblity to become 1. Then the new bitmask is applied to
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   205
CurrentHedgehog, thus making it invisible. ]]
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   206
</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   207
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   208
<code language="lua">
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   209
SetState(CurrentHedgehog, band(GetState(CurrentHedgehog), bnot(gstInvisible)))
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   210
--[[ The reverse of the above: This function toggles CurrentHedgehog’s
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   211
gstInvisible flag off, thus making it visible again. ]]
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   212
</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   213
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   214
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   215
=== `GetGearMessage(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   216
Returns the message of the gear. This is a bitmask built out of flags seen in [GearMessages].
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   217
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   218
=== `SetGearMessage(gearUid, message)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   219
Sets the gear messages of the specified gear. `message` is a bitmask built out of flags seen in [GearMessages].
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   220
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   221
=== `GetTag(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   222
Returns the tag of the specified gear (by `gearUid`). 
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   223
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   224
The `Tag` of a gear is just another arbitrary variable to hold the gear's state. The meaning of a tag depends on the gear type. For example, for `gtBall` gears, it specifies the ball color, for `gtAirAttack` gears (airplane) it specifies the direction of the plane, etc. See [GearTypes] for a full list. The returned value will be an integer.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   225
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   226
Note that the word “tag” here does _not_ refer to the name and health tags you see above hedgehogs, this is something different. 
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   227
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   228
<code language="lua">
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   229
-- This adds a ball (the one from the ballgun) at (123, 456):
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   230
ball = AddGear(123, 456, gtBall, 0, 0, 0, 0)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   231
-- The tag of a ball defines its color. It will automatically chosen at random when created.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   232
colorTag = GetTag(ball)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   233
-- Now colorTag stores the tag of ball (in this case a number denoting its color)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   234
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   235
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   236
The meaning of tags are described in [GearTypes].
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   237
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   238
=== `SetTag(gearUid, tag)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   239
Sets the `Tag` value of the specified gear (by `gearUid`). The `Tag` value of a gear is simply an extra variable to modify misc. things. The meaning of a tag depends on the gear type. For example, for `gtBall` gears, it specifies the ball color, for `gtAirAttack` gears (airplane) it specifies the direction of the plane, etc. See [GearTypes] for a full list. `tag` has to be an integer.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   240
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   241
Note that the word “tag” here does _not_ refer to the name and health tags you see above hedgehogs, this is something different. 
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   242
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   243
<code language="lua">
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   244
-- This adds a ball (the one from the ballgun) at (123, 456):
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   245
ball = AddGear(123, 456, gtBall, 0, 0, 0, 0)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   246
-- This sets the tag of the gear. For gtBall, the tag specified the color. “8” is the color white.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   247
SetTag(ball, 8) -- 
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   248
</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   249
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   250
The meaning of tags are described in [GearTypes].
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   251
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   252
=== `GetTimer(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   253
Returns the timer of the gear. This is for example the time it takes for watermelon, mine, etc. to explode. This is also the time used to specify the blowtorch or RC plane time. See [GearTypes] for a full list.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   254
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   255
=== `SetTimer(gearUid, timer)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   256
Sets the timer of the specified gear. Also see `GetTimer`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   257
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   258
=== `GetHealth(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   259
Returns the health of the gear. Depending on the gear type, the gear's “health” can also refer to other things, see [GearTypes] for a full list.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   260
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   261
=== `SetHealth(gearUid, health)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   262
Sets the health of the specified gear. The “health” of a gear can refer to many things, depending on the gear type.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   263
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   264
*Hint*: If you like to increase the health of a hedgehog with nice visual effects, consider using `HealHog` instead.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   265
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   266
Use cases:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   267
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   268
  * Setting the health of a hedgehog (`gtHedgehog`) to 99
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   269
  * Starting the RC Plane (`gtRCPlane`) with 10 bombs
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   270
  * Starting flying saucer (`gtJetpack`) with only 50% fuel
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   271
  * Setting all the mines (`gtMine`) to duds
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   272
  * And more!
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   273
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   274
See [GearTypes] for a full description.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   275
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   276
<code language="lua">    function onGearAdd(gear)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   277
       if (GetGearType(gear) == gtHedgehog) then
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   278
            -- Set hedgehog health to 99
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   279
            SetHealth(gear, 99)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   280
       end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   281
       if (GetGearType(gear) == gtRCPlaane) then
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   282
            -- Give the plane 10 bombs
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   283
            SetHealth(gear, 10)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   284
       end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   285
       if (GetGearType(gear) == gtJetpack) then
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   286
            -- Set fuel to 50% only
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   287
            SetHealth(gear, 1000)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   288
       end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   289
       if (GetGearType(gear) == gtMine) then
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   290
            -- Turn mine into dud
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   291
            SetHealth(gear, 0)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   292
       end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   293
    end</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   294
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   295
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   296
=== `GetGearPos(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   297
Get the `Pos` value of the specified gear. `Pos` is just another arbitrary value to hold the state of the gear, such as `Tag` and `Health`, the meaning depends on the gear type. See [GearTypes] for the conrete meaning of a gear's `Pos` value. 
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   298
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   299
*Important*: Pos is *not* related to the gear's position, use `GetGearPosition` for that.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   300
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   301
=== `SetGearPos(gearUid, value)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   302
Sets the `Pos` value (not the position!) of the specified gear to specified value. See `GetGearPos` for more information.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   303
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   304
=== `GetGearCollisionMask(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   305
Returns the current collision mask of the given gear. See `SetGearCollisionMask` for an explanation of the mask.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   306
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   307
=== `SetGearCollisionMask(gearUid, mask)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   308
Set the collision mask of the given gear with `gearUid`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   309
The collision mask defines with which gears and terrain types the gear can collide.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   310
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   311
`mask` is a number between `0x0000` and `0xFFFF` and used as a bitfield, which means you can combine these flags with `bor`. These are the available flags:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   312
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   313
|| *Identifier* || *Collision with …* ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   314
|| `lfLandMask` || Terrain ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   315
|| `lfCurHogCrate` || Current hedgehog, and crates ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   316
|| `lfHHMask` || Any hedgehogs ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   317
|| `lfNotHHObjMask` || Objects, not hogs (e.g. mines, explosives) ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   318
|| `lfAllObjMask` || Hedgehogs and objects ||
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   319
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   320
Beware, the collision mask is often set by the engine as well.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   321
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   322
Examples:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   323
<code language="lua">SetGearCollisionMask(gear, bnot(lfCurHogCrate))
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   324
-- Ignore collision with current hedgehog</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   325
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   326
<code language="lua">SetGearCollisionMask(gear, 0xFFFF)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   327
-- Collide with everything</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   328
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   329
<code language="lua">SetGearCollisionMask(gear, lfAllObjMask)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   330
-- Collide with hedgehogs and objects</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   331
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   332
<code language="lua">SetGearCollisionMask(gear, 0x0000)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   333
-- Collide with nothing</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   334
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   335
There are actual more flags availbable, but they are not as useful for use in Lua and their constants have not been exposed to Lua. You can find the full range of flags in the engine source code (in Pascal):
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   336
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   337
[https://hg.hedgewars.org/hedgewars/file/default/hedgewars/uConsts.pas#l112]
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   338
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   339
=== `GetGearRadius(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   340
Returns the `Radius` value for the specified gear. For most [GearTypes gear types] for “projectile” gears (like `gtShell` or `gtGrenade`), the radius refers to the gear's collision radius. This is an invisible circle around the center of the gear which is used for the collision checks. For a few gear types, its radius means something different, see [GearTypes] for a full list.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   341
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   342
To set the `Radius` value, use `SetGearValues`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   343
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   344
=== `GetFlightTime(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   345
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.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   346
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   347
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.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   348
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   349
=== `SetFlightTime(gearUid, flighttime)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   350
Sets the `FlightTime` of the given gear to `flighttime`. The meaning of `FlightTime` is explained in the section `GetFlightTime`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   351
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   352
=== `GetGearElasticity(gearUid) ` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   353
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.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   354
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   355
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 a non-zero number.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   356
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   357
=== `SetGearElasticity(gearUid, Elasticity) ` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   358
Sets the elasticity of the specified gear. For most gears, the elasticity determines how strong the gear will bounce after collisions, where higher elasticity is for stronger bounces. Recommended are values between `0` and `9999`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   359
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   360
=== `GetGearFriction(gearUid) ` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   361
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.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   362
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   363
=== `SetGearFriction(gearUid, Friction) ` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   364
Sets 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. `0` is for no sliding whatsoever, where `9999` is for very long slides, greater values are not recommended.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   365
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   366
=== `GetGearTarget(gearUid, x, y) ` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   367
Returns the x and y coordinate of target-based weapons/utilities. 
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   368
<b>Note:</b>: This can’t be used in `onGearAdd()` but must be called after gear creation. 
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   369
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   370
=== `SetGearTarget(gearUid, x, y)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   371
Sets the x and y coordinate of target-based weapons/utilities.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   372
*Note*: This can’t be used in onGearAdd() but must be called after gear creation.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   373
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   374
=== `GetGearValues(gearUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   375
This returns a bunch of values associated with the gear, their meaning is often depending on the gear type and many values might be unused for certain gear types.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   376
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   377
This is returned (all variables are integers):
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   378
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   379
`Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, nImpactSounds, Tint, Damage, Boom`
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   380
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   381
A rough description of some of the parameters:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   382
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   383
 * `Radius`: Effect or collision radius, most of the time
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   384
 * `ImpactSound`: Sound it makes on a collision (see [Sounds])
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   385
 * `Tint`: Used by some gear types to determine its colorization. The color is in RGBA format.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   386
 * `Boom`: Used by most gears to determine the damage dealt.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   387
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   388
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   389
<code language="lua">
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   390
-- Get all values in a single line of code:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   391
local Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, nImpactSounds, Tint, Damage, Boom, Scale = GetGearValues(myGear)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   392
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   393
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   394
=== `SetGearValues(gearUid, Angle, Power, WDTimer, Radius, Density, Karma, DirAngle, AdvBounce, ImpactSound, ImpactSounds, Tint, Damage, Boom)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   395
Sets various gear value for the specified gear (`gearUid`). The meaining of each value often depends on the gear type. See the documentation on !GetGearValues for a brief description of the gear values. If `gearUid` is invalid or the gear does not exist, nothing happens.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   396
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   397
Set `nil` for each value you do not want to change.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   398
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   399
Example:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   400
<code language="lua">
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   401
-- Paints all RC planes into a white color
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   402
function onGearAdd(gear)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   403
    if GetGearType(gear) == gtRCPlane then
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   404
         SetGearValues(gear, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, 0xFFFFFFFF)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   405
    end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   406
end
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   407
</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   408
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   409
=== `GetVisualGearValues(vgUid)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   410
This returns the typically set visual gear values for the specified visual gear `vgUid`, useful if manipulating things like smoke, bubbles or circles. On success, it returns the following values:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   411
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   412
`X, Y, dX, dY, Angle, Frame, FrameTicks, State, Timer, Tint, Scale`
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   413
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   414
The meaning of these values is the same as in `SetVisualGearValues`.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   415
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   416
If the visual gear does not exist, `nil` is returned. Always check the result for `nil` before you plug in the values anywhere.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   417
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   418
Most visual gears require little to no modification of parameters.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   419
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   420
Example:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   421
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   422
<code language="lua">-- Return visual gear values
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   423
local X, Y, dX, dY, Angle, Frame, FrameTicks, State, Timer, Tint, Scale = GetVisualGearValues(vgUid)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   424
</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   425
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   426
=== `SetVisualGearValues(vgUid, X, Y, dX, dY, Angle, Frame, !FrameTicks, State, Timer, Tint, Scale)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   427
This allows manipulation of the internal state of the visual gear `vgUid`. If `vgUid` is invalid or the `vgUid` does not refer to an existing visual gear, the function does nothing. Thus, you can safely call this function even if you are not sure if the visual gear actually exists.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   428
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   429
All visual gear values are numbers. Each visual gear may be using these parameters differently, but the *usual* meaning of these is the following:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   430
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   431
 * `X`, `Y`: Position
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   432
 * `dX`, `dY`: Speed along the X and Y axis
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   433
 * `Angle`: Current rotation
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   434
 * `Frame`: Image frame, if using a sprite sheet
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   435
 * `FrameTicks` is usually an animation counter
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   436
 * `State`: Helper value to save some internal state
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   437
 * `Timer`: Time in milliseconds until it expires
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   438
 * `Tint`: RGBA color
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   439
 * `Scale` is a scale factor (not used by all visual gears)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   440
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   441
Some visual gears interpret these values differently, just like normal gears. See [VisualGearTypes] for details.  Also, most visual gears are not using all possible values, while some values are just ignored.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   442
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   443
Note that most visual gears require little to no modification of their values.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   444
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   445
*NOTE*: *Never* use the visual gear's internal state to manipulate/store anything gameplay-related.  Visual gears are not safe for reliable storage and using them as that would lead to strange bugs.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   446
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   447
Example 1:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   448
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   449
<code language="lua">  -- set a circle to position 1000,1000 pulsing from opacity 20 to 200 (8%-78%), radius of 50, 3px thickness, bright red.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   450
    SetVisualGearValues(circleUid, 1000,1000, 20, 200, 0, 0, 100, 50, 3, 0xff0000ff)</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   451
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   452
Only the first argument is required. Everything else is optional. Any such argument which is declared as `nil` will not overwrite the corresponding value of the visual gear.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   453
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   454
Example 2:
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   455
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   456
<code language="lua">  -- set a visual gear to position 1000,1000
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   457
    SetVisualGearValues(circleUid, 1000, 1000)</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   458
<code language="lua">  -- set the tint of a visual gear to bright red.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   459
    SetVisualGearValues(circleUid, nil, nil, nil, nil, nil, nil, nil, nil, nil, 0xff0000ff)</code>
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   460
    
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   461
=== `SetGearAIHints(gearUid, aiHint)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   462
Set some behaviour hints for computer-controlled hedgehogs for any given gear with `gearUid`.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   463
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   464
Set `aiHint` to either of:
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   465
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   466
 * `aihUsualProcessing`: AI hogs treat this gear the usual way. This is the default.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   467
 * `aihDoesntMatter`: AI hogs don't bother attacking this gear intentionally.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   468
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   469
Example:
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   470
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   471
<code language="lua">
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   472
SetGearAIHints(uselessHog, aihDoesntMatter)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   473
-- This makes AI hogs stop caring about attacking uselessHog</code>
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   474
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   475
== Hedgehog-specific gear properties ==
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   476
=== `GetHogName(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   477
Returns the name of the specified hedgehog gear.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   478
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   479
=== `SetHogName(gearUid, name)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   480
Sets the name of the specified hedgehog gear.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   481
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   482
=== `GetHogTeamName(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   483
Returns the name of the specified gear’s team. `gearUid` can be a hedgehog or a grave.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   484
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   485
=== `SetHogTeamName(gearUid, name)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   486
Sets the team name of the specified gear. The gear can be a hedgehog or grave.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   487
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   488
=== `GetHogClan(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   489
Returns the clan ID of the specified hedgehog gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   490
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   491
=== `GetHogLevel(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   492
Returns the bot level ranging from `0` to `5`. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` is for human player.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   493
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   494
=== `SetHogLevel(gearUid, level)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   495
Sets the bot level from 0 to 5. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` means human player.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   496
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   497
=== `GetEffect(gearUid, effect)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   498
Returns the state of given effect for the given hedgehog gear.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   499
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   500
See `SetEffect` for further details.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   501
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   502
=== `SetEffect(gearUid, effect, effectState)` ===
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   503
Sets the state for one of the effects `heInvulnerable, heResurrectable, hePoisoned, heResurrected, heFrozen` for the specified hedgehog gear.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   504
A value of 0 usually means the effect is disabled, values other than that indicate that it is enabled and in some cases specify e.g. the remaining time of that effect.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   505
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   506
|| *`effect`* || *Description* || *`effectState`* ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   507
|| `heInvulnerable` || Wether hog is invulnerable || Any non-zero value turns on invulnerability. `0` turns it off. ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   508
|| `hePoisoned` || Poison damage, damages hog each turn. || Amount of damage per turn. Use `0` to disable poisoning. ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   509
|| `heResurrectable` || Whether to resurrect the hog on death || With a non-zero value, the hedgehog will be resurrected and teleported to a random location on death. `0` disables this. ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   510
|| `heResurrected` || Whether the hedgehog has been resurrected once. This is only a subtle graphical effect. || With a non-zero value, the hedgehog was resurrected, `0` otherwise. ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   511
|| `heFrozen` || Freeze level. Frozen hedgehogs skip turn, are heavy and take half damage || The hog is considered frozen if the value is `256` or higher, otherwise not. A number of `256` or higher denotes “how frozen” the hedgehog is, i.e. how long it takes to melt. The freezer sets this to `199999` initially. The value will be reduced by `50000` each round. Being hit by a flame reduces this number by `1000`. The values `0` to `255` are used for the freeze/melt animations. ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   512
|| `heArtillery` || If enabled, the hedgehog can't walk (since 0.9.24). || `0` = disabled. `1` = permanently enabled. `2` = temporarily enabled (used by sniper rifle between shots) ||
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   513
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   514
Example (sets all bots poisoned with poison damage of 1):
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   515
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   516
<code language="lua">    function onGearAdd(gear)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   517
        if (GetGearType(gear) == gtHedgehog) and (GetHogLevel(gear) > 0) then
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   518
            SetEffect(gear, hePoisoned, 1)
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   519
        end
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   520
    end</code>
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   521
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   522
=== `GetHogHat(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   523
Returns the hat of the specified hedgehog gear.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   524
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   525
=== `SetHogHat(gearUid, hat)` ===
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   526
Sets the hat of the specified hedgehog gear.
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   527
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   528
=== `GetHogFlag(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   529
Returns the name of the flag of the team of the specified hedgehog gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   530
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   531
=== `GetHogFort(gearUid)` (0.9.23) ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   532
Returns the name of the fort of the team of the specified hedgehog gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   533
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   534
=== `GetHogGrave(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   535
Returns the name of the grave of the team of the specified hedgehog gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   536
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   537
=== `GetHogVoicepack(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   538
Returns the name of the voicepack of the team of the specified hedgehog gear.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   539
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   540
=== `GetAmmoCount(gearUid, ammoType)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   541
Returns the ammo count of the specified ammo type for the specified hedgehog gear. If infinite, returns `AMMO_INFINITE`.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   542
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   543
=== `GetAmmoTimer(gearUid, ammoType)` (0.9.25) ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   544
Returns the currently configured ammo timer (in milliseconds) for the given hedgehog gear and specified ammo type. This is the timer which is set by the player by using the timer keys (1-5). For ammo types for which the timer cannot be changed, `nil` is returned.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   545
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   546
Example:
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   547
<code lang="lua">GetAmmoTimer(CurrentHedgehog, amGrenade)
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   548
-- May return 1000, 2000, 3000, 4000 or 5000</code>
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   549
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   550
=== `HealHog(gearUid, healthBoost[, showMessage[, tint]])` (0.9.24) ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   551
Convenience function to increase the health of a hedgehog with default visual effects.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   552
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   553
Specifically, this increases the health of the hedgehog gear with the given ID `gearUid` by `healthBoost`, displays some healing particles at the hedgehog and shows the health increae as a message. This is similar to the behavour after taking a health crate, or getting a health boost from vampirism.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   554
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   555
If `showMessage` is false, no message is shown. With `tint` you can set the RGBA color of the particles (default: `0x00FF00FF`).
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   556
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   557
This function does not affect the poison state, however (see `SetEffect`).
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   558
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   559
=== `HogTurnLeft(gearUid, boolean)` ===
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   560
Faces the specified hog left or right.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   561
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   562
Example:
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   563
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   564
<code language="lua">    HogTurnLeft(CurrentHedgehog, true) -- turns CurrentHedgehog left 
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   565
    HogTurnLeft(CurrentHedgehog, false) -- turns CurrentHedgehog right</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   566
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   567
=== `IsHogHidden(gearUid)` (0.9.25) ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   568
Returns true if hedgehog gear is hidden (e.g. via `HideHog` or the !TimeBox), false if it isn't, nil if that hedgehog never existed.
1749
91756d20ce3e Separate core Lua stuff into new Lua pages for better maintainability. Main LuaAPI page not touched yet
Wuzzy <almikes@aol.com>
parents:
diff changeset
   569
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   570
=== `HideHog(gearUid)` ===
1825
1d2aeacbdd8e LuaGears: Add usage warning for HideHog
Wuzzy
parents: 1793
diff changeset
   571
Removes a hedgehog from the map. The hidden hedgehog can be restored with `RestoreHog(gearUid)`. Since 0.9.23, returns `true` on success and `false` on failure (if gear does not exist / hog is already hidden). You must not hide all hogs at once.
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   572
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   573
Example: 
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   574
1825
1d2aeacbdd8e LuaGears: Add usage warning for HideHog
Wuzzy
parents: 1793
diff changeset
   575
<code language="lua">    local gear = AddHog(...)
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   576
     HideHog(gear) -- Hide the newly created gear.</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   577
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   578
=== `RestoreHog(gearUid)` ===
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   579
Restores a previously hidden hedgehog.  Nothing happens if the hedgehog does not exist or is not hidden.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   580
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   581
Example: 
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   582
1825
1d2aeacbdd8e LuaGears: Add usage warning for HideHog
Wuzzy
parents: 1793
diff changeset
   583
<code language="lua">    local gear = AddHog(...)
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   584
     HideHog(gear) -- Hide the newly created gear.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   585
     RestoreHog(gear) -- Restore the newly hidden gear.</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   586
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   587
=== `IsHogLocal(gearUid)` (0.9.23) ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   588
Returns `true` if the specified hedgehog gear is controlled by a human player on the computer on which Hedgewars runs on (i.e. not over a computer over the network). Also returns `true` if the hog is a member of any of the local clans. Returns `false` otherwise. Returns `nil` if `gearUid` is invalid.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   589
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   590
This is perfect to hide certain captions like weapon messages from enemy eyes.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   591
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   592
== Special gear actions ==
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   593
=== `GetFollowGear()` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   594
Returns the uid of the gear that is currently being followed.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   595
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   596
=== `FollowGear(gearUid)` ===
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   597
Makes the game client follow the specifiec gear (if it exists). Does not work for visual gears.
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   598
1784
b08f6f71bfbd LuaGears: fix vgState
Wuzzy
parents: 1783
diff changeset
   599
=== `HogSay(gearUid, text, manner [,vgState])` ===
1783
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   600
Makes the specified gear say, think, or shout some text in a comic-style speech or thought bubble. `gearUid` is _not_ limited to hedgehogs, altough the function name suggests otherwise.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   601
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   602
The `manner` parameter specifies the type of the bubble and can have one of these values:
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   603
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   604
|| *Value of `manner`* || *Looks* ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   605
|| `SAY_THINK` || Thought bubble ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   606
|| `SAY_SAY` || Speech bubble ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   607
|| `SAY_SHOUT` || Exclamatory bubble (denotes shouting) ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   608
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   609
There is a optional 4th parameter `vgState`, it defines wheather the speechbubble is drawn fully opaque or semi-transparent. The value `0` is the default value.
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   610
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   611
|| *Value of `vgState`* || *Effect* ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   612
|| `0` || If the specified gear is a hedgehog, and it’s the turn of the hedgehog’s team, the bubble is drawn fully opaque.<br>If the gear is a hedgehog, and it’s another team’s turn, the bubble is drawn translucent.<br>If the gear is not a hedgehog, the bubble is drawn fully opaque. ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   613
|| `1` || The bubble is drawn translucent. ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   614
|| `2` || The bubble is drawn fully opaque. ||
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   615
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   616
Examples:
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   617
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   618
<code language="lua">HogSay(CurrentHedgehog, "I wonder what to do …", SAY_THINK) -- thought bubble with text “I wonder what to do …”</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   619
<code language="lua">HogSay(CurrentHedgehog, "I'm hungry.", SAY_SAY) -- speech bubble with text “I’m hungry.”</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   620
<code language="lua">HogSay(CurrentHedgehog, "I smell CAKE!", SAY_SHOUT) -- exclamatory bubble with text “I smell CAKE!”</code>
b25684cd9837 LuaGears: Restructure functions
Wuzzy
parents: 1782
diff changeset
   621
1792
3182a44b158e LuaGears: Restructure entire page
Wuzzy
parents: 1785
diff changeset
   622
== Deletion ==
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   623
=== `DeleteGear(gearUid)` ===
1780
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   624
Deletes a gear.  If the specified gear did not exist, nothing happens.
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   625
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   626
Example:
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   627
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   628
<code language="lua">    gear = AddGear(...)
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   629
    DeleteGear(gear) -- Delete the newly created gear.</code>
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   630
1785
95f3d64144bd LuaGears: Replace <tt> with `
Wuzzy
parents: 1784
diff changeset
   631
=== `DeleteVisualGear(vgUid)` ===
1780
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   632
Deletes a visual gear.  If it does not exist, nothing happens. 
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   633
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   634
Note, most visual gears delete themselves after a while.
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   635
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   636
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   637
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   638
Example:
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   639
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   640
<code language="lua">    vgear = AddVisualGear(...)
1b7b2e1ea829 LuaGears: Add deletion section
Wuzzy
parents: 1759
diff changeset
   641
    DeleteVisualGear(vgear) -- Delete the newly created visual gear.</code>