LuaEvents.ScenarioPlayerStatusChanged (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

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

Function.png This function is a member of LuaEvents.

This is a static method, invoke it with a dot.


void LuaEvents.ScenarioPlayerStatusChanged(table(PlayerID => table(string => table)) tPlayerStatus, PlayerID turn, int year, PlayerID playerAboutToWin, int turnsControlHeld)

Event Type

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


tPlayerStatus: No description available.
turn: No description available.
year: No description available.
playerAboutToWin: No description available.
turnsControlHeld: No description available.

Source code samples

Redundant occurences have been removed.

TurnsRemaining.lua (G&K)

LuaEvents.ScenarioPlayerStatusChanged(tCopy, Game.GetGameTurn(), Game.GetGameTurnYear(), giPlayerAboutToWin, giTurnsControlHeld);
LuaEvents.ScenarioPlayerStatusChanged(tCopy, Game.GetGameTurn(), Game.GetGameTurnYear(), -1, 0);
LuaEvents.ScenarioPlayerStatusChanged.Add( ReceivePlayerStatusChanged );
LuaEvents.ScenarioPlayerStatusChanged(tPlayerStatusCopy, Game.GetGameTurn() - 1, Game.GetGameTurnYear() - 1, giPlayerAboutToWin, giTurnsControlHeld); --antonjs: todo: save and load the turn and year

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.