Area (Civ5 Type)

From Civilization Modding Wiki
Jump to navigationJump to search

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


Instance Methods

Methods are functions that belong to an object. Instance methods are invoked through a colon, as in caller:SomeMethod(<args>), where caller is an instance of Area.
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: caller.SomeMethod(caller, <args>)

C

Base game Gods & Kings ___________________________
int CalculateTotalBestNatureYield()
int CountCoastalLand()
int CountNumUniqueResourceTypes()

G

Base game Gods & Kings ___________________________
int GetCitiesPerPlayer(PlayerID index)
int GetFreeSpecialist(PlayerID index)
AreaID GetID()
int GetNumCities()
int GetNumImprovements(ImprovementType improvement)
int GetNumOwnedTiles()
int GetNumResources(ResourceType resource)
int GetNumRevealedTiles(TeamID index)
int GetNumRiverEdges()
int GetNumStartingPlots()
int GetNumTiles()
int GetNumTotalResources()
int GetNumUnits()
int GetNumUnownedTiles()
int GetNumUnrevealedTiles(TeamID index)
int GetPopulationPerPlayer(PlayerID index)
unknown GetTargetCity(PlayerID index)
int GetTotalPopulation()
int GetUnitsPerPlayer(PlayerID index)
int GetYieldRateModifier(PlayerID index1, YieldType index2)

I

Base game Gods & Kings ___________________________
bool IsNone()
bool IsWater()


Used by

iterator(AreaID, Area) Map.Areas()
Area Map.FindBiggestArea(bool ocean)
Area Map.GetArea(AreaID areaID)
Area Plot:Area()
bool Plot:IsAdjacentToArea(Area area)
bool Plot:IsPotentialCityWorkForArea(Area area)
int Team:CountEnemyDangerByArea(Area area)
int Team:CountNumCitiesByArea(Area area)
int Team:CountNumUnitsByArea(Area area)
int Team:CountTotalPopulationByArea(Area area)
Area Unit:GetArea()



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.