Lua Game Events: Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 2: Line 2:


[http://forums.civfanatics.com/showthread.php?t=385612 Lua Events List] or the same [http://wiki.2kgames.com/civ5/index.php/Lua_Game_Events in the official wiki]
[http://forums.civfanatics.com/showthread.php?t=385612 Lua Events List] or the same [http://wiki.2kgames.com/civ5/index.php/Lua_Game_Events in the official wiki]
==Game==
*[[LoadScreenClose]]
*[[PreGameDirty]]
*[[SerialEventEndTurnDirty]]
*[[SequenceGameInitComplete]]
*[[SerialEventGameDataDirty]]
*[[SerialEventStartGame]]
*[[GameEvents.PreGameStart]] - called before most items in the game are initialized.
==Team==
*[[GameEvents.TeamSetHasTech(teamID, techID)]]
*[[GameEvents.TeamTechResearched(eTeam, eTech, iChange)]] - triggered when a team researches a tech.


==Player==
==Player==
*[[ActivePlayerTurnEnd]]
*[[ActivePlayerTurnEnd]]
*[[ActivePlayerTurnStart]] - fired on the start of the human player's turn (not fired for AIs).
*[[ActivePlayerTurnStart]] - fired on the start of the human player's turn (not fired for AIs).
*[[EventPoliciesDirty]]
*[[GameplaySetActivePlayer]]
*[[GameplaySetActivePlayer]]
*[[OpenPlayerDealScreenEvent]]
*[[SerialEventEraChanged]]
*[[PlayerChoseToLoadGame]]
*[[SerialEventResearchDirty]]
*[[PlayerChoseToLoadMap]]
*[[SerialEventScoreDirty]]
*[[RemotePlayerTurnEnd]]
*[[TeamMet]]
*[[TechAcquired]]
*[[WarStateChanged]]
 
 
*[[GameEvents.CanDeclareWar(team1, team2)]] - allows provision of criteria for the ability of team1 to declare war on team2. As this is a TestAll event, all listeners must return true for the action to be permitted.
*[[GameEvents.PlayerAdoptPolicy(playerID, policyTypeID)]]
*[[GameEvents.PlayerAdoptPolicyBranch(playerID, policyBranchTypeID)]]
*[[GameEvents.PlayerCanAdoptPolicy(playerID, policyTypeID)]]
*[[GameEvents.PlayerCanAdoptPolicyBranch(playerID, policyBranchTypeID)]]
*[[GameEvents.PlayerCanConstruct(playerID, buildingTypeID)]]
*[[GameEvents.PlayerCanCreate(playerID, projectTypeID)]]
*[[GameEvents.PlayerCanEverReseearch(playerID, techtypeID)]]
*[[GameEvents.PlayerCanMaintain(playerID, processTypeID)]]
*[[GameEvents.PlayerCanPrepare(playerID, specialistTypeID)]]
*[[GameEvents.PlayerCanResearch(playerID, techTypeID)]]
*[[GameEvents.PlayerCanTrain(playerID, unitTypeID)]]
*[[GameEvents.PlayerDoTurn()]] - fired once per turn for each player (not just active/human player), at the start of turn; also, it seems not to run for the first turn of the game (for all players), runs only for human player on the second turn, and thereafter it runs for all players.
*[[GameEvents.PlayerPreAIUnitUpdate(playerId)]]
*[[GameEvents.SetAlly(iCSPlayer, iOldAlly, iNewAlly)]] - triggered when the ally of a City-State changes (whether it changes from none or from another player).
*[[GameEvents.TeamMeet(playerActive, playerMet)]] - presumably called when players meet, but referring to teams.
 


==City==
==City==
Line 29: Line 69:
*[[SerialEventExitCityScreen]]
*[[SerialEventExitCityScreen]]
*[[SpecificCityInfoDirty]] - fired when something in a particular city was changed.
*[[SpecificCityInfoDirty]] - fired when something in a particular city was changed.
*[[GameEvents.CityCanBuyAnyPlot(ownerID, cityID)]]
*[[GameEvents.CityCanBuyPlot(ownerID, cityID, plotX, plotY)]]
*[[GameEvents.CityCanConstruct(iPlayer, iCity, iBuildingType)]] - this allows provision of critera for the ability to construct a particular building (including Wonders, presumably) in a particular city. Based on the behaviour in the 1066 scenario, it seems that returns of false lead to the building not appearing in the list of buildings available to construct, rather than being greyed out, but this hasn't been specifically checked. It makes some sense, though, as there's no way to provide a tooltip to explain the greying out under this mechanism.
*[[GameEvents.CityCanCreate(ownerID, cityID, projectTypeID)]]
*[[GameEvents.CityCanMaintain(ownerID, cityID, processTypeID)]]
*[[GameEvents.CityCanPrepare(ownerID, cityID, specialistTypeID)]]
*[[GameEvents.CityCanTrain(ownerID, cityID, unitTypeID)]]
*[[GameEvents.CityCaptureComplete(playerID, bCapital, iX, iY, newPlayerID)]]
*[[GameEvents.SetPopulation(iX, iY, oldPopulation, newPopulation)]]


==Unit==
==Unit==
Line 74: Line 126:
*[[UnitTypeChanged]]
*[[UnitTypeChanged]]
*[[UnitVisibilityChanged]]
*[[UnitVisibilityChanged]]
===CombatSim===
*[[RunCombatSim]]
*[[EndCombatSim]]
*[[GameEvents.UnitGetSpecialExploreTarget(iPlayerID, iUnitID)]] - appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target.
*[[GameEvents.UnitSetXY(iPlayer, iUnitID, iX, iY)]] - triggered whenever any unit moves by any means, for every tile they move into.


==Improvement==
 
==Map objects==
*[[NaturalWonderRevealed]]
===Improvements===
*[[SerialEventImprovementCreated]]
*[[SerialEventImprovementCreated]]
*[[SerialEventImprovementDestroyed]]
*[[SerialEventImprovementDestroyed]]
*[[SerialEventImprovementIconCreated]]
*[[SerialEventImprovementIconCreated]]
*[[SerialEventImprovementIconDestroyed]]
*[[SerialEventImprovementIconDestroyed]]
 
*[[SerialEventRoadCreated]]
==Feature==
*[[SerialEventRoadDestroyed]]
===Features===
*[[SerialEventFeatureCreated]]
*[[SerialEventFeatureCreated]]
*[[SerialEventFeatureDestroyed]]
*[[SerialEventFeatureDestroyed]]
*[[SerialEventForestCreated]]
*[[SerialEventForestRemoved]]
*[[SerialEventJungleCreated]]
*[[SerialEventJungleRemoved]]


==Hex==
==Hex==
Line 108: Line 176:
*[[UnitHexHighlight]]
*[[UnitHexHighlight]]


==Game==
 
*[[PlayerChoseToLoadGame]]
===Mods===
*[[PreGameDirty]]
*[[AfterModsActivate]]
*[[SequenceGameInitComplete]]
*[[AfterModsDeactivate]]
*[[SerialEventGameDataDirty]]
*[[BeforeModsActivate]]
*[[BeforeModsDeactivate]]
*[[InstalledModsUpdated]]
*[[ModDownloadComplete]]
*[[ModDownloadStarted]]
 
 
==Interface==
*[[AddPopupTextEvent]]
*[[FrontEndPopup]]
*[[MinimapClickedEvent]]
*[[OpenInfoCorner]]
*[[SerialEventGameMessagePopup]]
*[[SerialEventGameMessagePopup]]
*[[SerialEventGameMessagePopupProcessed]]
*[[SerialEventGameMessagePopupProcessed]]
*[[SerialEventGameMessagePopupShown]]
*[[SerialEventGameMessagePopupShown]]
*[[SerialEventStartGame]]
*[[SerialEventInfoPaneDirty]]
 
*[[ToolTipEvent]]
==All Events==
===Advisor===
*[[AppInitComplete]]
*[[ActivePlayerTurnEnd]]
*[[ActivePlayerTurnStart]]
*[[AddPopupTextEvent]]
*[[AddUnitMoveHexRangeHex]]
*[[AdvisorDisplayHide]]
*[[AdvisorDisplayHide]]
*[[AdvisorDisplayShow]]
*[[AdvisorDisplayShow]]
*[[AfterModsActivate]]
===Dawn of Man===
*[[AfterModsDeactivate]]
*[[SerialEventDawnOfManHide]]
*[[AILeaderMessage]]
*[[SerialEventDawnOfManShow]]
===Diplomacy===
*[[ClearDiplomacyTradeTable]]
*[[OpenPlayerDealScreenEvent]]
===Menus===
*[[EventOpenOptionsScreen]]
*[[ExitToMainMenu]]
*[[PlayerChoseToLoadGame]]
*[[PlayerChoseToLoadMap]]
===Notifications===
*[[NotificationActivated]]
*[[NotificationAdded]]
*[[NotificationRemoved]]
 
 
==Game Systems==
===Animation===
*[[AnimationSamplingChanged]]
*[[AnimationSamplingChanged]]
*[[ParticleEffectReloadRequested]]
*[[ParticleEffectStatsRequested]]
*[[ParticleEffectStatsResponse]]
*[[RemoveAllArrowsEvent]]
*[[SerialEventTestAnimations]]
*[[SpawnArrowEvent]]
===Audio===
*[[AudioDebugChangeMusic]]
*[[AudioDebugChangeMusic]]
*[[AudioPlay2DSound]]
*[[AudioPlay2DSound]]
*[[AudioVolumeChanged]]
*[[AudioVolumeChanged]]
*[[BeforeModsActivate]]
===Camera===
*[[BeforeModsDeactivate]]
*[[BuildingLibrarySwap]]
*[[CameraProjectionChanged]]
*[[CameraProjectionChanged]]
*[[CameraStartPitchingDown]]
*[[CameraStartPitchingDown]]
Line 146: Line 241:
*[[CameraStopRotatingCW]]
*[[CameraStopRotatingCW]]
*[[CameraViewChanged]]
*[[CameraViewChanged]]
*[[CityHandleCreated]]
*[[DragCamera]]
*[[CityRuinsCreated]]
*[[SerialEventCameraBack]]
*[[ClearDiplomacyTradeTable]]
*[[SerialEventCameraForward]]
*[[ClearHexHighlights]]
*[[SerialEventCameraIn]]
*[[ClearHexHighlightStyle]]
*[[SerialEventCameraLeft]]
*[[ClearUnitMoveHexRange]]
*[[SerialEventCameraOut]]
*[[SerialEventCameraRight]]
*[[SerialEventCameraSetCenterAndZoom]]
*[[SerialEventCameraStartMovingBack]]
*[[SerialEventCameraStartMovingForward]]
*[[SerialEventCameraStartMovingLeft]]
*[[SerialEventCameraStartMovingRight]]
*[[SerialEventCameraStopMovingBack]]
*[[SerialEventCameraStopMovingForward]]
*[[SerialEventCameraStopMovingLeft]]
*[[SerialEventCameraStopMovingRight]]
===Multiplayer===
*[[ConnectedToNetworkHost]]
*[[ConnectedToNetworkHost]]
*[[DisplayMovementIndicator]]
*[[DontRecordCommandStreams]]
*[[DragCamera]]
*[[EndCombatSim]]
*[[EndGameShow]]
*[[EndTurnTimerUpdate]]
*[[EndUnitMoveHexRange]]
*[[EventOpenOptionsScreen]]
*[[EventPoliciesDirty]]
*[[ExitToMainMenu]]
*[[FrontEndPopup]]
*[[GameMessageChat]]
*[[GameOptionsChanged]]
*[[GameplayAlertMessage]]
*[[GameplayFX]]
*[[GameplaySetActivePlayer]]
*[[GenericWorldAnchor]]
*[[GlobalUnitScale]]
*[[GraphicsOptionsChanged]]
*[[HexFOWStateChanged]]
*[[HexYieldMightHaveChanged]]
*[[InitCityRangeStrike]]
*[[InstalledModsUpdated]]
*[[InterfaceModeChanged]]
*[[KeyUpEvent]]
*[[LandmarkLibrarySwap]]
*[[LanguageChanging]]
*[[LeavingLeaderViewMode]]
*[[LoadScreenClose]]
*[[LocalMachineAppUpdate]]
*[[LocalMachineUnitPositionChanged]]
*[[MinimapClickedEvent]]
*[[MinimapTextureBroadcastEvent]]
*[[ModDownloadComplete]]
*[[ModDownloadStarted]]
*[[MultiplayerConnectionComplete]]
*[[MultiplayerConnectionComplete]]
*[[MultiplayerConnectionFailed]]
*[[MultiplayerConnectionFailed]]
Line 202: Line 273:
*[[MultiplayerProfileDisconnected]]
*[[MultiplayerProfileDisconnected]]
*[[MultiplayerProfileFailed]]
*[[MultiplayerProfileFailed]]
*[[NaturalWonderRevealed]]
*[[RemotePlayerTurnEnd]]
*[[NotificationActivated]]
 
*[[NotificationAdded]]
 
*[[NotificationRemoved]]
==Other (unsorted)==
*[[NotifyAILeaderInGame]]
*[[AppInitComplete]]
*[[OpenInfoCorner]]
*[[AILeaderMessage]]
*[[OpenPlayerDealScreenEvent]]
*[[BuildingLibrarySwap]]
*[[ParticleEffectReloadRequested]]
*[[DisplayMovementIndicator]]
*[[ParticleEffectStatsRequested]]
*[[DontRecordCommandStreams]]
*[[ParticleEffectStatsResponse]]
*[[EndTurnTimerUpdate]]
*[[PlayerChoseToLoadGame]]
*[[GenericWorldAnchor]]
*[[PlayerChoseToLoadMap]]
*[[GraphicsOptionsChanged]]
*[[PreGameDirty]]
*[[InterfaceModeChanged]]
*[[KeyUpEvent]]
*[[LandmarkLibrarySwap]]
*[[LanguageChanging]]
*[[LeavingLeaderViewMode]]
*[[LocalMachineAppUpdate]]
*[[MinimapTextureBroadcastEvent]]
*[[RecordCommandStreams]]
*[[RecordCommandStreams]]
*[[RemotePlayerTurnEnd]]
*[[RemoveAllArrowsEvent]]
*[[RequestYieldDisplay]]
*[[RequestYieldDisplay]]
*[[RunCombatSim]]
*[[SearchForPediaEntry GoToPediaHomePage]]
*[[SearchForPediaEntry GoToPediaHomePage]]
*[[SequenceGameInitComplete]]
*[[SerialEventBuildingSizeChanged]]
*[[SerialEventBuildingSizeChanged]]
*[[SerialEventCameraBack]]
*[[SerialEventCameraForward]]
*[[SerialEventCameraIn]]
*[[SerialEventCameraLeft]]
*[[SerialEventCameraOut]]
*[[SerialEventCameraRight]]
*[[SerialEventCameraSetCenterAndZoom]]
*[[SerialEventCameraStartMovingBack]]
*[[SerialEventCameraStartMovingForward]]
*[[SerialEventCameraStartMovingLeft]]
*[[SerialEventCameraStartMovingRight]]
*[[SerialEventCameraStopMovingBack]]
*[[SerialEventCameraStopMovingForward]]
*[[SerialEventCameraStopMovingLeft]]
*[[SerialEventCameraStopMovingRight]]
*[[SerialEventCityCaptured]]
*[[SerialEventCityContinentChanged]]
*[[SerialEventCityCreated]]
*[[SerialEventCityCultureChanged]]
*[[SerialEventCityDestroyed]]
*[[SerialEventCityHexHighlightDirty]]
*[[SerialEventCityInfoDirty]]
*[[SerialEventCityPopulationChanged]]
*[[SerialEventCityScreenDirty]]
*[[SerialEventCitySetDamage]]
*[[SerialEventDawnOfManHide]]
*[[SerialEventDawnOfManShow]]
*[[SerialEventEndTurnDirty]]
*[[SerialEventEnterCityScreen]]
*[[SerialEventEraChanged]]
*[[SerialEventExitCityScreen]]
*[[SerialEventFeatureCreated]]
*[[SerialEventFeatureDestroyed]]
*[[SerialEventForestCreated]]
*[[SerialEventForestRemoved]]
*[[SerialEventGameDataDirty]]
*[[SerialEventGameMessagePopup]]
*[[SerialEventGameMessagePopupProcessed]]
*[[SerialEventGameMessagePopupShown]]
*[[SerialEventHexCultureChanged]]
*[[SerialEventHexDeSelected]]
*[[SerialEventHexGridOff]]
*[[SerialEventHexGridOn]]
*[[SerialEventHexHighlight]]
*[[SerialEventHexSelected]]
*[[SerialEventImprovementCreated]]
*[[SerialEventImprovementDestroyed]]
*[[SerialEventImprovementIconCreated]]
*[[SerialEventImprovementIconDestroyed]]
*[[SerialEventInfoPaneDirty]]
*[[SerialEventJungleCreated]]
*[[SerialEventJungleRemoved]]
*[[SerialEventLeaderToggleDebugCam]]
*[[SerialEventLeaderToggleDebugCam]]
*[[SerialEventMouseOverHex]]
*[[SerialEventRawResourceCreated]]
*[[SerialEventRawResourceCreated]]
*[[SerialEventRawResourceDestroyed]]
*[[SerialEventRawResourceDestroyed]]
*[[SerialEventRawResourceIconCreated]]
*[[SerialEventRawResourceIconCreated]]
*[[SerialEventRawResourceIconDestroyed]]
*[[SerialEventRawResourceIconDestroyed]]
*[[SerialEventResearchDirty]]
*[[SerialEventRoadCreated]]
*[[SerialEventRoadDestroyed]]
*[[SerialEventScoreDirty]]
*[[SerialEventScreenShot]]
*[[SerialEventScreenShot]]
*[[SerialEventStartGame]]
*[[SerialEventTerrainDecalCreated]]
*[[SerialEventTerrainDecalCreated]]
*[[SerialEventTerrainOverlayMod]]
*[[SerialEventTerrainOverlayMod]]
*[[SerialEventTest]]
*[[SerialEventTest]]
*[[SerialEventTestAnimations]]
*[[SerialEventTurnTimerDirty]]
*[[SerialEventTurnTimerDirty]]
*[[SerialEventUnitCreated]]
*[[SerialEventUnitDestroyed]]
*[[SerialEventUnitFacingChanged]]
*[[SerialEventUnitFlagSelected]]
*[[SerialEventUnitInfoDirty]]
*[[SerialEventUnitMove]]
*[[SerialEventUnitMoveToHexes]]
*[[SerialEventUnitSetDamage]]
*[[SerialEventUnitTeleportedToHex]]
*[[ShowAttackTargets]]
*[[ShowAttackTargets]]
*[[ShowHexYield]]
*[[ShowMovementRange]]
*[[ShowMovementRange]]
*[[SpawnArrowEvent]]
*[[SpecificCityInfoDirty]]
*[[StartUnitMoveHexRange]]
*[[StateMachineDumpStates]]
*[[StateMachineDumpStates]]
*[[StateMachineRequestStates]]
*[[StateMachineRequestStates]]
Line 312: Line 313:
*[[SystemUpdateUI]]
*[[SystemUpdateUI]]
*[[TaskListUpdate]]
*[[TaskListUpdate]]
*[[TeamMet]]
*[[TechAcquired]]
*[[ToggleDisplayUnits]]
*[[ToolTipEvent]]
*[[UIPathFinderUpdate]]
*[[UIPathFinderUpdate]]
*[[UnitActionChanged]]
*[[UnitDataEdited]]
*[[UnitDataRequested]]
*[[UnitDebugFSM]]
*[[UnitEmbark]]
*[[UnitFlagUpdated]]
*[[UnitGarrison]]
*[[UnitHandleCreated]]
*[[UnitHexHighlight]]
*[[UnitHexHighlight]]
*[[UnitLibrarySwap]]
*[[UnitMarkThreatening]]
*[[UnitMemberCombatStateChanged]]
*[[UnitMemberCombatTargetChanged]]
*[[UnitMemberOverlayAdd]]
*[[UnitMemberOverlayMessage]]
*[[UnitMemberOverlayRemove]]
*[[UnitMemberOverlayShowHide]]
*[[UnitMemberOverlayTargetColor]]
*[[UnitMemberPositionChanged]]
*[[UnitMoveQueueChanged]]
*[[UnitSelectionChanged]]
*[[UnitSelectionCleared]]
*[[UnitShouldDimFlag]]
*[[UnitStateChangeDetected]]
*[[UnitTypeChanged]]
*[[UnitVisibilityChanged]]
*[[UserRequestClose]]
*[[UserRequestClose]]
*[[VisibilityUpdated]]
*[[VisibilityUpdated]]
*[[WarStateChanged]]
*[[WonderStateChanged]]
*[[WonderStateChanged]]
*[[WonderTogglePlacement]]
*[[WonderTogglePlacement]]
*[[WonderTypeChanged]]
*[[WonderTypeChanged]]
*[[WorldMouseOver]]
*[[WorldMouseOver]]

Latest revision as of 09:49, 16 February 2012

Up: Lua and UI Reference

Lua Events List or the same in the official wiki


Game



Team


Player



City



Unit

CombatSim



Map objects

Improvements

Features


Hex


Mods


Interface

Advisor

Dawn of Man

Diplomacy

Menus

Notifications


Game Systems

Animation

Audio

Camera

Multiplayer


Other (unsorted)

Retrieved from "https://modiki.civfanatics.com/index.php?title=Lua_Game_Events&oldid=9410"