Skip to main content

Module events

Module events 

Source

Re-exports§

pub use crate::event_data::CustomInputEventEvent;
pub use crate::event_data::OnAchievementGainedEvent;
pub use crate::event_data::OnAiCommandCompletedEvent;
pub use crate::event_data::OnAreaClonedEvent;
pub use crate::event_data::OnBiterBaseBuiltEvent;
pub use crate::event_data::OnBlueprintSettingsPastedEvent;
pub use crate::event_data::OnBrushClonedEvent;
pub use crate::event_data::OnBuildBaseArrivedEvent;
pub use crate::event_data::OnBuiltEntityEvent;
pub use crate::event_filters::LuaPlayerBuiltEntityEventFilter as OnBuiltEntityFilter;
pub use crate::event_data::OnCancelledDeconstructionEvent;
pub use crate::event_filters::LuaEntityDeconstructionCancelledEventFilter as OnCancelledDeconstructionFilter;
pub use crate::event_data::OnCancelledUpgradeEvent;
pub use crate::event_filters::LuaUpgradeCancelledEventFilter as OnCancelledUpgradeFilter;
pub use crate::event_data::OnCargoPodDeliveredCargoEvent;
pub use crate::event_data::OnCargoPodFinishedAscendingEvent;
pub use crate::event_data::OnCargoPodFinishedDescendingEvent;
pub use crate::event_data::OnCargoPodStartedAscendingEvent;
pub use crate::event_data::OnCharacterCorpseExpiredEvent;
pub use crate::event_data::OnChartTagAddedEvent;
pub use crate::event_data::OnChartTagModifiedEvent;
pub use crate::event_data::OnChartTagRemovedEvent;
pub use crate::event_data::OnChunkChartedEvent;
pub use crate::event_data::OnChunkDeletedEvent;
pub use crate::event_data::OnChunkGeneratedEvent;
pub use crate::event_data::OnCombatRobotExpiredEvent;
pub use crate::event_data::OnConsoleChatEvent;
pub use crate::event_data::OnConsoleCommandEvent;
pub use crate::event_data::OnCutsceneCancelledEvent;
pub use crate::event_data::OnCutsceneFinishedEvent;
pub use crate::event_data::OnCutsceneStartedEvent;
pub use crate::event_data::OnCutsceneWaypointReachedEvent;
pub use crate::event_data::OnEntityClonedEvent;
pub use crate::event_filters::LuaEntityClonedEventFilter as OnEntityClonedFilter;
pub use crate::event_data::OnEntityColorChangedEvent;
pub use crate::event_data::OnEntityDamagedEvent;
pub use crate::event_filters::LuaEntityDamagedEventFilter as OnEntityDamagedFilter;
pub use crate::event_data::OnEntityDiedEvent;
pub use crate::event_filters::LuaEntityDiedEventFilter as OnEntityDiedFilter;
pub use crate::event_data::OnEntityLogisticSlotChangedEvent;
pub use crate::event_data::OnEntityRenamedEvent;
pub use crate::event_data::OnEntitySettingsPastedEvent;
pub use crate::event_data::OnEntitySpawnedEvent;
pub use crate::event_data::OnEquipmentInsertedEvent;
pub use crate::event_data::OnEquipmentRemovedEvent;
pub use crate::event_data::OnForceCeaseFireChangedEvent;
pub use crate::event_data::OnForceCreatedEvent;
pub use crate::event_data::OnForceFriendsChangedEvent;
pub use crate::event_data::OnForceResetEvent;
pub use crate::event_data::OnForcesMergedEvent;
pub use crate::event_data::OnForcesMergingEvent;
pub use crate::event_data::OnGameCreatedFromScenarioEvent;
pub use crate::event_data::OnGuiCheckedStateChangedEvent;
pub use crate::event_data::OnGuiClickEvent;
pub use crate::event_data::OnGuiClosedEvent;
pub use crate::event_data::OnGuiConfirmedEvent;
pub use crate::event_data::OnGuiElemChangedEvent;
pub use crate::event_data::OnGuiHoverEvent;
pub use crate::event_data::OnGuiInventoryActionEvent;
pub use crate::event_data::OnGuiLeaveEvent;
pub use crate::event_data::OnGuiLocationChangedEvent;
pub use crate::event_data::OnGuiOpenedEvent;
pub use crate::event_data::OnGuiSelectedTabChangedEvent;
pub use crate::event_data::OnGuiSelectionStateChangedEvent;
pub use crate::event_data::OnGuiSwitchStateChangedEvent;
pub use crate::event_data::OnGuiTextChangedEvent;
pub use crate::event_data::OnGuiValueChangedEvent;
pub use crate::event_data::OnLandMineArmedEvent;
pub use crate::event_data::OnLuaShortcutEvent;
pub use crate::event_data::OnMarkedForDeconstructionEvent;
pub use crate::event_filters::LuaEntityMarkedForDeconstructionEventFilter as OnMarkedForDeconstructionFilter;
pub use crate::event_data::OnMarkedForUpgradeEvent;
pub use crate::event_filters::LuaEntityMarkedForUpgradeEventFilter as OnMarkedForUpgradeFilter;
pub use crate::event_data::OnMarketItemPurchasedEvent;
pub use crate::event_data::OnModItemOpenedEvent;
pub use crate::event_data::OnMultiplayerInitEvent;
pub use crate::event_data::OnObjectDestroyedEvent;
pub use crate::event_data::OnPermissionGroupAddedEvent;
pub use crate::event_data::OnPermissionGroupDeletedEvent;
pub use crate::event_data::OnPermissionGroupEditedEvent;
pub use crate::event_data::OnPermissionStringImportedEvent;
pub use crate::event_data::OnPickedUpItemEvent;
pub use crate::event_data::OnPlayerAltReverseSelectedAreaEvent;
pub use crate::event_data::OnPlayerAltSelectedAreaEvent;
pub use crate::event_data::OnPlayerAmmoInventoryChangedEvent;
pub use crate::event_data::OnPlayerArmorInventoryChangedEvent;
pub use crate::event_data::OnPlayerBannedEvent;
pub use crate::event_data::OnPlayerBuiltTileEvent;
pub use crate::event_data::OnPlayerCancelledCraftingEvent;
pub use crate::event_data::OnPlayerChangedForceEvent;
pub use crate::event_data::OnPlayerChangedPositionEvent;
pub use crate::event_data::OnPlayerChangedSurfaceEvent;
pub use crate::event_data::OnPlayerCheatModeDisabledEvent;
pub use crate::event_data::OnPlayerCheatModeEnabledEvent;
pub use crate::event_data::OnPlayerClickedGpsTagEvent;
pub use crate::event_data::OnPlayerColorChangedEvent;
pub use crate::event_data::OnPlayerConfiguredBlueprintEvent;
pub use crate::event_data::OnPlayerControllerChangedEvent;
pub use crate::event_data::OnPlayerCraftedItemEvent;
pub use crate::event_data::OnPlayerCreatedEvent;
pub use crate::event_data::OnPlayerCursorStackChangedEvent;
pub use crate::event_data::OnPlayerDeconstructedAreaEvent;
pub use crate::event_data::OnPlayerDemotedEvent;
pub use crate::event_data::OnPlayerDiedEvent;
pub use crate::event_data::OnPlayerDisplayDensityScaleChangedEvent;
pub use crate::event_data::OnPlayerDisplayResolutionChangedEvent;
pub use crate::event_data::OnPlayerDisplayScaleChangedEvent;
pub use crate::event_data::OnPlayerDrivingChangedStateEvent;
pub use crate::event_data::OnPlayerDroppedItemEvent;
pub use crate::event_data::OnPlayerDroppedItemIntoEntityEvent;
pub use crate::event_data::OnPlayerFastTransferredEvent;
pub use crate::event_data::OnPlayerFlippedEntityEvent;
pub use crate::event_data::OnPlayerFlushedFluidEvent;
pub use crate::event_data::OnPlayerGunInventoryChangedEvent;
pub use crate::event_data::OnPlayerInputMethodChangedEvent;
pub use crate::event_data::OnPlayerJoinedGameEvent;
pub use crate::event_data::OnPlayerKickedEvent;
pub use crate::event_data::OnPlayerLeftGameEvent;
pub use crate::event_data::OnPlayerLocaleChangedEvent;
pub use crate::event_data::OnPlayerMainInventoryChangedEvent;
pub use crate::event_data::OnPlayerMinedEntityEvent;
pub use crate::event_filters::LuaPlayerMinedEntityEventFilter as OnPlayerMinedEntityFilter;
pub use crate::event_data::OnPlayerMinedItemEvent;
pub use crate::event_data::OnPlayerMinedTileEvent;
pub use crate::event_data::OnPlayerMusicChangedEvent;
pub use crate::event_data::OnPlayerMutedEvent;
pub use crate::event_data::OnPlayerPipetteEvent;
pub use crate::event_data::OnPlayerPlacedEquipmentEvent;
pub use crate::event_data::OnPlayerPromotedEvent;
pub use crate::event_data::OnPlayerRemovedEvent;
pub use crate::event_data::OnPlayerRemovedEquipmentEvent;
pub use crate::event_data::OnPlayerRepairedEntityEvent;
pub use crate::event_filters::LuaPlayerRepairedEntityEventFilter as OnPlayerRepairedEntityFilter;
pub use crate::event_data::OnPlayerRespawnedEvent;
pub use crate::event_data::OnPlayerReverseSelectedAreaEvent;
pub use crate::event_data::OnPlayerRotatedEntityEvent;
pub use crate::event_data::OnPlayerSelectedAreaEvent;
pub use crate::event_data::OnPlayerSetQuickBarSlotEvent;
pub use crate::event_data::OnPlayerSetupBlueprintEvent;
pub use crate::event_data::OnPlayerToggledAltModeEvent;
pub use crate::event_data::OnPlayerToggledMapEditorEvent;
pub use crate::event_data::OnPlayerTrashInventoryChangedEvent;
pub use crate::event_data::OnPlayerUnbannedEvent;
pub use crate::event_data::OnPlayerUnmutedEvent;
pub use crate::event_data::OnPlayerUsedCapsuleEvent;
pub use crate::event_data::OnPlayerUsedSpidertronRemoteEvent;
pub use crate::event_data::OnPostEntityDiedEvent;
pub use crate::event_filters::LuaPostEntityDiedEventFilter as OnPostEntityDiedFilter;
pub use crate::event_data::OnPostSegmentedUnitDiedEvent;
pub use crate::event_filters::LuaPostSegmentedUnitDiedEventFilter as OnPostSegmentedUnitDiedFilter;
pub use crate::event_data::OnPreBuildEvent;
pub use crate::event_data::OnPreChunkDeletedEvent;
pub use crate::event_data::OnPreEntitySettingsPastedEvent;
pub use crate::event_data::OnPreGhostDeconstructedEvent;
pub use crate::event_filters::LuaPreGhostDeconstructedEventFilter as OnPreGhostDeconstructedFilter;
pub use crate::event_data::OnPreGhostUpgradedEvent;
pub use crate::event_filters::LuaPreGhostUpgradedEventFilter as OnPreGhostUpgradedFilter;
pub use crate::event_data::OnPrePermissionGroupDeletedEvent;
pub use crate::event_data::OnPrePermissionStringImportedEvent;
pub use crate::event_data::OnPrePlayerCraftedItemEvent;
pub use crate::event_data::OnPrePlayerDiedEvent;
pub use crate::event_data::OnPrePlayerLeftGameEvent;
pub use crate::event_data::OnPrePlayerMinedItemEvent;
pub use crate::event_filters::LuaPrePlayerMinedEntityEventFilter as OnPrePlayerMinedItemFilter;
pub use crate::event_data::OnPrePlayerRemovedEvent;
pub use crate::event_data::OnPrePlayerToggledMapEditorEvent;
pub use crate::event_data::OnPreRobotExplodedCliffEvent;
pub use crate::event_data::OnPreScenarioFinishedEvent;
pub use crate::event_data::OnPreScriptInventoryResizedEvent;
pub use crate::event_data::OnPreSurfaceClearedEvent;
pub use crate::event_data::OnPreSurfaceDeletedEvent;
pub use crate::event_data::OnRedoAppliedEvent;
pub use crate::event_data::OnResearchCancelledEvent;
pub use crate::event_data::OnResearchFinishedEvent;
pub use crate::event_data::OnResearchMovedEvent;
pub use crate::event_data::OnResearchQueuedEvent;
pub use crate::event_data::OnResearchReversedEvent;
pub use crate::event_data::OnResearchStartedEvent;
pub use crate::event_data::OnResourceDepletedEvent;
pub use crate::event_data::OnRobotBuiltEntityEvent;
pub use crate::event_filters::LuaRobotBuiltEntityEventFilter as OnRobotBuiltEntityFilter;
pub use crate::event_data::OnRobotBuiltTileEvent;
pub use crate::event_data::OnRobotExplodedCliffEvent;
pub use crate::event_data::OnRobotMinedEvent;
pub use crate::event_data::OnRobotMinedEntityEvent;
pub use crate::event_filters::LuaRobotMinedEntityEventFilter as OnRobotMinedEntityFilter;
pub use crate::event_data::OnRobotMinedTileEvent;
pub use crate::event_data::OnRobotPreMinedEvent;
pub use crate::event_filters::LuaPreRobotMinedEntityEventFilter as OnRobotPreMinedFilter;
pub use crate::event_data::OnRocketLaunchOrderedEvent;
pub use crate::event_data::OnRocketLaunchedEvent;
pub use crate::event_data::OnRuntimeModSettingChangedEvent;
pub use crate::event_data::OnScriptInventoryResizedEvent;
pub use crate::event_data::OnScriptPathRequestFinishedEvent;
pub use crate::event_data::OnScriptTriggerEffectEvent;
pub use crate::event_data::OnSectorScannedEvent;
pub use crate::event_filters::LuaSectorScannedEventFilter as OnSectorScannedFilter;
pub use crate::event_data::OnSegmentEntityCreatedEvent;
pub use crate::event_data::OnSegmentedUnitCreatedEvent;
pub use crate::event_filters::LuaSegmentedUnitCreatedEventFilter as OnSegmentedUnitCreatedFilter;
pub use crate::event_data::OnSegmentedUnitDamagedEvent;
pub use crate::event_filters::LuaSegmentedUnitDamagedEventFilter as OnSegmentedUnitDamagedFilter;
pub use crate::event_data::OnSegmentedUnitDiedEvent;
pub use crate::event_filters::LuaSegmentedUnitDiedEventFilter as OnSegmentedUnitDiedFilter;
pub use crate::event_data::OnSelectedEntityChangedEvent;
pub use crate::event_data::OnSingleplayerInitEvent;
pub use crate::event_data::OnSpacePlatformBuiltEntityEvent;
pub use crate::event_filters::LuaPlatformBuiltEntityEventFilter as OnSpacePlatformBuiltEntityFilter;
pub use crate::event_data::OnSpacePlatformBuiltTileEvent;
pub use crate::event_data::OnSpacePlatformChangedStateEvent;
pub use crate::event_data::OnSpacePlatformMinedEntityEvent;
pub use crate::event_filters::LuaPlatformMinedEntityEventFilter as OnSpacePlatformMinedEntityFilter;
pub use crate::event_data::OnSpacePlatformMinedItemEvent;
pub use crate::event_data::OnSpacePlatformMinedTileEvent;
pub use crate::event_data::OnSpacePlatformPreMinedEvent;
pub use crate::event_filters::LuaPrePlatformMinedEntityEventFilter as OnSpacePlatformPreMinedFilter;
pub use crate::event_data::OnSpiderCommandCompletedEvent;
pub use crate::event_data::OnStringTranslatedEvent;
pub use crate::event_data::OnSurfaceClearedEvent;
pub use crate::event_data::OnSurfaceCreatedEvent;
pub use crate::event_data::OnSurfaceDeletedEvent;
pub use crate::event_data::OnSurfaceImportedEvent;
pub use crate::event_data::OnSurfaceRenamedEvent;
pub use crate::event_data::OnTechnologyEffectsResetEvent;
pub use crate::event_data::OnTerritoryCreatedEvent;
pub use crate::event_data::OnTerritoryDestroyedEvent;
pub use crate::event_data::OnTickEvent;
pub use crate::event_data::OnTowerMinedPlantEvent;
pub use crate::event_data::OnTowerPlantedSeedEvent;
pub use crate::event_data::OnTowerPreMinedPlantEvent;
pub use crate::event_data::OnTrainChangedStateEvent;
pub use crate::event_data::OnTrainCreatedEvent;
pub use crate::event_data::OnTrainScheduleChangedEvent;
pub use crate::event_data::OnTriggerCreatedEntityEvent;
pub use crate::event_data::OnTriggerFiredArtilleryEvent;
pub use crate::event_data::OnUdpPacketReceivedEvent;
pub use crate::event_data::OnUndoAppliedEvent;
pub use crate::event_data::OnUnitAddedToGroupEvent;
pub use crate::event_data::OnUnitGroupCreatedEvent;
pub use crate::event_data::OnUnitGroupFinishedGatheringEvent;
pub use crate::event_data::OnUnitRemovedFromGroupEvent;
pub use crate::event_data::OnWorkerRobotExpiredEvent;
pub use crate::event_data::ScriptRaisedBuiltEvent;
pub use crate::event_filters::LuaScriptRaisedBuiltEventFilter as ScriptRaisedBuiltFilter;
pub use crate::event_data::ScriptRaisedDestroyEvent;
pub use crate::event_filters::LuaScriptRaisedDestroyEventFilter as ScriptRaisedDestroyFilter;
pub use crate::event_data::ScriptRaisedDestroySegmentedUnitEvent;
pub use crate::event_filters::LuaScriptRaisedDestroySegmentedUnitEventFilter as ScriptRaisedDestroySegmentedUnitFilter;
pub use crate::event_data::ScriptRaisedReviveEvent;
pub use crate::event_filters::LuaScriptRaisedReviveEventFilter as ScriptRaisedReviveFilter;
pub use crate::event_data::ScriptRaisedSetTilesEvent;
pub use crate::event_data::ScriptRaisedTeleportedEvent;
pub use crate::event_filters::LuaScriptRaisedTeleportedEventFilter as ScriptRaisedTeleportedFilter;

Structs§

CustomInputEvent
Called when a CustomInputPrototype is activated.
OnAchievementGained
Called when an achievement is gained.
OnAiCommandCompleted
Called when a unit/group completes a command.
OnAreaCloned
Called when an area of the map is cloned.
OnBiterBaseBuilt
Called when a biter migration builds a base.
OnBlueprintSettingsPasted
Called when a blueprint entity is pasted over an existing entity or entity ghost.
OnBrushCloned
Called when a set of positions on the map is cloned.
OnBuildBaseArrived
Called when a defines.command.build_base command reaches its destination, and before building starts.
OnBuiltEntity
Called when player builds something.
OnCancelledDeconstruction
Called when the deconstruction of an entity is canceled.
OnCancelledUpgrade
Called when the upgrade of an entity is canceled.
OnCargoPodDeliveredCargo
Called after a cargo pod has delivered its cargo.
OnCargoPodFinishedAscending
Called when a cargo pod departs a surface.
OnCargoPodFinishedDescending
Called when a cargo pods lands on a surface, either at a station or on the ground.
OnCargoPodStartedAscending
Called when a cargo pod departs from a space platform hub or by another method not attached to a rocket.
OnCharacterCorpseExpired
Called when a character corpse expires due to timeout or all of the items being removed from it.
OnChartTagAdded
Called when a chart tag is created.
OnChartTagModified
Called when a chart tag is modified by a player or by script.
OnChartTagRemoved
Called just before a chart tag is deleted.
OnChunkCharted
Called when a chunk is charted or re-charted.
OnChunkDeleted
Called when one or more chunks are deleted using LuaSurface::delete_chunk.
OnChunkGenerated
Called when a chunk is generated.
OnCombatRobotExpired
Called when a combat robot expires through a lack of energy, or timeout.
OnConsoleChat
Called when a message is sent to the in-game console, either by a player or through the server interface.
OnConsoleCommand
Called when someone enters a command-like message regardless of it being a valid command.
OnCutsceneCancelled
Called when a cutscene is cancelled by the player or by script.
OnCutsceneFinished
Called when a cutscene finishes naturally (was not cancelled).
OnCutsceneStarted
Called when a cutscene starts.
OnCutsceneWaypointReached
Called when a cutscene is playing, each time it reaches a waypoint in that cutscene.
OnEntityCloned
Called when an entity is cloned. The filter applies to the source entity.
OnEntityColorChanged
Called after an entity has been recolored either by the player or through script.
OnEntityDamaged
Called when an entity is damaged. This is not called when an entities health is set directly by another mod.
OnEntityDied
Called when an entity dies.
OnEntityLogisticSlotChanged
Called when one of an entity’s logistic slots changes.
OnEntityRenamed
Called after an entity has been renamed either by the player or through script.
OnEntitySettingsPasted
Called after entity copy-paste is done.
OnEntitySpawned
Called when an entity is spawned by a EnemySpawner
OnEquipmentInserted
Called after equipment is inserted into an equipment grid.
OnEquipmentRemoved
Called after equipment is removed from an equipment grid.
OnForceCeaseFireChanged
Called when the a forces cease fire values change.
OnForceCreated
Called when a new force is created using game.create_force()
OnForceFriendsChanged
Called when the a forces friends change.
OnForceReset
Called when LuaForce::reset is finished.
OnForcesMerged
Called after two forces have been merged using game.merge_forces().
OnForcesMerging
Called when two forces are about to be merged using game.merge_forces().
OnGameCreatedFromScenario
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.
OnGuiCheckedStateChanged
Called when LuaGuiElement checked state is changed (related to checkboxes and radio buttons).
OnGuiClick
Called when LuaGuiElement is clicked.
OnGuiClosed
Called when the player closes the GUI they have open.
OnGuiConfirmed
Called when a LuaGuiElement is confirmed, for example by pressing Enter in a textfield.
OnGuiElemChanged
Called when LuaGuiElement element value is changed (related to choose element buttons).
OnGuiHover
Called when LuaGuiElement is hovered by the mouse.
OnGuiInventoryAction
Called when a player interacts with a custom inventory GUI.
OnGuiLeave
Called when the player’s cursor leaves a LuaGuiElement that was previously hovered.
OnGuiLocationChanged
Called when LuaGuiElement element location is changed (related to frames in player.gui.screen).
OnGuiOpened
Called when the player opens a GUI.
OnGuiSelectedTabChanged
Called when LuaGuiElement selected tab is changed (related to tabbed-panes).
OnGuiSelectionStateChanged
Called when LuaGuiElement selection state is changed (related to drop-downs and listboxes).
OnGuiSwitchStateChanged
Called when LuaGuiElement switch state is changed (related to switches).
OnGuiTextChanged
Called when LuaGuiElement text is changed by the player.
OnGuiValueChanged
Called when LuaGuiElement slider value is changed (related to the slider element).
OnLandMineArmed
Called when a land mine is armed.
OnLuaShortcut
Called when a custom Lua shortcut is pressed.
OnMarkedForDeconstruction
Called when an entity is marked for deconstruction with the Deconstruction planner or via script.
OnMarkedForUpgrade
Called when an entity is marked for upgrade with the upgrade planner or via script.
OnMarketItemPurchased
Called after a player purchases some offer from a market entity.
OnModItemOpened
Called when the player uses the ‘Open item GUI’ control on an item defined with the ‘mod-openable’ flag
OnMultiplayerInit
Called when LuaGameScript::is_multiplayer changes to true. May also be raised when it was already true but a game was loaded from a save file and with hosting.
OnObjectDestroyed
Called after an object is destroyed which was registered with LuaBootstrap::register_on_object_destroyed previously.
OnPermissionGroupAdded
Called directly after a permission group is added.
OnPermissionGroupDeleted
Called directly after a permission group is deleted.
OnPermissionGroupEdited
Called directly after a permission group is edited in some way.
OnPermissionStringImported
Called directly after a permission string is imported.
OnPickedUpItem
Called when a player picks up an item.
OnPlayerAltReverseSelectedArea
Called after a player alt-reverse-selects an area with a selection-tool item.
OnPlayerAltSelectedArea
Called after a player alt-selects an area with a selection-tool item.
OnPlayerAmmoInventoryChanged
Called after a players ammo inventory changed in some way.
OnPlayerArmorInventoryChanged
Called after a players armor inventory changed in some way.
OnPlayerBanned
Called when a player is banned.
OnPlayerBuiltTile
Called after a player builds tiles.
OnPlayerCancelledCrafting
Called when a player cancels crafting.
OnPlayerChangedForce
Called after a player changes forces.
OnPlayerChangedPosition
Called when the tile position a player is located at changes.
OnPlayerChangedSurface
Called after a player changes surfaces.
OnPlayerCheatModeDisabled
Called when cheat mode is disabled on a player.
OnPlayerCheatModeEnabled
Called when cheat mode is enabled on a player.
OnPlayerClickedGpsTag
Called when a player clicks a gps tag
OnPlayerColorChanged
Called after a player’s color changes.
OnPlayerConfiguredBlueprint
Called when a player clicks the “confirm” button in the configure Blueprint GUI.
OnPlayerControllerChanged
Called after a player changes controller types.
OnPlayerCraftedItem
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).
OnPlayerCreated
Called after the player was created.
OnPlayerCursorStackChanged
Called after a player’s cursor stack changed in some way.
OnPlayerDeconstructedArea
Called when a player selects an area with a deconstruction planner.
OnPlayerDemoted
Called when a player is demoted.
OnPlayerDied
Called after a player dies.
OnPlayerDisplayDensityScaleChanged
Called when the display density scale changes for a given player. The display density scale is the scale value automatically applied based on the player’s display DPI. This is only relevant on platforms that support high-density displays.
OnPlayerDisplayResolutionChanged
Called when the display resolution changes for a given player.
OnPlayerDisplayScaleChanged
Called when the display scale changes for a given player.
OnPlayerDrivingChangedState
Called when the player’s driving state has changed, meaning a player has either entered or left a vehicle.
OnPlayerDroppedItem
Called when a player drops an item on the ground.
OnPlayerDroppedItemIntoEntity
Called when a player drops a single item into an entity.
OnPlayerFastTransferred
Called when a player fast-transfers something to or from an entity.
OnPlayerFlippedEntity
Called when the player flips an entity. This event is only fired when the entity actually changes its orientation or mirroring, so it won’t be triggered when pressing the flip keys on an entity that can’t be flipped.
OnPlayerFlushedFluid
Called after player flushed fluid
OnPlayerGunInventoryChanged
Called after a players gun inventory changed in some way.
OnPlayerInputMethodChanged
Called when a player’s input method changes. See LuaPlayer::input_method.
OnPlayerJoinedGame
Called after a player joins the game. This is not called when loading a save file in singleplayer, as the player doesn’t actually leave the game, and the save is just on pause until they rejoin.
OnPlayerKicked
Called when a player is kicked.
OnPlayerLeftGame
Called after a player leaves the game. This is not called when closing a save file in singleplayer, as the player doesn’t actually leave the game, and the save is just on pause until they rejoin.
OnPlayerLocaleChanged
Called when a player’s active locale changes. See LuaPlayer::locale.
OnPlayerMainInventoryChanged
Called after a players main inventory changed in some way.
OnPlayerMinedEntity
Called after the results of an entity being mined are collected just before the entity is destroyed.
OnPlayerMinedItem
Called when the player mines something.
OnPlayerMinedTile
Called after a player mines tiles.
OnPlayerMusicChanged
Called when a player’s current music track (ambient sound) changes. This includes when the music track finishes playing.
OnPlayerMuted
Called when a player is muted.
OnPlayerPipette
Called when a player invokes the “smart pipette” over an entity.
OnPlayerPlacedEquipment
Called after the player puts equipment in an equipment grid
OnPlayerPromoted
Called when a player is promoted.
OnPlayerRemoved
Called when a player is removed (deleted) from the game. This is markedly different from a player temporarily leaving the game, and instead behaves like the player never existed in the save file.
OnPlayerRemovedEquipment
Called after the player removes equipment from an equipment grid
OnPlayerRepairedEntity
Called when a player repairs an entity.
OnPlayerRespawned
Called after a player respawns.
OnPlayerReverseSelectedArea
Called after a player reverse-selects an area with a selection-tool item.
OnPlayerRotatedEntity
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.
OnPlayerSelectedArea
Called after a player selects an area with a selection-tool item.
OnPlayerSetQuickBarSlot
Called when a player sets a quickbar slot to anything (new value, or set to empty).
OnPlayerSetupBlueprint
Called when a player selects an area with a blueprint.
OnPlayerToggledAltMode
Called when a player toggles alt mode, also known as “show entity info”.
OnPlayerToggledMapEditor
Called when a player toggles the map editor on or off.
OnPlayerTrashInventoryChanged
Called after a players trash inventory changed in some way.
OnPlayerUnbanned
Called when a player is un-banned.
OnPlayerUnmuted
Called when a player is unmuted.
OnPlayerUsedCapsule
Called when a player uses a capsule that results in some game action.
OnPlayerUsedSpidertronRemote
Called when a player uses spidertron remote to send all selected units to a given position
OnPostEntityDied
Called after an entity dies.
OnPostSegmentedUnitDied
Called after a segmented unit dies.
OnPreBuild
Called when players uses an item to build something. Called before on_built_entity.
OnPreChunkDeleted
Called before one or more chunks are deleted using LuaSurface::delete_chunk.
OnPreEntitySettingsPasted
Called before entity copy-paste is done.
OnPreGhostDeconstructed
Called before a ghost entity is destroyed as a result of being marked for deconstruction.
OnPreGhostUpgraded
Called before a ghost entity is upgraded.
OnPrePermissionGroupDeleted
Called directly before a permission group is deleted.
OnPrePermissionStringImported
Called directly before a permission string is imported.
OnPrePlayerCraftedItem
Called when a player queues something to be crafted.
OnPrePlayerDied
Called before a players dies.
OnPrePlayerLeftGame
Called before a player leaves the game.
OnPrePlayerMinedItem
Called when the player completes a mining action, but before the entity is potentially removed from the map. This is called even if the entity does not end up being removed.
OnPrePlayerRemoved
Called before a player is removed (deleted) from the game. This is markedly different from a player temporarily leaving the game, and instead behaves like the player never existed in the save file.
OnPrePlayerToggledMapEditor
Called before a player toggles the map editor on or off.
OnPreRobotExplodedCliff
Called directly before a robot explodes cliffs.
OnPreScenarioFinished
Called just before the scenario finishes.
OnPreScriptInventoryResized
Called just before a script inventory is resized.
OnPreSurfaceCleared
Called just before a surface is cleared (all entities removed and all chunks deleted).
OnPreSurfaceDeleted
Called just before a surface is deleted.
OnRedoApplied
Called when the player triggers “redo”.
OnResearchCancelled
Called when research is cancelled.
OnResearchFinished
Called when a research finishes.
OnResearchMoved
Called when research is moved forwards or backwards in the research queue.
OnResearchQueued
Called when research is queued.
OnResearchReversed
Called when a research is reversed (unresearched).
OnResearchStarted
Called when a technology research starts.
OnResourceDepleted
Called when a resource entity reaches 0 or its minimum yield for infinite resources.
OnRobotBuiltEntity
Called when a construction robot builds an entity.
OnRobotBuiltTile
Called after a robot builds tiles.
OnRobotExplodedCliff
Called directly after a robot explodes cliffs.
OnRobotMined
Called when a robot mines an entity.
OnRobotMinedEntity
Called after the results of an entity being mined are collected just before the entity is destroyed.
OnRobotMinedTile
Called after a robot mines tiles.
OnRobotPreMined
Called before a robot mines an entity.
OnRocketLaunchOrdered
Called when a rocket silo is ordered to be launched.
OnRocketLaunched
Called when a rocket finishes ascending. (Triggers listening for finished rocket launch past 2.0 have been moved to ‘on_cargo_pod_finished_ascending’ as rocket and cargo pod are two separate entities)
OnRuntimeModSettingChanged
Called when a runtime mod setting is changed by a player.
OnScriptInventoryResized
Called just after a script inventory is resized.
OnScriptPathRequestFinished
Called when a LuaSurface::request_path call completes.
OnScriptTriggerEffect
Called when a script trigger effect is triggered.
OnSectorScanned
Called when an entity of type radar finishes scanning a sector.
OnSegmentEntityCreated
Called when an individual segment of a SegmentedUnit is created.
OnSegmentedUnitCreated
Called when a segmented unit is created for any reason.
OnSegmentedUnitDamaged
Called when a segmented unit is damaged. This is not called when a segmented unit’s health is set directly by another mod.
OnSegmentedUnitDied
Called when a segmented unit dies.
OnSelectedEntityChanged
Called after the selected entity changes for a given player.
OnSingleplayerInit
Called when LuaGameScript::is_multiplayer changes to false. May also be raised when it was already false but a game was loaded from a save file without hosting.
OnSpacePlatformBuiltEntity
Called when a space platform builds an entity.
OnSpacePlatformBuiltTile
Called after a space platform builds tiles.
OnSpacePlatformChangedState
Called when a space platform changes state
OnSpacePlatformMinedEntity
Called after the results of an entity being mined are collected just before the entity is destroyed.
OnSpacePlatformMinedItem
Called when a platform mines an entity.
OnSpacePlatformMinedTile
Called after a platform mines tiles.
OnSpacePlatformPreMined
Called before a platform mines an entity.
OnSpiderCommandCompleted
Called when a spider finishes moving to its autopilot position.
OnStringTranslated
Called when a translation request generated through LuaPlayer::request_translation or LuaPlayer::request_translations has been completed.
OnSurfaceCleared
Called just after a surface is cleared (all entities removed and all chunks deleted).
OnSurfaceCreated
Called when a surface is created.
OnSurfaceDeleted
Called after a surface is deleted.
OnSurfaceImported
Called after a surface is imported via the map editor.
OnSurfaceRenamed
Called when a surface is renamed.
OnTechnologyEffectsReset
Called when LuaForce::reset_technology_effects is finished.
OnTerritoryCreated
Called when a territory is created for any reason.
OnTerritoryDestroyed
Called when a territory is destroyed from a surface.
OnTick
It is fired once every tick. Since this event is fired every tick, its handler shouldn’t include performance heavy code.
OnTowerMinedPlant
Called after the results of an entity being mined are collected just before the entity is destroyed.
OnTowerPlantedSeed
Called before an agricultural tower plants a seed.
OnTowerPreMinedPlant
Called before an agricultural tower mines a plant.
OnTrainChangedState
Called when a train changes state (started to stopped and vice versa)
OnTrainCreated
Called when a new train is created either through disconnecting/connecting an existing one or building a new one.
OnTrainScheduleChanged
Called when a trains schedule is changed either by the player or through script.
OnTriggerCreatedEntity
Called when an entity with a trigger prototype (such as capsules) create an entity AND that trigger prototype defined trigger_created_entity=true.
OnTriggerFiredArtillery
Called when an entity with a trigger prototype (such as capsules) fire an artillery projectile AND that trigger prototype defined trigger_fired_artillery=true.
OnUdpPacketReceived
Called when new packets are processed by LuaHelpers::recv_udp.
OnUndoApplied
Called when the player triggers “undo”.
OnUnitAddedToGroup
Called when a unit is added to a unit group.
OnUnitGroupCreated
Called when a new unit group is created, before any members are added to it.
OnUnitGroupFinishedGathering
Called when a unit group finishes gathering and starts executing its command.
OnUnitRemovedFromGroup
Called when a unit is removed from a unit group.
OnWorkerRobotExpired
Called when a worker (construction or logistic) robot expires through a lack of energy.
ScriptRaisedBuilt
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.
ScriptRaisedDestroy
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.
ScriptRaisedDestroySegmentedUnit
A static event that mods can use to tell other mods they destroyed a segmented unit by script. This event is only raised if a mod does so with LuaBootstrap::raise_event, or LuaBootstrap::raise_script_destroy_segmented_unit, or when raise_destroy is passed to LuaSegmentedUnit::destroy.
ScriptRaisedRevive
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.
ScriptRaisedSetTiles
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.
ScriptRaisedTeleported
A static event mods can use to tell other mods they teleported something by script. This event is only raised if a mod does so with LuaBootstrap::raise_event or LuaBootstrap::raise_script_teleported, or when raise_teleported is passed to LuaControl::teleport.