LuaEvents.wiki
author Wuzzy
Wed, 17 Apr 2019 19:27:57 +0100
changeset 1822 fc9a202d27ba
parent 1795 12e1aa6294d7
child 1839 198bfa280caa
permissions -rw-r--r--
LuaEvents: Update onGameInit info
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
     1
#summary List of event handlers in the Lua API
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
     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
     3
= Lua API: Event handlers =
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
Event handlers are [LuaAPI Lua] functions that Hedgewars calls on certain events. Lua scripts are supposed to _define_ these functions to do something. The functions are then _called_ by Hedgewars when a certain event has occured. For an example of how this works, see [LuaGuide].
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
     5
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
     6
This page is a list of all supported event handlers in Hedgewars.
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
     7
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
     8
<wiki:toc max_depth="3" />
1756
66b51b8ba202 LuaEvents: Add TOC
Wuzzy
parents: 1753
diff changeset
     9
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    10
== Initialization ==
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    11
=== <tt>onGameInit()</tt> ===
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
    12
This function is called before the game loads its resources. One can read and modify various [LuaGlobals#Game_variables game variables] here. These variables will become globally available after `onGameInit` has been invoked, but changing them has only an effect in `onGameInit`.
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
    13
1822
fc9a202d27ba LuaEvents: Update onGameInit info
Wuzzy
parents: 1795
diff changeset
    14
Most game variables are optional, but for missions, `Theme` must be set by the scripter if you want to use a random map, rather than an image map. All other variables do not need to be set by the scripter and have default values. For a list of game variables that can be set here, see [LuaGlobals#Game_variables].
fc9a202d27ba LuaEvents: Update onGameInit info
Wuzzy
parents: 1795
diff changeset
    15
fc9a202d27ba LuaEvents: Update onGameInit info
Wuzzy
parents: 1795
diff changeset
    16
If you want to add teams or hogs manually, you have to do it here. If you want to draw your own map using `AddPoint` and `FlushPoints`, you have to do this within this function as well.
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
    17
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    18
=== <tt>onGameStart()</tt> ===
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
    19
This function is called when the first round starts.
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
    20
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
    21
Can be used to show the mission and for more setup, for example initial target spawning.
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
At this stage, the global variables `LeftX`, `RightX`, `TopY`, `LAND_WIDTH` and `LAND_HEIGHT` become available.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    25
=== <tt>onPreviewInit()</tt> ===
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
    26
This function is called when the map preview in the frontend is initialized. This happens when the script is selected or you change a map generator parameter.
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
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
It is useful for scripts which create their own maps (see `AddPoint` and `FlushPoints`). If you create a map in this function, a preview will be generated from this map and is exposed to the frontend.
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
    29
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    30
=== <tt>onParameters()</tt> ===
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
This function is called when the script parameters (as specified in the game scheme) become available. The script parameter string is stored in the global variable `ScriptParam`.
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
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
Please note that it is normally not safe to call many of the other functions inside this function, this function is called very early in the game, only use this to initialize variables and other internal stuff like that.
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
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
*Tip*: If you use the Params library  (`/Scripts/Params.lua`), you can make the task of dissecting the string into useful values a bit easier, but it’s not required. (The Params library is not documented yet, however).
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
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
*Tip*: If you use this callback, make sure to document the interpretation of the parameters so others know how to set the parameters properly.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    39
=== <tt>onAmmoStoreInit()</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    40
This function is called when the game is initialized to request the available ammo and ammo probabilities. Use `SetAmmo` here.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    41
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    42
=== <tt>onNewAmmoStore(team/clan index, hog index)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    43
This function is identical to `onAmmoStoreInit` in function, but is called once per ammo store.  This allows different ammo sets for each clan, team or hedgehog depending on the mode.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    44
If `gfSharedAmmo` is set, the parameters passed are the clan index, and `-1`, and the function will be called once for each clan.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    45
If `gfPerHogAmmo` is set, the parameters passed are the team index and the hog index in that team, and the function will be called once for each hedgehog.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    46
If neither is set, the parameters passed are the team index and `-1`, and the function will be called once for each team.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    47
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    48
These indexes can be used to look up details of the clan/team/hedgehog prior to gear creation. Routines to do these lookups will be created as needed.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    49
If you add this hook, the expectation is that you will call SetAmmo appropriately. Any values from `onAmmoStoreInit` are ignored.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    50
1775
9a5472760632 LuaEvents: move tick events to new section
Wuzzy
parents: 1774
diff changeset
    51
== Time events ==
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    52
=== <tt>onGameTick()</tt> ===
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
    53
This function is called on every game tick, i.e. 1000 times a second. If you just need to check on something periodically, consider `onGameTick20`.
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
    54
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    55
=== <tt>onGameTick20()</tt> ===
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
    56
This function is called every 20 game ticks, which equals 50 times a second. It reduces Lua overhead for simple monitoring that doesn’t need to happen every single tick.
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
    57
1775
9a5472760632 LuaEvents: move tick events to new section
Wuzzy
parents: 1774
diff changeset
    58
== Game events ==
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    59
=== <tt>onNewTurn()</tt> ===
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
    60
This function calls at the start of every turn. You can set `ReadyTimeLeft` here to change the ready time for this turn. (See also: `Ready`)
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
    61
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    62
=== <tt>onEndTurn()</tt> (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
    63
This function calls at the end of every turn. The end of a turn is defined as the point of time after the current hedgehog lost control and all the important gears are either gone or have settled.
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
    64
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
    65
`CurrentHedgehog` holds the gear ID of the hedgehog whose turn just ended.
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
    66
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
    67
This function is called at one of the earliest possible moment after the end of a turn. After this callback, Hedgewars then performs all the other stuff between turns. This includes things like: Applying poison or Sudden Death damage, calculating total hog damage, rising the water in Sudden Death, dropping a crate, checking victory, giving control to the next hog.
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
    68
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
    69
Because this function is called *before* victories are checked, this is useful to set up your victory conditions here.
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
    70
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    71
=== <tt>onSkipTurn()</tt> (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
    72
This function calls when a hog skips its turn.
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
    73
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    74
=== <tt>onCaseDrop(gear)</tt> (1.0.0) ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    75
This function calls between two turns right after the moment at which the game *might* drop a crate according to the game scheme settings. It does not matter if it actually wants to drop a crate.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    76
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    77
If a crate was dropped, `gear` is the crate gear that was dropped, if no crate was dropped, `gear` is `nil`.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    78
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    79
This function is useful to add custom crate drops as well.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    80
1774
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
    81
=== <tt>onSuddenDeath()</tt> ===
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
    82
This function is called on the start of Sudden Death.
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
    83
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    84
=== <tt>onGameResult(winningClan)</tt> (0.9.25) ===
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
    85
This function calls when the game ends with a winner or in a draw. If a clan wins, `winningClan` is the clan ID of the winning clan. If the game ends in a draw, `winningClan` is set to -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
    86
1774
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
    87
=== <tt>onAchievementsDeclaration()</tt> ===
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
    88
This function is called after the stats for the stats screen (after the game) have been generated. You are supposed to call `DeclareAchievement` here.
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
1795
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
    90
=== <tt>onHogAttack(ammoType)</tt> ===
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
    91
This function is called when a hedgehog attacks. Beginning with 0.9.21, the parameter `ammoType` is provided. It contains the ammo type of the weapon used for the attack. 
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
    92
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
    93
Note: If you want to detect when a turn was skipped, use `onSkipTurn()`. There is no guarantee that `onHogAttack(amSkip)` is called in such an event.
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
    94
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    95
=== <tt>onUsedAmmo(ammoType)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    96
Called after a weapon has been used completely, with `ammoType` as the used ammo type.
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
    97
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
    98
For example, it is called right after a bazooka is fired, when both shots of a shotgun have been fired, when extra time is used, or when all 4 shots of a portable portal device have been fired. It is also called when using a multi-shot ammo has been aborted by changing the weapon selection mid-way, because this still uses up the ammo.
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
    99
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   100
*Warning:* In 0.9.24 or earlier, you must not manipulate any ammo within this callback, e.g. by using `AddAmmo`. The ammo storage might become garbled otherwise.
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
   101
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   102
== Controls ==
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   103
=== <tt>onAttack()</tt> ===
1795
12e1aa6294d7 LuaEvents: Fix onAttack, onHogAttack
Wuzzy
parents: 1775
diff changeset
   104
This function is called when you press the attack key.
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
   105
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   106
=== <tt>onHJump()</tt> ===
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
   107
This function is called when you press the high jump key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   109
=== <tt>onLJump()</tt> ===
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
   110
This function is called when you press the long jump key.
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
   111
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   112
=== <tt>onPrecise()</tt> ===
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
   113
This function is called when you press the precise key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   115
=== <tt>onLeft()</tt> ===
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
   116
This function is called when you press the left key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   118
=== <tt>onRight()</tt> ===
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
   119
This function is called when you press the right key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   121
=== <tt>onUp()</tt> ===
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
   122
This function is called when you press the up key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   124
=== <tt>onDown()</tt> ===
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
   125
This function is called when you press the down key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   127
=== <tt>onAttackUp()</tt> ===
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
   128
This function is called when you release the attack key.
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
   129
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   130
=== <tt>onDownUp()</tt> ===
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
   131
This function is called when you release the down key.
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
   132
 
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   133
=== <tt>onLeftUp()</tt> ===
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
   134
This function is called when you release the left key.
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
   135
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   136
=== <tt>onPreciseUp()</tt> ===
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
   137
This function is called when you release the precise key.
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
   138
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   139
=== <tt>onRightUp()</tt> ===
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
   140
This function is called when you release the right key.
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
   141
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   142
=== <tt>onSetWeapon(msgParam)</tt> ===
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
   143
It is get called when a weapon is selected or switched.
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
   144
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
   145
`msgParam` tells you which ammo type was selected.
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
   146
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   147
=== <tt>onSlot(msgParam)</tt> ===
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
   148
This function is called when one of the weapon slot keys has been pressed.
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
   149
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
   150
`msgParam` tells the slot number minus 1 (i.e. `0` is for slot number 1, `1` is for slot number 2, etc.).
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
   151
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   152
=== <tt>onSwitch()</tt> ===
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
   153
This function is called when a hog is switched to another.
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
   154
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   155
=== <tt>onTaunt(msgParam)</tt> ===
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
   156
This function is called when the player uses an animated emote for example by using the chat commands `/wave`, `/juggle`, etc.
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
   157
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
   158
`msgParam` tells you which animation was played:
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
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
   160
|| *`msgParam`* || *Animation* || *Associated chat command* ||
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
|| 0 || Rolling up || `/rollup` ||
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
|| 1 || Sad face || `/sad` ||
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
   163
|| 2 || Waving hand || `/wave` ||
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
|| 3 || Stupid winner's grin / “Awesome” face || `/hurrah` ||
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
|| 4 || Peeing || `/ilovelotsoflemonade` ||
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
   166
|| 5 || Shrug || `/shrug` ||
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
|| 6 || Juggling || `/juggle` ||
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   169
=== <tt>onTimer(msgParam)</tt> ===
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
   170
This function is called when one of the timer keys is pressed.
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
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
`msgParams` tells the set timer in seconds (i.e. `3` for the 3 seconds timer key).
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   174
=== <tt>onUpUp()</tt> ===
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
   175
This function is called when you release the up key.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   177
=== <tt>onScreenResize()</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   178
This function is called when you resize the screen. Useful place to put a redraw function for any `vgtHealthTags` you're using.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   179
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   180
== Gears ==
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   181
=== <tt>onGearAdd(gearUid)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   182
This function is called when a new gear is added. Useful in combination with `GetGearType(gearUid)`.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   183
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   184
=== <tt>onGearDelete(gearUid)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   185
This function is called when a new gear is deleted. Useful in combination with `GetGearType(gearUid)`.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   186
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   187
=== <tt>onVisualGearAdd(vgUid)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   188
This function is called when a new visual gear is added. Useful in combination with `GetVisualGearType(vgUid)`.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   189
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   190
=== <tt>onVisualGearDelete(vgUid)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   191
This function is called when a new visual gear is deleted. Useful in combination with `GetVisualGearType(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
   192
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   193
=== <tt>onGearDamage(gearUid, damage)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   194
This function is called when a gear is damaged.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   195
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   196
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
   197
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   198
<code language="lua">    function onGearDamage(gear, damage)
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   199
        if (GetGearType(gear) === gtHedgehog) then
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   200
            -- adds a message saying, e.g. "Hoggy H took 25 points of damage"
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   201
            AddCaption(GetHogName(gear) .. ' took ' .. damage .. ' points of damage')
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   202
        end
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   203
    end</code>
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   204
=== <tt>onGearResurrect(gearUid, spawnedVGear) </tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   205
This function is called when a gear is resurrected due to the hog effect `heResurrectable` being set (see `SetEffect`) and/or being an AI hog when the game modifier “AI Survival” (`gfAISurvival`) is active. It is *not* called when a hog was resurrected by the resurrector tool you can use in the game.
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
   206
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   207
`spawnedVGear` is a visual gear handle of the “resurrection effect”. You can use this handle to modify or delete the resurrection animation.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   208
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   209
=== <tt>onGearWaterSkip(gear)</tt> ===
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   210
This function is called when the gear `gear` skips over water.
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   211
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   212
=== <tt>onHogHide(gearUid)</tt> ===
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
   213
This function is called when a hedgehog with the gear ID `gearUid` is hidden (removed from the map).
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   215
=== <tt>onHogRestore(gearUid)</tt> ===
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
This function is called when a hedgehog with the specified gear ID `gearUid` is restored (unhidden).
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   218
== Map changes ==
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   219
=== <tt>onSpritePlacement(spriteId, centerX, centerY)</tt> ===
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
   220
This function is called when a [Sprites Sprite] has been placed.
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
   221
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
`spriteID` is the type of the sprite, you find a list at [Sprites Sprites]. `centerX` and `centerY` are the coordinates of the center of the sprite.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   224
=== <tt>onGirderPlacement(frameIdx, centerX, centerY)</tt> ===
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
   225
This function is called when a girder has been placed.
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
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
`frameIdx` is used for the length and orientation of the girder. The possible values are explained in `PlaceGirder`. `centerX` and `centerY` are the coordinates of the girder’s center.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   229
=== <tt>onRubberPlacement(frameIdx, centerX, centerY)</tt> ===
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
   230
This function is called when a rubber has been placed.
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
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
`frameIdx` is used for the rubber orientation. The possible values are explained in `PlaceRubber`. `centerX` and `centerY` are the coordinates of the rubber’s center.
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
1770
729bef6b40da LuaEvents: Restructure events into sections
Wuzzy
parents: 1769
diff changeset
   234
=== <tt>onSpecialPoint(x, y, flags)</tt> ===
1768
43762534f5ab LuaEvents: Remove note to 0.9.23
Wuzzy
parents: 1756
diff changeset
   235
This is used while a special hand-drawn map is loaded. The engine is building these hand-drawn maps by reading points from the map definition. Optionally, some of these points may be “special”. These are not actually drawn on the map, but are used to store additional information for a position on the map. Special points currently need to be added manually in the map, the in-game editor is not able to add those yet.
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
   236
Now, when such a special point at the coordinates `x` and `y` with an assigned value of `flags` is added, this function is called. `flags` is a whole number between `0` and `255` inclusive.
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
1774
086bebb89963 LuaEvents: Edited via web interface
Wuzzy
parents: 1770
diff changeset
   238
This function is used in Racer and !TechRacer to define waypoints.