City (Civ5 Type)

From Civilization Modding Wiki
Revision as of 16:47, 6 January 2014 by JFD (talk | contribs) (→‎W)
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 City.
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>)

A

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png AddProductionExperience(Unit unit, bool conscript = false)
Check.png Check.png Star.png Speech.png AdoptReligionFully(ReligionType religion)
CheckButZero.png CheckButZero.png Star.png Speech.png UnitType AllUpgradesAvailable(UnitType unit, int upgradeCount = 0)
CheckButZero.png CheckButZero.png Star.png Speech.png AlterWorkingPlot(CityPlotID plotIndex)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png Area
CheckButZero.png CheckButZero.png Star.png Speech.png bool At(int x, int y)
CheckButZero.png CheckButZero.png Star.png Speech.png bool AtPlot(Plot plot)

C

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png CanBuyAnyPlot
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanBuyPlot()
Check.png Check.png Star.png Speech.png bool CanBuyPlotAt(int hexX, int hexY, bool arg2)
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanConscript()
Check.png Check.png Star.png Speech.png bool CanConstruct(BuildingType building, int continue, int testVisible, bool ignoreCost)
Check.png Check.png Star.png Speech.png int CanConstructTooltip(int id)
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanContinueProduction(OrderType orderType, int data1, int data2, bool save)
Check.png Check.png Star.png Speech.png bool CanCreate(ProjectType project, int continue, int testVisible)
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanHurry(HurryType hurry, bool testVisible)
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanJoin()
Check.png Check.png Star.png Speech.png bool CanMaintain(ProcessType process, int continue)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png CanPlaceUnitHere
CheckButZero.png CheckButZero.png Star.png Speech.png bool CanPrepare(int specialist, bool continue)
Check.png Check.png Star.png Speech.png int CanRangeStrike()
Check.png Check.png Star.png Speech.png bool CanRangeStrikeAt(int x, int y, bool arg2, bool arg3)
Check.png Check.png Star.png Speech.png int CanRangeStrikeNow()
Check.png Check.png Star.png Speech.png bool CanTrain(UnitType unit, int continue, int testVisible, bool ignoreCost, bool ignoreUpgrades)
Check.png Check.png Star.png Speech.png int CanTrainTooltip(UnitType id)
Check.png Check.png Star.png Speech.png int CanWork(Plot plot)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeBaseGreatPeopleRate(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ChangeBaseYieldRateFromBuildings
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ChangeBaseYieldRateFromMisc
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ChangeBaseYieldRateFromReligion
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ChangeBaseYieldRateFromSpecialists
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ChangeBaseYieldRateFromTerrain
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeBuildingProduction(BuildingType index, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeBuildingProductionTime(BuildingType index, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeCultureRateModifier(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeCultureUpdateTimer(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeDamage(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeFood(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeGreatPeopleProgress(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeGreatPeopleUnitProgress(UnitType index, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeHealRate(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeJONSCultureLevel(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeJONSCulturePerTurnFromBuildings(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeJONSCulturePerTurnFromPolicies(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeJONSCulturePerTurnFromSpecialists(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeJONSCultureStored(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangePopulation(int change, bool flag)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeProduction(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png int ChangeRazingTurns()
CheckButZero.png CheckButZero.png Star.png Speech.png int ChangeResistanceTurns()
CheckButZero.png CheckButZero.png Star.png Speech.png int ChangeSpecialistGreatPersonProgressTimes100(SpecialistType index, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeUnitProduction(UnitType index, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeWeLoveTheKingDayCounter(int change)
CheckButZero.png CheckButZero.png Star.png Speech.png ChangeWonderProductionModifier(int change)
Check.png Check.png Star.png Speech.png ChooseProduction(UnitType trainUnit, BuildingType constructBuilding, ProjectType createProject, bool finish, bool front)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png ClearOrderQueue
CheckButZero.png CheckButZero.png Star.png Speech.png ClearWorkingOverride(int index)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png Conscript
CheckButZero.png CheckButZero.png Star.png Speech.png int ConscriptMinCityPopulation()
Check.png Check.png Star.png Speech.png ConvertPercentFollowers(ReligionType arg0, ReligionType arg1, int arg2)
CheckButZero.png CheckButZero.png Star.png Speech.png int CountNumImprovedPlots()
CheckButZero.png CheckButZero.png Star.png Speech.png int CountNumRiverPlots()
CheckButZero.png CheckButZero.png Star.png Speech.png int CountNumWaterPlots()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png CreateApolloProgram
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png CreateGreatAdmiral
CheckButZero.png CheckButZero.png Star.png Speech.png CreateGreatGeneral(UnitType greatPersonUnit)

D

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png DoJONSCultureLevelIncrease
CheckButZero.png CheckButZero.png Star.png Speech.png bool DoPickResourceDemanded()
CheckButZero.png CheckButZero.png Star.png Speech.png int DoReallocateCitizens()
CheckButZero.png CheckButZero.png Star.png Speech.png DoTask(TaskType task, int data1, int data2, bool option)
CheckButZero.png CheckButZero.png Star.png Speech.png int DoVerifyWorkingPlots()

F

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png int FindBaseYieldRateRank(YieldType yield)
CheckButZero.png CheckButZero.png Star.png Speech.png int FindPopulationRank()
CheckButZero.png CheckButZero.png Star.png Speech.png int FindYieldRateRank(YieldType yield)
Check.png Check.png Star.png Speech.png int FoodConsumption(bool noAngry, int extra)
Check.png Check.png Star.png Speech.png int FoodDifference(bool bottom)
Check.png Check.png Star.png Speech.png int FoodDifferenceTimes100(bool bottom)

G

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png int GetAirModifier()
CheckButZero.png CheckButZero.png Star.png Speech.png ArtStyleType GetArtStyleType()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBaseGreatPeopleRate()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBaseJONSCulturePerTurn()
Check.png Check.png Star.png Speech.png int GetBaseYieldRate(YieldType index)
Check.png Check.png Star.png Speech.png int GetBaseYieldRateFromBuildings(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetBaseYieldRateFromMisc(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetBaseYieldRateFromReligion(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetBaseYieldRateFromSpecialists(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetBaseYieldRateFromTerrain(YieldType yieldType)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBaseYieldRateModifier(YieldType index, int extra = 0)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingDefense()
Check.png Check.png Star.png Speech.png int GetBuildingEspionageModifier(BuildingType building)
Check.png Check.png Star.png Speech.png int GetBuildingFaithPurchaseCost(BuildingType building, bool arg1 = nil)
Check.png Check.png Star.png Speech.png int GetBuildingGlobalEspionageModifier(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingOriginalOwner(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingOriginalTime(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingProduction(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingProductionModifier(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingProductionNeeded()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingProductionTime(BuildingType index)
Check.png Check.png Star.png Speech.png int GetBuildingProductionTurnsLeft(BuildingType building, int num)
Check.png Check.png Star.png Speech.png int GetBuildingPurchaseCost(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetBuildingYieldChange(BuildingClassType buildingClass, YieldType yield)
Check.png Check.png Star.png Speech.png ... GetBuyablePlotList()
Check.png Check.png Star.png Speech.png int GetBuyPlotCost(int x, int y)
Check.png Check.png Star.png Speech.png Plot GetCityIndexPlot(CityPlotID index)
CheckButZero.png CheckButZero.png Star.png Speech.png CityPlotID GetCityPlotIndex(Plot plot)
CheckButZero.png CheckButZero.png Star.png Speech.png unknown GetCitySizeType()
CheckButZero.png CheckButZero.png Star.png Speech.png CivilizationType GetCivilizationType()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetConscriptPopulation()
CheckButZero.png CheckButZero.png Star.png Speech.png UnitType GetConscriptUnit()
Check.png Check.png Star.png Speech.png int GetCultureFromSpecialist(SpecialistType specialist)
Check.png Check.png Star.png Speech.png int GetCultureRateModifier()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetCultureUpdateTimer()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetCurrAirlift()
Check.png Check.png Star.png Speech.png int GetCurrentProductionDifference(bool ignoreFood, bool overflow)
Check.png Check.png Star.png Speech.png int GetCurrentProductionDifferenceTimes100(bool ignoreFood, bool overflow)
Check.png Check.png Star.png Speech.png int GetDamage()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetDomainFreeExperience(DomainType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetDomainProductionModifier(DomainType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetExtraProductionDifference(int extra)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetExtraSpecialistYield(YieldType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetExtraSpecialistYieldOfType(YieldType index, SpecialistType specialist)
Check.png Check.png Star.png Speech.png int GetFaithPerTurn()
Check.png Check.png Star.png Speech.png int GetFaithPerTurnFromBuildings()
Check.png Check.png Star.png Speech.png int GetFaithPerTurnFromPolicies()
Check.png Check.png Star.png Speech.png int GetFaithPerTurnFromReligion()
Check.png Check.png Star.png Speech.png int GetFaithPerTurnFromTraits()
Check.png Check.png Star.png Speech.png int GetFaithPurchaseBuildingTooltip(int id)
Check.png Check.png Star.png Speech.png int GetFaithPurchaseUnitTooltip(UnitType id)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetFavoredReligion
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFeatureProduction()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFirstBuildingOrder(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFirstProjectOrder(ProjectType project)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFirstSpecialistOrder(SpecialistType specialist)
Check.png Check.png Star.png Speech.png int GetFirstUnitOrder(UnitType unit)
Check.png Check.png Star.png Speech.png CityAIFocusType GetFocusType()
Check.png Check.png Star.png Speech.png int GetFood()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFoodKept()
Check.png Check.png Star.png Speech.png int GetFoodTimes100()
Check.png Check.png Star.png Speech.png int GetFoodTurnsLeft()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFreeExperience()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetFreePromotionCount(PromotionType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGameTurnAcquired()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGameTurnFounded()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGameTurnLastExpanded()
Check.png Check.png Star.png Speech.png Unit GetGarrisonedUnit()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGeneralProductionTurnsLeft()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGreatPeopleProgress()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGreatPeopleRate()
Check.png Check.png Star.png Speech.png int GetGreatPeopleRateModifier()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGreatPeopleUnitProgress(UnitType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetGreatPeopleUnitRate(UnitType index)
CheckButZero.png CheckButZero.png Star.png Speech.png HandicapType GetHandicapType()
Check.png Check.png Star.png Speech.png int GetHappiness()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetHappinessFromBuildings
CheckButZero.png CheckButZero.png Star.png Speech.png int GetHighestPopulation()
Check.png Check.png Star.png Speech.png CityID GetID()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetJONSCultureLevel()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurn()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromBuildings()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromPolicies()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromReligion()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromSpecialists()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromTerrain()
Check.png Check.png Star.png Speech.png int GetJONSCulturePerTurnFromTraits()
Check.png Check.png Star.png Speech.png int GetJONSCultureStored()
Check.png Check.png Star.png Speech.png int GetJONSCultureThreshold()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetLakePlotYield(YieldType index)
Check.png Check.png Star.png Speech.png int GetLocalHappiness()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetLocalResourceWonderProductionMod(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetMaxAirlift()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetMaxFoodKeptPercent()
Check.png Check.png Star.png Speech.png int GetMaxHitPoints()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetMilitaryProductionModifier()
Check.png Check.png Star.png Speech.png string GetName()
Check.png Check.png Star.png Speech.png string GetNameKey()
CheckButZero.png CheckButZero.png Star.png Speech.png unknown GetNextBuyablePlot()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNukeModifier()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumActiveBuilding(BuildingType buildingType)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumBuilding(BuildingType buildingType)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumBuildings()
Check.png Check.png Star.png Speech.png int GetNumCityPlots()
Check.png Check.png Star.png Speech.png int GetNumFollowers(ReligionType religion)
Check.png Check.png Star.png Speech.png int GetNumForcedWorkingPlots(Plot plot)
Check.png Check.png Star.png Speech.png int GetNumFreeBuilding(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumGreatPeople()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumNationalWonders()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumRealBuilding(BuildingType index)
Check.png Check.png Star.png Speech.png int GetNumSpecialistsAllowedByBuilding(BuildingType building)
Check.png Check.png Star.png Speech.png int GetNumSpecialistsInBuilding(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumTeamWonders()
Check.png Check.png Star.png Speech.png int GetNumThingsProduced()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetNumTrainUnitAI(UnitAIType unitAI)
Check.png Check.png Star.png Speech.png int GetNumWorldWonders()
Check.png Check.png Star.png Speech.png OrderType, int, unknown, unknown, unknown GetOrderFromQueue(int arg0)
Check.png Check.png Star.png Speech.png int GetOrderQueueLength()
Check.png Check.png Star.png Speech.png PlayerID GetOriginalOwner()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetOverflowProduction()
Check.png Check.png Star.png Speech.png PlayerID GetOwner()
CheckButZero.png CheckButZero.png Star.png Speech.png LeaderType GetPersonalityType()
Check.png Check.png Star.png Speech.png int GetPopulation()
Check.png Check.png Star.png Speech.png int GetPressurePerTurn(ReligionType religion)
CheckButZero.png CheckButZero.png Star.png Speech.png PlayerID GetPreviousOwner()
Check.png Check.png Star.png Speech.png int GetProduction()
Check.png Check.png Star.png Speech.png BuildingType GetProductionBuilding()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetProductionExperience(UnitType unit)
Check.png Check.png Star.png Speech.png int GetProductionModifier()
Check.png Check.png Star.png Speech.png string GetProductionNameKey()
Check.png Check.png Star.png Speech.png int GetProductionNeeded()
Check.png Check.png Star.png Speech.png ProcessType GetProductionProcess()
Check.png Check.png Star.png Speech.png ProjectType GetProductionProject()
CheckButZero.png CheckButZero.png Star.png Speech.png SpecialistType GetProductionSpecialist()
Check.png Check.png Star.png Speech.png int GetProductionTimes100()
Check.png Check.png Star.png Speech.png int GetProductionTurnsLeft()
Check.png Check.png Star.png Speech.png UnitType GetProductionUnit()
CheckButZero.png CheckButZero.png Star.png Speech.png UnitAIType GetProductionUnitAI()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetProjectProductionModifier(ProjectType project)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetProjectProductionNeeded()
Check.png Check.png Star.png Speech.png int GetProjectProductionTurnsLeft(ProjectType project, int num)
Check.png Check.png Star.png Speech.png int GetProjectPurchaseCost(ProjectType project)
Check.png Check.png Star.png Speech.png int GetPurchaseBuildingTooltip(int id)
Check.png Check.png Star.png Speech.png int GetPurchaseUnitTooltip(UnitType id)
CheckButZero.png CheckButZero.png Star.png Speech.png unknown GetRallyPlot()
Check.png Check.png Star.png Speech.png int GetRawProductionDifference(bool arg0, bool arg1)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png GetRawProductionDifferenceTimes100
Check.png Check.png Star.png Speech.png int GetRazingTurns()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetRealPopulation()
Check.png Check.png Star.png Speech.png int GetReligionBuildingClassHappiness(BuildingClassType buildingClass)
Check.png Check.png Star.png Speech.png int GetReligionBuildingClassYieldChange(BuildingClassType buildingClass, YieldType arg1)
Check.png Check.png Star.png Speech.png int GetReligionCityRangeStrikeModifier()
Check.png Check.png Star.png Speech.png ReligionType GetReligiousMajority()
Check.png Check.png Star.png Speech.png int GetResistanceTurns()
Check.png Check.png Star.png Speech.png ResourceType GetResourceDemanded(bool arg0 = nil)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetResourceYieldRateModifier(YieldType index, ResourceType resource)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetRiverPlotYield(YieldType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSeaPlotYield(YieldType index)
Check.png Check.png Star.png Speech.png int GetSellBuildingRefund(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSpaceProductionModifier()
Check.png Check.png Star.png Speech.png int GetSpecialistCount(SpecialistType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSpecialistFreeExperience()
Check.png Check.png Star.png Speech.png int GetSpecialistGreatPersonProgress(SpecialistType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSpecialistGreatPersonProgressTimes100(SpecialistType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSpecialistProductionModifier(SpecialistType specialist)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetSpecialistProductionTurnsLeft(SpecialistType specialist, int num)
Check.png Check.png Star.png Speech.png int GetSpecialistUpgradeThreshold()
Check.png Check.png Star.png Speech.png int GetSpecialistYield(SpecialistType specialist, YieldType yield)
Check.png Check.png Star.png Speech.png int GetStrengthValue()
Check.png Check.png Star.png Speech.png TeamID GetTeam()
Check.png Check.png Star.png Speech.png int GetTotalBaseBuildingMaintenance(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetTotalGreatPeopleRateModifier()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetUnitCombatFreeExperience(UnitCombatType index)
Check.png Check.png Star.png Speech.png int GetUnitFaithPurchaseCost(UnitType unit, bool arg1)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetUnitProduction(int index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetUnitProductionModifier(UnitType unit)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetUnitProductionNeeded()
Check.png Check.png Star.png Speech.png int GetUnitProductionTurnsLeft(UnitType unit, int num)
Check.png Check.png Star.png Speech.png int GetUnitPurchaseCost(UnitType unit)
Check.png Check.png Star.png Speech.png int GetWeLoveTheKingDayCounter()
CheckButZero.png CheckButZero.png Star.png Speech.png int GetWonderProductionModifier()
Check.png Check.png Star.png Speech.png ResourceType GetX()
Check.png Check.png Star.png Speech.png ResourceType GetY()
Check.png Check.png Star.png Speech.png string GetYieldModifierTooltip(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetYieldPerPopTimes100(YieldType yieldType)
Check.png Check.png Star.png Speech.png int GetYieldRate(YieldType index)
CheckButZero.png CheckButZero.png Star.png Speech.png int GetYieldRateModifier(YieldType index)
Check.png Check.png Star.png Speech.png int GetYieldRateTimes100(YieldType index)
Check.png Check.png Star.png Speech.png int GrowthThreshold()

H

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png bool HasPerformedRangedStrikeThisTurn()
CheckButZero.png CheckButZero.png Star.png Speech.png Hurry(HurryType hurry)
CheckButZero.png CheckButZero.png Star.png Speech.png int HurryCost(HurryType hurry, bool extra)
CheckButZero.png CheckButZero.png Star.png Speech.png int HurryGold(HurryType hurry)
CheckButZero.png CheckButZero.png Star.png Speech.png int HurryPopulation(HurryType hurry)
CheckButZero.png CheckButZero.png Star.png Speech.png int HurryProduction(HurryType hurry)

I

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsAirliftTargeted()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsBarbarian()
Check.png Check.png Star.png Speech.png bool IsBlockaded()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsBuildingLocalResourceValid(BuildingType building, bool checkForImprovement)
Check.png Check.png Star.png Speech.png bool IsBuildingSellable(BuildingType index)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsBuildingsMaxed()
Check.png Check.png Star.png Speech.png bool IsCanAddSpecialistToBuilding(BuildingType building)
Check.png Check.png Star.png Speech.png bool IsCanPurchase(UnitType unitType, int buildingType, int projectType, int projectID, int projectID = nil, YieldType yield = nil)
Check.png Check.png Star.png Speech.png int IsCapital()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsCoastal(int minWaterSize)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsDrafted()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsEverOwned(PlayerID index)
Check.png Check.png Star.png Speech.png int IsFoodProduction()
Check.png Check.png Star.png Speech.png bool IsForcedAvoidGrowth()
Check.png Check.png Star.png Speech.png int IsForcedWorkingPlot(Plot plot)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsFreePromotion(PromotionType index)
Check.png Check.png Star.png Speech.png bool IsHasBuilding(BuildingType building)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsHasResourceLocal(ResourceType resource)
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png IsHolyCityAnyReligion
Check.png Check.png Star.png Speech.png bool IsHolyCityForReligion(ReligionType religion)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsHuman()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsNationalWondersMaxed()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsNeverLost()
Check.png Check.png Star.png Speech.png bool IsNoAutoAssignSpecialists()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsNone()
Check.png Check.png Star.png Speech.png bool IsNoOccupiedUnhappiness()
Check.png Check.png Star.png Speech.png int IsOccupied()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png IsOriginalCapital
Check.png Check.png Star.png Speech.png int IsPlotBlockaded(Plot plot)
Check.png Check.png Star.png Speech.png int IsProduction()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionAutomated()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionBuilding()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionLimited()
Check.png Check.png Star.png Speech.png int IsProductionProcess()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionProject()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionSpecialist()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsProductionUnit()
Check.png Check.png Star.png Speech.png int IsPuppet()
Check.png Check.png Star.png Speech.png int IsRazing()
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png IsReligionInCity
Check.png Check.png Star.png Speech.png bool IsResistance()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsRevealed(TeamID index, bool debug)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsTeamWondersMaxed()
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsUnitFoodProduction(UnitType unit)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsVisible(TeamID team, bool debug)
Check.png Check.png Star.png Speech.png int IsWorkingPlot(Plot plot)
CheckButZero.png CheckButZero.png Star.png Speech.png bool IsWorldWondersMaxed()

K

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png Question-blue.png Kill

M

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png int MaxHurryPopulation()

P

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png Plot Plot()
CheckButZero.png CheckButZero.png Star.png Speech.png PopOrder(int num, bool finish, bool choose)
CheckButZero.png CheckButZero.png Star.png Speech.png int ProductionLeft()
CheckButZero.png CheckButZero.png Star.png Speech.png PushOrder(OrderType order, int data1, int data2, bool save, bool pop, bool append, bool force)

R

Base game Gods & Kings ___________________________
Check.png Check.png Star.png Speech.png int RangeCombatDamage(Unit theirUnit, unknown arg1)
Check.png Check.png Star.png Speech.png int RangeCombatUnitDefense(Unit theirUnit)

S

Base game Gods & Kings ___________________________
CheckButZero.png CheckButZero.png Star.png Speech.png SetAirliftTargeted(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetBuildingProduction(BuildingType index, int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetBuildingProductionTime(BuildingType index, int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetBuildingYieldChange(BuildingClassType buildingClass, YieldType yield, int change)
CheckButZero.png CheckButZero.png Star.png Speech.png SetCitySizeBoost(int boost)
CheckButZero.png CheckButZero.png Star.png Speech.png SetDamage(int value)
CheckButZero.png CheckButZero.png Star.png Speech.png SetDrafted(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetFeatureProduction(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png int SetFocusType()
CheckButZero.png CheckButZero.png Star.png Speech.png SetFood(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetGreatPeopleUnitProgress(UnitType index, int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetHighestPopulation(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetJONSCultureLevel(int value)
CheckButZero.png CheckButZero.png Star.png Speech.png SetJONSCultureStored(int value)
CheckButZero.png CheckButZero.png Star.png Speech.png SetName(string newValue, bool found)
CheckButZero.png CheckButZero.png Star.png Speech.png SetNeverLost(int newValue)
Check.png Check.png Star.png Speech.png SetNumRealBuilding(BuildingType index, int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetOccupied(bool value)
CheckButZero.png CheckButZero.png Star.png Speech.png SetOverflowProduction(int newValue)
Check.png Check.png Star.png Speech.png SetPopulation(int newValue, bool flag)
CheckButZero.png CheckButZero.png Star.png Speech.png SetProduction(int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetProductionAutomated(bool newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetPuppet(bool value)
CheckButZero.png CheckButZero.png Star.png Speech.png bool SetResourceDemanded(ResourceType resource)
CheckButZero.png CheckButZero.png Star.png Speech.png SetRevealed(TeamID index, bool newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetUnitProduction(int index, int newValue)
CheckButZero.png CheckButZero.png Star.png Speech.png SetWeLoveTheKingDayCounter(int value)

U

UpdateStrengthValue

W

Base game Gods & Kings ___________________________
Cross.png CheckButZero.png Star.png Speech.png Question-blue.png WaterArea

Used by

string GetCultureTooltip(City city)
string GetFaithTooltip(City city)
string GetFoodTooltip(City city)
string GetGoldTooltip(City city)
string GetProductionTooltip(City city)
string GetReligionTooltip(City city)
string GetScienceTooltip(City city)
string GetYieldTooltip(City city, YieldType yieldType, int base, int total, string iconString, string modifiersString)
string GetYieldTooltipHelper(City city, YieldType yieldType, string icon)
Game.CityPurchaseBuilding(City city, UnitType unitType, int buildingType, ProjectType projectTypes)
Game.CityPurchaseProject(City city, UnitType unitType, int buildingType, ProjectType projectTypes)
Game.CityPurchaseUnit(City city, UnitType unitType, int buildingType, ProjectType projectTypes)
Game.CityPushOrder(City city, OrderType order, UnitType data, bool alt, bool shift, bool ctrl)
Game.FoundReligion(PlayerID vaticanPlayer, ReligionType religion, unknown arg2, BeliefType belief2, BeliefType belief3, BeliefType belief3, int arg6, City vaticanCity)
City Game.GetHolyCityForReligion(ReligionType religion, PlayerID player)
Game.SetAdvisorRecommenderCity(City city)
Game.SetHolyCity(ReligionType arg0, City newHolyCity)
Player:AcquireCity(City city, bool conquest, bool trade)
bool Player:CanRaze(City city, bool arg1 = nil)
iterator(City) Player:Cities()
Player:Disband(City city)
int Player:GetAdvancedStartBuildingCost(BuildingType building, bool add, City city)
int Player:GetAdvancedStartPopCost(bool add, City city)
City Player:GetCapitalCity()
City Player:GetCityByID(CityID city)
int Player:GetRouteGoldTimes100(City city)
int Player:GetUnhappinessForecast(City newCity, City newCity)
int Player:GetUnhappinessFromCityForUI(City city)
City Player:InitCity(int x, int y, bool bumpUnits = true)
int Player:IsCapitalConnectedToCity(City city)
Player:Raze(City city)
int Plot:GetFeatureProduction(BuildActionType build, TeamID team, City city)
City Plot:GetWorkingCity()
City UI.GetHeadSelectedCity()
UI.SelectCity(City city)
int Unit:GetRangeCombatDamage(Unit defender, City city, bool includeRand)



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.