GameEvents (Civ5 Type)

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)
					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.