Events

Every event contains at least the name and tick attributes. Other events may include some additional attributes, specific to the event.

It is fired once every tick. Since this event is fired every tick, its handler shouldn't include performance heavy code.

Called when a CustomInput is activated.

Called when a unit/group completes a command.

Called when an area of the map is cloned.

Called when a biter migration builds a base.

Called when a set of positions on the map is cloned.

Called when a defines.command.build_base command reaches its destination, and before building starts.

Called when player builds something. Can be filtered using LuaPlayerBuiltEntityEventFilter.

Called when the deconstruction of an entity is canceled. Can be filtered using LuaEntityDeconstructionCancelledEventFilter.

Called when the upgrade of an entity is canceled. Can be filtered using LuaUpgradeCancelledEventFilter.

Called when a character corpse expires due to timeout or all of the items being removed from it.

Called when a chart tag is created.

Called when a chart tag is modified by a player.

Called just before a chart tag is deleted.

Called when a chunk is charted or re-charted.

Called when one or more chunks are deleted using LuaSurface::delete_chunk.

Called when a chunk is generated.

Called when a combat robot expires through a lack of energy, or timeout.

Called when a message is sent to the in-game console, either by a player or through the server interface.

Called when someone enters a command-like message regardless of it being a valid command.

Called when a cutscene is cancelled by the player or by script.

Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.

This refers to an index in the table previously passed to set_controller which started the cutscene.

Called when the map difficulty settings are changed.

Called when an entity is cloned. Can be filtered for the source entity using LuaEntityClonedEventFilter.

Called when an entity is damaged. Can be filtered using LuaEntityDamagedEventFilter.

Called after an entity is destroyed that has been registered with LuaBootstrap::register_on_entity_destroyed

Called when an entity dies. Can be filtered using LuaEntityDiedEventFilter.

Called when one of an entity's personal logistic slots changes.

Called after an entity has been renamed either by the player or through script.

Called after entity copy-paste is done.

Called when an entity is spawned by a EnemySpawner

Called after equipment is inserted into an equipment grid.

Called after equipment is removed from an equipment grid.

Called when the a forces cease fire values change.

Called when a new force is created using game.create_force()

Called when the a forces friends change.

Called when LuaForce::reset is finished.

Called after two forces have been merged using game.merge_forces().

Called when two forces are about to be merged using game.merge_forces().

Called when a game is created from a scenario. This is fired for every mod, even when the scenario's save data already includes it. In those cases however, LuaBootstrap::on_init is not fired.

Called when LuaGuiElement checked state is changed (related to checkboxes and radio buttons).

Called when LuaGuiElement is clicked.

Called when the player closes the GUI they have open.

Called when a LuaGuiElement is confirmed, for example by pressing Enter in a textfield.

Called when LuaGuiElement element value is changed (related to choose element buttons).

Called when LuaGuiElement element location is changed (related to frames in player.gui.screen).

Called when the player opens a GUI.

Called when LuaGuiElement selected tab is changed (related to tabbed-panes).

Called when LuaGuiElement selection state is changed (related to drop-downs and listboxes).

Called when LuaGuiElement switch state is changed (related to switches).

Called when LuaGuiElement text is changed by the player.

Called when LuaGuiElement slider value is changed (related to the slider element).

Called when a land mine is armed.

Called when a custom Lua shortcut is pressed.

Called when an entity is marked for deconstruction with the Deconstruction planner or via script. Can be filtered using LuaEntityMarkedForDeconstructionEventFilter.

Called when an entity is marked for upgrade with the Upgrade planner or via script. Can be filtered using LuaEntityMarkedForUpgradeEventFilter.

Called after a player purchases some offer from a market entity.

Called when the player uses the 'Open item GUI' control on an item defined with the 'mod-openable' flag

Called directly after a permission group is added.

Called directly after a permission group is deleted.

Called directly after a permission group is edited in some way.

Called directly after a permission string is imported.

Called when a player picks up an item.

Called after a player alt-selects an area with a selection-tool item.

Called after a players ammo inventory changed in some way.

Called after a players armor inventory changed in some way.

Called when a player is banned.

Called after a player builds tiles.

Called when a player cancels crafting.

Called after a player changes forces.

Called when the tile position a player is located at changes.

Called after a player changes surfaces.

Called when cheat mode is disabled on a player.

Called when cheat mode is enabled on a player.

Called when a player clicks a gps tag

Called when a player clicks the "confirm" button in the configure Blueprint GUI.

Called when a player configures spidertron remote to be connected with a given spidertron

Called when the player finishes crafting an item. This event fires just before the results are inserted into the player's inventory, not when the crafting is queued (see on_pre_player_crafted_item).

Called after the player was created.

Called after a players cursorstack changed in some way.

Called when a player selects an area with a deconstruction planner.

Called when a player is demoted.

Called after a player dies.

Called when the display resolution changes for a given player.

Called when the display scale changes for a given player.

Called when the player's driving state has changed, this means a player has either entered or left a vehicle.

Called when a player drops an item on the ground.

Called when a player fast-transfers something to or from an entity.

Called after player flushed fluid

Called after a players gun inventory changed in some way.

Called after a player joins the game.

Called when a player is kicked.

Called after a player leaves the game.

Called after a players main inventory changed in some way.

Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the player as if they came from mining the entity. Can be filtered using LuaPlayerMinedEntityEventFilter.

Called when the player mines something.

Called after a player mines tiles.

Called when a player is muted.

Called when a player invokes the "smart pipette" over an entity.

Called after the player puts equipment in an equipment grid

Called when a player is promoted.

Called when a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.

Called after the player removes equipment from an equipment grid

Called when a player repairs an entity. Can be filtered using LuaPlayerRepairedEntityEventFilter.

Called after a player respawns.

Called when the player rotates an entity. This event is only fired when the entity actually changes its orientation -- pressing the rotate key on an entity that can't be rotated won't fire this event.

Called after a player selects an area with a selection-tool item.

Called when a player sets a quickbar slot to anything (new value, or set to empty).

Called when a player selects an area with a blueprint.

Called when a player toggles alt mode, also known as "show entity info".

Called when a player toggles the map editor on or off.

Called after a players trash inventory changed in some way.

Called when a player is un-banned.

Called when a player is unmuted.

Called when a player uses a capsule that results in some game action.

Called when a player uses spidertron remote to send a spidertron to a given position

Called after an entity dies. Can be filtered using LuaPostEntityDiedEventFilter.

Called when players uses an item to build something. Called before on_built_entity.

Called before one or more chunks are deleted using LuaSurface::delete_chunk.

Called before entity copy-paste is done.

Called before a ghost entity is destroyed as a result of being marked for deconstruction. Can be filtered using LuaPreGhostDeconstructedEventFilter.

Called directly before a permission group is deleted.

Called directly before a permission string is imported.

Called when a player queues something to be crafted.

Called before a players dies.

Called before a player leaves the game.

Called when the player finishes mining an entity, before the entity is removed from map. Can be filtered using LuaPrePlayerMinedEntityEventFilter.

Called before a player is removed (deleted) from the game. Not to be confused with the player logging of this is different in that the player is deleted as if he never existed in the save file.

Called before a player toggles the map editor on or off.

Called directly before a robot explodes cliffs.

Called just before a script inventory is resized.

Called just before a surface is cleared (all entities removed and all chunks deleted).

Called just before a surface is deleted.

Called when a research finishes.

Called when a research is reversed (unresearched).

Called when a technology research starts.

Called when a resource entity reaches 0 or its minimum yield for infinite resources.

Called when a construction robot builds an entity. Can be filtered using LuaRobotBuiltEntityEventFilter.

Called after a robot builds tiles.

Called directly after a robot explodes cliffs.

Called when a robot mines an entity.

Called after the results of an entity being mined are collected just before the entity is destroyed. After this event any items in the buffer will be transferred into the robot as if they came from mining the entity. Can be filtered using LuaRobotMinedEntityEventFilter.

Called after a robot mines tiles.

Called before a robot mines an entity. Can be filtered using LuaPreRobotMinedEntityEventFilter.

Called when a rocket silo is ordered to be launched.

Called when the rocket is launched.

Called when a runtime mod setting is changed by a player.

Called just after a script inventory is resized.

Called when a LuaSurface::request_path call completes.

Called when a script trigger effect is triggered.

Called when an entity of type radar finishes scanning a sector. Can be filtered for the radar using LuaSectorScannedEventFilter.

Called after the selected entity changes for a given player.

Called when a spider finishes moving to its autopilot position.

Called when a translation request generated through LuaPlayer::request_translation is translated.

Called just after a surface is cleared (all entities removed and all chunks deleted).

Called when a surface is created.

Called after a surface is deleted.

Called after a surface is imported.

Called when a surface is renamed.

Called when LuaForce::reset_technology_effects is finished.

Called when a train changes state (started to stopped and vice versa)

Called when a new train is created either through disconnecting/connecting an existing one or building a new one.

Called when a trains schedule is changed either by the player or through script.

Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined trigger_created_entity="true".

Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined trigger_fired_artillery="true".

Called when a unit is added to a unit group.

Called when a new unit group is created, before any members are added to it.

Called when a unit group finishes gathering and starts executing its command.

Called when a unit is removed from a unit group.

Called when a worker (construction or logistic) robot expires through a lack of energy.

A static event mods can use to tell other mods they built something by script. This event is only raised if a mod does so with LuaBootstrap::raise_event or LuaBootstrap::raise_script_built, or when raise_built is passed to LuaSurface::create_entity. Can be filtered using LuaScriptRaisedBuiltEventFilter.

A static event mods can use to tell other mods they destroyed something by script. This event is only raised if a mod does so with LuaBootstrap::raise_event or LuaBootstrap::raise_script_destroy, or when raise_destroy is passed to LuaEntity::destroy. Can be filtered using LuaScriptRaisedDestroyEventFilter.

A static event mods can use to tell other mods they revived something by script. This event is only raised if a mod does so with LuaBootstrap::raise_event or LuaBootstrap::raise_script_revive, or when raise_revive is passed to LuaEntity::revive. Can be filtered using LuaScriptRaisedReviveEventFilter.

A static event mods can use to tell other mods they changed tiles on a surface by script. This event is only raised if a mod does so with LuaBootstrap::raise_event or LuaBootstrap::raise_script_set_tiles, or when raise_event is passed to LuaSurface::set_tiles.