GameEvents.CityCanTrain (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 GameEvents.

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

This works exactly the same as CityCanConstruct but for units instead. Note however that the prerequisites for training units that are defined in the XML files have to be met before this event fires. Thus this event can be used to hide units that would otherwise be shown but not the other way around. Also, this event does not allow to restrict purchasing units with faith.

Usage

void GameEvents.CityCanTrain(PlayerID player, CityID city, UnitType unitType)


Event Type

Unknown

Parameters

player: the index identifying the player who might or might not be able to construct
city: the index identifying the city that might or might not be able to construct
buildingType: the ID of the unit that might or might not be able to be constructed



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.