Entry point for registering event handlers. It is accessible through the global object named script
.
on_init(handler) | Register a function to be run on mod initialization. | |
Register a function to be run on mod initialization. | ||
on_load(handler) | Register a function to be run on save load. | |
Register a function to be run on save load. | ||
on_configuration_changed(handler) | Register a function to be run when mod configuration changes. | |
Register a function to be run when mod configuration changes. | ||
on_event(event, handler, filters?) | Register a handler to run on the specified event(s). | |
Register a handler to run on the specified event(s). | ||
on_nth_tick(tick, handler) | Register a handler to run every nth-tick(s). | |
Register a handler to run every nth-tick(s). | ||
register_on_entity_destroyed(entity) | → uint64 | Registers an entity so that after it's destroyed, on_entity_destroyed is called. |
Registers an entity so that after it's destroyed, on_entity_destroyed is called. | ||
register_metatable(name, metatable) | Register a metatable to have linkage recorded and restored when saving/loading. | |
Register a metatable to have linkage recorded and restored when saving/loading. | ||
generate_event_name() | → uint | Generate a new, unique event ID that can be used to raise custom events with LuaBootstrap::raise_event. |
Generate a new, unique event ID that can be used to raise custom events with LuaBootstrap::raise_event. | ||
get_event_handler(event) | → function(EventData)? | Find the event handler for an event. |
Find the event handler for an event. | ||
get_event_order() | → string | Gets the mod event order as a string. |
Gets the mod event order as a string. | ||
set_event_filter(event, filters?) | Sets the filters for the given event. | |
Sets the filters for the given event. | ||
get_event_filter(event) | → EventFilter? | Gets the filters for the given event. |
Gets the filters for the given event. | ||
get_prototype_history(type, name) | → PrototypeHistory | Gets the prototype history for the given type and name. |
Gets the prototype history for the given type and name. | ||
raise_event(event, data) | Raise an event. | |
Raise an event. | ||
raise_console_chat{player_index=…, message=…} | ||
raise_player_crafted_item{item_stack=…, player_index=…, recipe=…} | ||
raise_player_fast_transferred{player_index=…, entity=…, from_player=…, is_split=…} | ||
raise_biter_base_built{entity=…} | ||
raise_market_item_purchased{player_index=…, market=…, offer_index=…, count=…} | ||
raise_script_built{entity=…} | ||
raise_script_destroy{entity=…} | ||
raise_script_revive{entity=…, tags?=…} | ||
raise_script_teleported{entity=…, old_surface_index=…, old_position=…} | ||
raise_script_set_tiles{surface_index=…, tiles=…} | ||
mod_name [R] | :: string | The name of the mod from the environment this is used in. |
The name of the mod from the environment this is used in. | ||
level [R] | :: table | Information about the currently running scenario/campaign/tutorial. |
Information about the currently running scenario/campaign/tutorial. | ||
active_mods [R] | :: dictionary[string → string] | A dictionary listing the names of all currently active mods and mapping them to their version. |
A dictionary listing the names of all currently active mods and mapping them to their version. | ||
object_name [R] | :: string | This object's name. |
This object's name. |
Register a function to be run on mod initialization. This is only called when a new save game is created or when a save file is loaded that previously didn't contain the mod. During it, the mod gets the chance to set up initial values that it will use for its lifetime. It has full access to LuaGameScript and the global table and can change anything about them that it deems appropriate. No other events will be raised for the mod until it has finished this step.
handler | :: function() or nil | The handler for this event. Passing |
The handler for this event. Passing |
Initialize a
|
For more context, refer to the Data Lifecycle page.
Register a function to be run on save load. This is only called for mods that have been part of the save previously, or for players connecting to a running multiplayer session.
It gives the mod the opportunity to rectify potential differences in local state introduced by the save/load cycle. Doing anything other than the following three will lead to desyncs, breaking multiplayer and replay functionality. Access to LuaGameScript is not available. The global table can be accessed and is safe to read from, but not write to, as doing so will lead to an error.
The only legitimate uses of this event are these:
- Re-setup metatables as they are not persisted through the save/load cycle.
- Re-setup conditional event handlers, meaning subscribing to an event only when some condition is met to save processing time.
- Create local references to data stored in the global table.
For all other purposes, LuaBootstrap::on_init, LuaBootstrap::on_configuration_changed or migrations should be used instead.
handler | :: function() or nil | The handler for this event. Passing |
The handler for this event. Passing |
For more context, refer to the Data Lifecycle page.
Register a function to be run when mod configuration changes. This is called when the game version or any mod version changed, when any mod was added or removed, when a startup setting has changed, when any prototypes have been added or removed, or when a migration was applied. It allows the mod to make any changes it deems appropriate to both the data structures in its global table or to the game state through LuaGameScript.
handler | :: function(ConfigurationChangedData) or nil | The handler for this event. Passing |
The handler for this event. Passing |
For more context, refer to the Data Lifecycle page.
Register a handler to run on the specified event(s). Each mod can only register once for every event, as any additional registration will overwrite the previous one. This holds true even if different filters are used for subsequent registrations.
event | :: defines.events or string or array[defines.events or string] | The event(s) or custom-input to invoke the handler on. |
The event(s) or custom-input to invoke the handler on. | ||
handler | :: function(EventData) or nil | The handler for this event. Passing |
The handler for this event. Passing | ||
filters | :: EventFilter? | The filters for this event. Can only be used when registering for individual events. |
The filters for this event. Can only be used when registering for individual events. |
Register for the on_tick event to print the current tick to console each tick.
|
Register for the on_built_entity event, limiting it to only be received when a
|
Register a handler to run every nth-tick(s). When the game is on tick 0 it will trigger all registered handlers.
tick | :: uint or array[uint] or nil | The nth-tick(s) to invoke the handler on. Passing |
The nth-tick(s) to invoke the handler on. Passing | ||
handler | :: function(NthTickEventData) or nil | The handler to run. Passing |
The handler to run. Passing |
Registers an entity so that after it's destroyed, on_entity_destroyed is called. Once an entity is registered, it stays registered until it is actually destroyed, even through save/load cycles. The registration is global across all mods, meaning once one mod registers an entity, all mods listening to on_entity_destroyed will receive the event when it is destroyed. Registering the same entity multiple times will still only fire the destruction event once, and will return the same registration number.
entity | :: LuaEntity | The entity to register. |
The entity to register. |
→ uint64 | The registration number. It is used to identify the entity in the on_entity_destroyed event. |
Depending on when a given entity is destroyed, on_entity_destroyed will either be fired at the end of the current tick or at the end of the next tick.
Register a metatable to have linkage recorded and restored when saving/loading. The metatable itself will not be saved. Instead, only the linkage to a registered metatable is saved, and the metatable registered under that name will be used when loading the table.
name | :: string | The name of this metatable. Names must be unique per mod. |
The name of this metatable. Names must be unique per mod. | ||
metatable | :: table | The metatable to register. |
The metatable to register. |
The metatable first needs to be defined in the mod's root scope, then registered using this method. From then on, it will be properly restored for tables in global.
This previously defined
|
register_metatable()
can not be used in the console, in event listeners or during a remote.call()
.
Generate a new, unique event ID that can be used to raise custom events with LuaBootstrap::raise_event.
→ uint | The newly generated event ID. |
Gets the mod event order as a string.
Sets the filters for the given event. The filters are only retained when set after the actual event registration, because registering for an event with different or no filters will overwrite previously set ones.
event | :: uint | ID of the event to filter. |
ID of the event to filter. | ||
filters | :: EventFilter? | The filters or |
The filters or |
Limit the on_marked_for_deconstruction event to only be received when a non-ghost entity is marked for deconstruction.
|
Limit the on_built_entity event to only be received when either a
|
Limit the on_entity_damaged event to only be received when a
|
Gets the filters for the given event.
event | :: uint | ID of the event to get. |
ID of the event to get. |
→ EventFilter? | The filters or |
Raise an event. Only events generated with LuaBootstrap::generate_event_name and the following can be raised:
event | :: uint | ID of the event to raise. |
ID of the event to raise. | ||
data | :: table | Table with extra data that will be passed to the event handler. Any invalid LuaObjects will silently stop the event from being raised. |
Table with extra data that will be passed to the event handler. Any invalid LuaObjects will silently stop the event from being raised. |
Raise the on_console_chat event with the desired message 'from' the first player.
|
player_index | :: uint | The player doing the chatting. |
The player doing the chatting. | ||
message | :: string | The chat message to send. |
The chat message to send. |
on_console_chat instantly | Raised with the provided arguments. |
item_stack | :: LuaItemStack | The item that has been crafted. |
The item that has been crafted. | ||
player_index | :: uint | The player doing the crafting. |
The player doing the crafting. | ||
recipe | :: LuaRecipe | The recipe used to craft this item. |
The recipe used to craft this item. |
on_player_crafted_item instantly | Raised with the provided arguments. |
player_index | :: uint | The player transferred from or to. |
The player transferred from or to. | ||
entity | :: LuaEntity | The entity transferred from or to. |
The entity transferred from or to. | ||
from_player | :: boolean | Whether the transfer was from player to entity. If |
Whether the transfer was from player to entity. If | ||
is_split | :: boolean | Whether the transfer was a split action (half stack). |
Whether the transfer was a split action (half stack). |
on_player_fast_transferred instantly | Raised with the provided arguments. |
entity | :: LuaEntity | The entity that was built. |
The entity that was built. |
on_biter_base_built instantly | Raised with the provided arguments. |
player_index | :: uint | The player who did the purchasing. |
The player who did the purchasing. | ||
market | :: LuaEntity | The market entity. |
The market entity. | ||
offer_index | :: uint | The index of the offer purchased. |
The index of the offer purchased. | ||
count | :: uint | The amount of offers purchased. |
The amount of offers purchased. |
on_market_item_purchased instantly | Raised with the provided arguments. |
entity | :: LuaEntity | The entity that has been built. |
The entity that has been built. |
script_raised_built instantly | Raised with the provided arguments. |
entity | :: LuaEntity | The entity that was destroyed. |
The entity that was destroyed. |
script_raised_destroy instantly | Raised with the provided arguments. |
entity | :: LuaEntity | The entity that was revived. |
The entity that was revived. | ||
tags | :: Tags? | The tags associated with this entity, if any. |
The tags associated with this entity, if any. |
script_raised_revive instantly | Raised with the provided arguments. |
entity | :: LuaEntity | The entity that was teleported. |
The entity that was teleported. | ||
old_surface_index | :: uint8 | The entity's surface before the teleportation. |
The entity's surface before the teleportation. | ||
old_position | :: MapPosition | The entity's position before the teleportation. |
The entity's position before the teleportation. |
script_raised_teleported instantly | Raised with the provided arguments. |
surface_index | :: uint | The surface whose tiles have been changed. |
The surface whose tiles have been changed. | ||
tiles | :: array[Tile] | The tiles that have been changed. |
The tiles that have been changed. |
script_raised_set_tiles instantly | Raised with the provided arguments. |
The name of the mod from the environment this is used in.
Information about the currently running scenario/campaign/tutorial.
is_simulation | :: boolean? | Is this level a simulation? (The main menu and 'Tips and tricks' use simulations) |
Is this level a simulation? (The main menu and 'Tips and tricks' use simulations) | ||
is_tutorial | :: boolean? | Is this level a tutorial? |
Is this level a tutorial? | ||
campaign_name | :: string? | The campaign name if any. |
The campaign name if any. | ||
level_name | :: string | The level name. |
The level name. | ||
mod_name | :: string? | The mod name if any. |
The mod name if any. |
A dictionary listing the names of all currently active mods and mapping them to their version.
This will print the names and versions of all active mods to the console.
|
This object's name.