Events.ActivePlayerTurnStart (Civ5 API)

This page is a part of the Lua and UI Reference (Civ5).

This function is a member of Events. This is a static method, invoke it with a dot.

Fires on the turn start of the active player. The active player is the player playing on the local machine. In other words, this fires whenever your turn starts. Compare to ActivePlayerTurnEnd Note: This event does not fire when using Autoplay.

Usage

void Events.ActivePlayerTurnStart()

Event Type

Regular event: you can subscribe to it through Events.ActivePlayerTurnStart.Add(<function handler>) or invoke it directly through Events.ActivePlayerTurnStart(<arguments list>).

Examples

function listener()
print("I'm listening!")
end
Events.ActivePlayerTurnStart.Add(listener)

Source code samples

Redundant occurences have been removed.

DiploCorner.lua (G&K)

DLC/Expansion/UI/InGame/WorldView/DiploCorner.lua

0505	Events.ActivePlayerTurnStart.Add(OnActivePlayerTurnStart);

InGame.lua

UI/InGame/InGame.lua

0733	Events.ActivePlayerTurnStart.Add( OnActivePlayerTurnStart );

MPList.lua

UI/InGame/WorldView/MPList.lua

0337	Events.ActivePlayerTurnStart.Add( OnLocalTurnStart );

NewTurn.lua

UI/InGame/NewTurn.lua

0062	Events.ActivePlayerTurnStart.Add( OnTurnStart );

The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.