Area (Civ5 Type)

From Civilization Modding Wiki
Jump to: navigation, 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 ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png int CalculateTotalBestNatureYield()
CheckButZero.png CheckButZero.png Star.png Speech.png int CountCoastalLand()
Check.png Check.png Star.png Speech.png int CountNumUniqueResourceTypes()

G

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

I

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsNone()
CheckButZero.png CheckButZero.png Star.png Speech.png 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.