GameEvents (Civ5 Type): Difference between revisions
(→C) |
(→C) |
||
| Line 34: | Line 34: | ||
{{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, 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. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}} | {{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, 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. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}} | ||
|align="right" |<code><!-- No return type --></code> | |align="right" |<code><!-- No return type --></code> | ||
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType<b>)</b></code><!-- | |width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType<b>)</b></code> | ||
<!-- | |||
CITYCANTRAIN | CITYCANTRAIN | ||
--> | --> | ||
| Line 41: | Line 42: | ||
|align="right" |<code><!-- No return type --></code> | |align="right" |<code><!-- No return type --></code> | ||
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType<b>)</b></code> | |width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType<b>)</b></code> | ||
<!-- | |||
CITYCANANYBUYPLOT | |||
--> | |||
|- | |||
{{FuncInfos5|yes |maybe|yes|}} | |||
|align="right" |<code><!-- No return type --></code> | |||
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyAnyPlot}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city<b>)</b></code> | |||
<!-- | |||
CITYCANBUYPLOT | |||
--> | |||
|- | |||
{{FuncInfos5|yes |maybe|yes|}} | |||
|align="right" |<code><!-- No return type --></code> | |||
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyPlot}}<b>(</b>{{Type5|PlayerID}} player, {{Type5|CityID}} city, '''int''' x, '''int''' y<b>)</b></code> | |||
<!-- | <!-- | ||
CITYCAPTURECOMPLETE | CITYCAPTURECOMPLETE | ||
Revision as of 17:48, 14 February 2014
This page is a part of the Lua and UI Reference (Civ5).
Usage
This object exposes events that you can use to modify the gameplay. As opposed to the events defined on Events and LuaEvents, most of those events are expected to return a value. This value may then be used by the game to prevent or trigger some game actions (such as a declaration of war), or to override some calculations (for example by adding a bonus or a malus to the diplomatic status between two civilizations). Please look at the events' pages to learn more.
Static Events
Events can be subscribed by using GameEvents.SomeEvent.Add(SomeFunction). Regular events can also be fired through a dot by using GameEvents.SomeEvent(<args>). This will invoke all subscribers with the provided arguments.
C
 |
 |
||||
|
|
|
|
bool
|
CanDeclareWar(TeamID myTeam, TeamID theirTeam)
|
|
|
|
CityBuildingsIsBuildingSellable(PlayerID player, BuildingType building)
| ||
|
|
|
|
|
|
CityCanConstruct(PlayerID player, CityID city, BuildingType buildingType)
|
|
|
|
|
|
CityCanTrain(PlayerID player, CityID city, UnitType unitType)
| |
|
|
|
|
|
CityCanBuyAnyPlot(PlayerID player, CityID city)
| |
|
|
|
|
|
CityCanBuyPlot(PlayerID player, CityID city, int x, int y)
| |
|
|
|
|
|
|
CityCaptureComplete(PlayerID player, int capital, ResourceType x, ResourceType y, PlayerID newPlayer, int conquest, int conquest)
|
|
|
|
|
CityConvertsReligion(PlayerID owner, ReligionType religion, int x, int y)
|
D
|
|
||||
|
|
|
|
DoResolveVictoryVote(bool preliminaryVote)
|
G
|
|
||||
|
|
|
|
GameCoreTestVictory()
| ||
|
|
|
|
GameCoreUpdateBegin()
| ||
|
|
|
|
GetFounderBenefitsReligion(PlayerID player)
| ||
|
|
|
|
GetReligionToSpread(PlayerID player)
| ||
|
|
|
|
GetScenarioDiploModifier1(PlayerID player1, PlayerID player2)
| ||
|
|
|
|
GetScenarioDiploModifier2(PlayerID player1, PlayerID player2)
|
P
|
|
||||
|
|
|
|
PlayerAdoptPolicy(PlayerID player, int policyID)
| ||
|
|
|
|
PlayerCanAdoptPolicyBranch(PlayerID player, int policyBranch)
| ||
|
|
|
|
PlayerCityFounded(PlayerID player, int cityX, int cityY)
| ||
|
|
|
|
|
|
PlayerDoTurn(PlayerID player)
|
|
|
|
|
|
|
PlayerPreAIUnitUpdate(PlayerID player)
|
|
|
|
|
|
|
PreGameStart
|
S
|
|
||||
|
|
|
|
|
|
SetAlly(PlayerID cSPlayer, PlayerID oldAlly, PlayerID newAlly)
|
|
|
|
|
|
|
SetPopulation(int x, int y, unknown oldPopulation, int newPopulation)
|
T
|
|
||||
|
|
|
|
|
|
TeamMeet(unknown playeractive, unknown playermet)
|
|
|
|
|
TeamSetHasTech(TeamID team, TechType tech, bool adopted)
| ||
|
|
|
|
|
|
TeamTechResearched(TeamID team, TechType tech, int change)
|
U
|
|
||||
|
|
|
|
|
UnitGetSpecialExploreTarget(PlayerID player, UnitID unitID)
| |
|
|
|
|
|
|
UnitSetXY(PlayerID player, UnitID unit, int x, int y)
|
Static Methods
Methods are functions that belong to an object. Static methods are invoked through a dot, as in GameEvents.SomeMethod(<args>). When a dot is used the caller object is not implicitly provided as the first argument.
|
|
||||
|
|
|
Accumulate
| ||
|
|
|
|
AccumulateINT
| ||
|
|
|
|
Add
| ||
|
|
|
|
Call
| ||
|
|
|
|
Count
| ||
|
|
|
|
Remove
| ||
|
|
|
|
RemoveAll
| ||
|
|
|
|
TestAll
| ||
|
|
|
|
TestAny
|
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.
