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

				`___________________________`
					`AcquireCity(City city, bool conquest, bool trade)`
					`AddCityName(string name)`
					`AddFreeUnit(UnitType arg0, UnitAIType UNITAI_DEFENSE)`
					`AddMinorCivQuestIfAble`
					`AddNotification(NotificationType notificationType, string description, string title, int x = -1, int y = -1, PlayerID extra1 = -1, int extra2 = -1)`
					`AddTemporaryDominanceZone(int arg0, int arg1)`
				`int`	`AI_foundValue(int x, int y, int alwaysOne, bool alwaysFalse)`
					`AI_updateFoundValues(bool startingLoc)`

C

				`___________________________`
				`int`	`CalculateGoldRate()`
				`int`	`CalculateGoldRateTimes100()`
				`int`	`CalculateGrossGold()`
				`int`	`CalculateGrossGoldTimes100()`
				`int`	`CalculateInflatedCosts()`
				`int`	`CalculateResearchModifier(TechType tech)`
				`int`	`CalculateTotalYield(YieldType yield)`
				`int`	`CalculateUnitCost()`
				`int`	`CalculateUnitSupply()`
				`int`	`CanAdoptPolicy(PolicyType policy)`
				`bool`	`CanBuild(Plot plot, BuildActionType build, bool testEra = false, bool testVisible = false, bool testGold = false)`
				`bool`	`CanConstruct(BuildingType building, bool continue, bool testVisible, bool ignoreCost)`
				`bool`	`CanContact(PlayerID player)`
				`bool`	`CanCreate(ProjectType project, bool continue, bool testVisible)`
				`bool`	`CanCreatePantheon(bool arg0)`
				`bool`	`CanEverResearch(TechType tech)`
				`bool`	`CanFound(int x, int y)`
				`bool`	`CanMaintain(ProcessType process, bool continue)`
				`bool`	`CanMajorBullyGold(PlayerID major)`
				`bool`	`CanMajorBullyUnit(PlayerID activePlayer)`
				`int`	`CanMajorBuyout(PlayerID activePlayer)`
				`bool`	`CanMajorGiftTileImprovement(PlayerID activePlayer)`
				`bool`	`CanMajorGiftTileImprovementAtPlot(PlayerID fromPlayer, int plotX, int plotY)`
					`CanMajorProtect`
				`bool`	`CanMajorStartProtection(PlayerID activePlayer)`
				`bool`	`CanMajorWithdrawProtection(PlayerID activePlayer)`
				`bool`	`CanPrepare(SpecialistType specialist, bool continue)`
				`bool`	`CanRaze(City city, bool arg1 = nil)`
				`bool`	`CanReceiveGoody(Plot plot, GoodyType goody, Unit unit)`
				`int`	`CanResearch(TechType tech, bool trade = false)`
				`bool`	`CanResearchForFree(TechType tech)`
				`bool`	`CanSpyStageCoup(unknown arg0)`
				`bool`	`CanStopTradingWithTeam(TeamID team)`
				`bool`	`CanTradeWith(PlayerID whoTo)`
				`int`	`CanTrain(UnitType unit, bool continue, bool testVisible, bool arg3, bool arg4)`
				`int`	`CanUnlockPolicyBranch(int policyBranch)`
					`ChangeAdvancedStartPoints(int change)`
					`ChangeAlwaysSeeBarbCampsCount`
				`int`	`ChangeAnarchyNumTurns()`
					`ChangeBarbarianCombatBonus`
				`int`	`ChangeBaseBuildingGoldMaintenance()`
					`ChangeCombatExperience(int change)`
					`ChangeConscriptCount(int change)`
					`ChangeExtraHappinessPerCity(int change)`
					`ChangeFaith`
					`ChangeFreePromotionCount`
					`ChangeGarrisonedCityRangeStrikeModifier`
					`ChangeGold(int change)`
					`ChangeGoldenAgeProgressMeter`
					`ChangeGoldenAgeTurns(int change)`
					`ChangeGoldPerUnitTimes100`
					`ChangeHappinessPerGarrisonedUnit(int change)`
					`ChangeHappinessPerTradeRoute(int change)`
					`ChangeJONSCulture(int change)`
					`ChangeJONSCulturePerTurnForFree(int change)`
					`ChangeJONSCulturePerTurnFromMinorCivs(int change)`
					`ChangeMinorCivFriendshipWithMajor(PlayerID player)`
					`ChangeNavalCombatExperience`
					`ChangeNewCityExtraPopulation`
					`ChangeNumFaithGreatPeople`
					`ChangeNumFreeGreatPeople`
					`ChangeNumFreePolicies(int arg0)`
					`ChangeNumGoldenAges`
					`ChangeNumMayaBoosts`
					`ChangeNumPlotsBought(int change)`
					`ChangeNumResourceTotal(ResourceType resource, int change)`
					`ChangeNumUnitGoldenAges(int change)`
					`ChangeNumWorldWonders(int numWondersToCredit)`
					`ChangeScoreFromFutureTech(int vPReceived)`
					`ChangeScoreFromTechs(int score)`
					`ChangeUnhappinessFromUnits(int change)`
					`ChooseTech(int arg0, string arg1, int arg2)`
				`iterator(City)`	`Cities()`
					`ClearResearchQueue`
					`Contact(PlayerID player)`
				`int`	`CountCityFeatures(FeatureType feature)`
				`int`	`CountNumBuildings(BuildingType building)`
					`CreateGreatGeneral(Unit eGreatPersonUnit, bool incrementThreshold, bool incrementExperience, int x, int y)`

D

				`___________________________`
					`Disband(City city)`
					`DisbandUnit(bool announce)`
					`DoAdoptPolicy(PolicyType policy)`
					`DoBeginDiploWithHuman()`
					`DoForceDenounce(PlayerID player)`
					`DoForceDoF(PlayerID player)`
					`DoGoody(Plot plot, Unit unit)`
					`DoMinorLiberationByMajor(PlayerID player)`
					`DoTradeScreenClosed(bool aIMakingOffer)`
					`DoTradeScreenOpened()`
					`DoUpdateProximityToPlayer(PlayerID player)`

F

				`___________________________`
					`FindNewCapital`
				`int`	`FindPathLength(TechType tech, bool cost)`
					`ForcePeace(PlayerID player)`
					`Found(int x, int y)`

G

				`___________________________`
				`MinorCivQuestType`	`GetActiveQuestForPlayer(PlayerID player)`
				`int`	`GetAdvancedStartBuildingCost(BuildingType building, bool add, City city)`
				`int`	`GetAdvancedStartCityCost(bool add, Plot plot)`
				`int`	`GetAdvancedStartImprovementCost(ImprovementType improvement, bool add, Plot plot)`
				`int`	`GetAdvancedStartPoints()`
				`int`	`GetAdvancedStartPopCost(bool add, City city)`
				`int`	`GetAdvancedStartRouteCost(RouteType route, bool add, Plot plot)`
				`int`	`GetAdvancedStartTechCost(TechType tech, bool add)`
				`int`	`GetAdvancedStartUnitCost(UnitType unit, bool add, Plot plot)`
				`int`	`GetAdvancedStartVisibilityCost(bool add, Plot plot)`
				`int`	`GetAgricultureHistory(int turn)`
				`PlayerID`	`GetAlly()`
				`int`	`GetAnarchyNumTurns()`
				`bool`	`GetAnyUnitHasOrderToGoody(unknown void)`
				`MajorCivApproachType`	`GetApproachTowardsUsGuess(PlayerID player)`
				`ArtStyleType`	`GetArtStyleType()`
				`int`	`GetAttackBonusTurns()`
				`unknown`	`GetAvailableSpyRelocationCities(unknown agentID)`
				`int`	`GetAveragePopulation()`
				`int`	`GetBarbarianCombatBonus()`
				`BeliefType`	`GetBeliefInPantheon()`
				`unknown`	`GetBestRoute(Plot plot)`
				`bool`	`GetBranchPicked1()`
				`bool`	`GetBranchPicked2()`
				`bool`	`GetBranchPicked3()`
				`int`	`GetBuildingClassCount(BuildingClassType buildingClass)`
				`int`	`GetBuildingClassCountPlusMaking(BuildingClassType buildingClass)`
				`int`	`GetBuildingClassMaking(BuildingClassType buildingClass)`
				`int`	`GetBuildingClassPrereqBuilding(BuildingType building, unknown ePrereqBuildingClass, int extra)`
				`int`	`GetBuildingGoldMaintenance()`
					`GetBuildingProductionModifier`
				`int`	`GetBuildingProductionNeeded(int building)`
				`int`	`GetBuyoutCost(PlayerID activePlayer)`
					`GetBuyPlotCost`
				`City`	`GetCapitalCity()`
					`GetCapitalSettlerProductionModifier`
				`int`	`GetCapitalUnhappinessMod()`
				`int`	`GetCapitalYieldRateModifier(YieldType index)`
				`int`	`GetCitiesLost()`
				`City`	`GetCityByID(CityID city)`
				`int`	`GetCityConnectionGold()`
				`int`	`GetCityConnectionGoldTimes100()`
				`int`	`GetCityCountUnhappinessMod()`
				`int`	`GetCityDefenseModifier()`
				`string`	`GetCityName(int index)`
				`string`	`GetCivilizationAdjective(int form)`
				`string`	`GetCivilizationAdjectiveKey()`
				`string`	`GetCivilizationDescription()`
				`string`	`GetCivilizationDescriptionKey()`
				`string`	`GetCivilizationShortDescription()`
				`string`	`GetCivilizationShortDescriptionKey()`
				`CivilizationType`	`GetCivilizationType()`
				`Plot`	`GetClosestGoodyPlot(unknown void)`
				`int`	`GetCombatBonusVsHigherTech()`
				`int`	`GetCombatBonusVsLargerCiv()`
				`int`	`GetCombatExperience()`
				`int`	`GetCommonFoeValue(PlayerID activePlayer)`
				`int`	`GetConscriptCount()`
				`int`	`GetConversionTimer()`
				`CoopWarState`	`GetCoopWarAcceptedState(PlayerID withPlayer, PlayerID againstPlayer)`
				`unknown`	`GetCoupChanceOfSuccess(int city)`
				`int`	`GetCultureBombTimer()`
				`int`	`GetCultureCityModifier()`
					`GetCulturePerTurnFromMinor`
				`int`	`GetCulturePerTurnFromMinorCivs()`
				`int`	`GetCulturePerTurnFromReligion()`
				`int`	`GetCultureWonderMultiplier()`
				`int`	`GetCurrentCapitalFoodBonus(PlayerID major)`
				`int`	`GetCurrentCultureBonus(PlayerID activePlayer)`
				`EraType`	`GetCurrentEra()`
				`int`	`GetCurrentOtherCityFoodBonus(PlayerID major)`
				`TechType`	`GetCurrentResearch()`
				`int`	`GetCurrentScienceFriendshipBonusTimes100(PlayerID major)`
				`int`	`GetCurrentSpawnEstimate(PlayerID major)`
				`SpecialistType`	`GetDealMyValue(Deal Deal)`
					`GetDealTheyreValue`
					`GetDealValue`
				`int`	`GetDomesticGreatGeneralRateModifier()`
				`PolicyBranchType`	`GetDominantPolicyBranchForTitle()`
				`int`	`GetEconomyHistory(int turn)`
					`GetEmbarkedGraphicOverride`
				`EndTurnBlockingType`	`GetEndTurnBlockingNotificationIndex()`
				`EndTurnBlockingType`	`GetEndTurnBlockingType()`
				`table(int => CityEspionageInfo)`	`GetEspionageCityStatus()`
				`table(int => SpyInfo)`	`GetEspionageSpies()`
				`bool`	`GetEverPoppedGoody(unknown void)`
				`bool`	`GetEverTrainedBuilder(unknown void)`
				`int`	`GetExcessHappiness()`
				`bool`	`GetExpInBorderModifier()`
				`int`	`GetExtraBuildingHappinessFromPolicies(PlayerID building)`
				`int`	`GetExtraHappinessPerCity()`
				`int`	`GetExtraHappinessPerLuxury()`
				`int`	`GetExtraUnitCost()`
				`int`	`GetExtraYieldThreshold(YieldType index)`
				`int`	`GetFaith()`
				`int`	`GetFaithPerTurnFromCities()`
				`int`	`GetFaithPerTurnFromMinorCivs()`
				`int`	`GetFaithPerTurnFromReligion()`
				`int`	`GetFaithPurchaseIndex()`
				`FaithPurchaseType`	`GetFaithPurchaseType()`
				`int`	`GetFeatureProductionModifier()`
				`Unit`	`GetFirstReadyUnit()`
				`unknown`	`GetFirstReadyUnitPlot()`
				`int`	`GetFoundedReligionEnemyCityCombatMod(Plot toPlot)`
				`int`	`GetFoundedReligionFriendlyCityCombatMod(Plot toPlot)`
				`int`	`GetFreeExperience()`
					`GetFreePromotionCount`
				`int`	`GetFriendshipChangePerTurnTimes100(PlayerID major)`
				`int`	`GetFriendshipFromGoldGift(PlayerID activePlayer, int gold)`
				`int`	`GetFriendshipNeededForNextLevel()`
				`int`	`GetGarrisonedCityRangeStrikeModifier()`
				`int`	`GetGiftTileImprovementCost(PlayerID activePlayer)`
				`int`	`GetGold()`
				`int`	`GetGoldenAgeLength()`
				`int`	`GetGoldenAgeModifier()`
				`unknown`	`GetGoldenAgeProgressMeter()`
				`int`	`GetGoldenAgeProgressThreshold()`
				`int`	`GetGoldenAgeTurns()`
				`int`	`GetGoldFromCitiesTimes100()`
				`int`	`GetGoldPerMilitaryUnit()`
				`int`	`GetGoldPerTurnFromDiplomacy()`
				`int`	`GetGoldPerTurnFromReligion()`
				`int`	`GetGoldPerUnit()`
					`GetGreatAdmiralsThresholdModifier`
				`int`	`GetGreatGeneralRateModifier()`
				`int`	`GetGreatGeneralsCreated()`
				`int`	`GetGreatGeneralsThresholdModifier()`
				`int`	`GetGreatPeopleCreated()`
				`int`	`GetGreatPeopleRateModifier()`
				`int`	`GetGreatPeopleThresholdModifier()`
				`HandicapType`	`GetHandicapType()`
				`int`	`GetHappiness()`
				`int`	`GetHappinessFromBuildings()`
				`int`	`GetHappinessFromCities()`
				`int`	`GetHappinessFromGarrisonedUnits()`
				`int`	`GetHappinessFromLuxury(ResourceType resource)`
				`int`	`GetHappinessFromMinor(PlayerID minor)`
				`int`	`GetHappinessFromMinorCivs()`
				`int`	`GetHappinessFromNaturalWonders()`
				`int`	`GetHappinessFromPolicies()`
				`int`	`GetHappinessFromReligion()`
				`int`	`GetHappinessFromResources()`
				`int`	`GetHappinessFromResourceVariety()`
				`int`	`GetHappinessFromTradeRoutes()`
				`int`	`GetHappinessPerGarrisonedUnit()`
				`int`	`GetHappinessPerTradeRoute()`
				`int`	`GetHappyPerMilitaryUnit()`
				`int`	`GetHighestUnitLevel()`
				`int`	`GetHurryCount(HurryType hurry)`
				`int`	`GetHurryGoldCost(HurryType hurry)`
				`int`	`GetHurryModifier(HurryType hurry)`
				`PlayerID`	`GetID()`
				`int`	`GetImprovementCount(ImprovementType improvement)`
				`int`	`GetImprovementGoldMaintenance()`
				`int`	`GetImprovementUpgradeRate()`
				`int`	`GetImprovementUpgradeRateModifier()`
				`int`	`GetIndustryHistory(int turn)`
				`table(int => IntrigueInfo)`	`GetIntrigueMessages()`
				`int`	`GetJONSCulture()`
					`GetJONSCultureEverGenerated`
				`int`	`GetJONSCulturePerTurnForFree()`
				`int`	`GetJONSCulturePerTurnFromCities()`
				`int`	`GetJONSCulturePerTurnFromExcessHappiness()`
				`int`	`GetJONSCulturePerTurnFromMinorCivs()`
				`DisputeLevelType`	`GetLandDisputeLevel(PlayerID activePlayer)`
				`int`	`GetLandScore()`
					`GetLateGamePolicyTree`
				`LeaderType`	`GetLeaderType()`
				`int`	`GetLengthResearchQueue()`
				`int`	`GetLevelExperienceModifier()`
					`GetLifetimeCombatExperience`
				`int`	`GetLifetimeGrossGold()`
					`GetMajorCivApproach`
				`int`	`GetMaxConscript()`
				`int`	`GetMaxGlobalBuildingProductionModifier()`
				`int`	`GetMaxPlayerBuildingProductionModifier()`
				`int`	`GetMaxTeamBuildingProductionModifier()`
				`string`	`GetMayaCalendarLongString()`
				`string`	`GetMayaCalendarString()`
				`int`	`GetMilitaryMight()`
				`int`	`GetMilitaryProductionModifier()`
				`unknown`	`GetMinimumFaithNextGreatProphet()`
				`int`	`GetMinorCivBullyGoldAmount(PlayerID activePlayer)`
				`int`	`GetMinorCivContestValueForLeader(MinorCivQuestType arg0)`
				`int`	`GetMinorCivContestValueForPlayer(PlayerID major, MinorCivQuestType arg1)`
				`int`	`GetMinorCivCultureFriendshipBonus()`
				`int`	`GetMinorCivCurrentCultureBonus(PlayerID major)`
					`GetMinorCivCurrentCultureFlatBonus`
					`GetMinorCivCurrentCulturePerBuildingBonus`
				`int`	`GetMinorCivCurrentFaithBonus(PlayerID major)`
				`int`	`GetMinorCivCurrentHappinessBonus(PlayerID major)`
					`GetMinorCivCurrentHappinessFlatBonus`
					`GetMinorCivCurrentHappinessPerLuxuryBonus`
				`DisputeLevelType`	`GetMinorCivDisputeLevel(PlayerID activePlayer)`
				`unknown`	`GetMinorCivFavoriteMajor()`
				`int`	`GetMinorCivFriendshipAnchorWithMajor(PlayerID major)`
				`int`	`GetMinorCivFriendshipLevelWithMajor(PlayerID arg0)`
				`int`	`GetMinorCivFriendshipWithMajor(PlayerID major)`
				`int`	`GetMinorCivHappinessFriendshipBonus()`
				`int`	`GetMinorCivNumActiveQuestsForPlayer(PlayerID player)`
				`int`	`GetMinorCivScienceFriendshipBonus()`
				`MinorCivTraitType`	`GetMinorCivTrait()`
				`int`	`GetMinorCivType()`
				`UnitType`	`GetMinorCivUniqueUnit()`
				`int`	`GetMinorWarQuestWithMajorRemainingCount()`
				`string`	`GetName(string form)`
				`string`	`GetNameKey()`
				`int`	`GetNaturalWonderYieldModifier()`
				`int`	`GetNavalCombatExperience()`
					`GetNegativeReligiousConversionPoints`
					`GetNewCityExtraPopulation`
				`string`	`GetNewCityName()`
				`unknown`	`GetNextCity()`
				`int`	`GetNextPolicyCost()`
				`string`	`GetNickName()`
				`int`	`GetNotificationDismissed(int arg0)`
				`EndTurnBlockingType`	`GetNotificationIndex(int i)`
				`string`	`GetNotificationStr(int i)`
				`string`	`GetNotificationSummaryStr(int i)`
				`int`	`GetNotificationTurn(int arg0)`
				`int`	`GetNumCities()`
				`int`	`GetNumCityNames()`
				`int`	`GetNumCiviliansReturnedToMe(PlayerID activePlayer)`
				`int`	`GetNumFaithGreatPeople()`
				`int`	`GetNumFreeGreatPeople()`
				`int`	`GetNumFreePolicies()`
				`ResourceType`	`GetNumFreeTechs()`
				`int`	`GetNumFriendsDenouncedBy()`
				`int`	`GetNumGoldenAges()`
				`int`	`GetNumMaintenanceFreeUnits()`
				`int`	`GetNumMayaBoosts()`
				`int`	`GetNumMilitaryUnits()`
				`int`	`GetNumMinorCivsMet()`
				`int`	`GetNumNotifications()`
				`int`	`GetNumNukeUnits()`
				`int`	`GetNumOutsideUnits()`
				`int`	`GetNumPlots()`
				`int`	`GetNumPlotsBought()`
				`int`	`GetNumPolicies()`
				`int`	`GetNumPolicyBranchesAllowed()`
				`int`	`GetNumPolicyBranchesFinished()`
				`int`	`GetNumPolicyBranchesUnlocked()`
				`int`	`GetNumRequestsRefused(PlayerID activePlayer)`
				`int`	`GetNumResourceAvailable(ResourceType resource, bool includeImport)`
				`int`	`GetNumResourceTotal(ResourceType resource, bool includeImport)`
				`int`	`GetNumResourceUsed(ResourceType resource)`
				`int`	`GetNumSpies()`
				`int`	`GetNumTechsToSteal(int stealingTechTargetPlayerID)`
				`int`	`GetNumTimesCultureBombed(PlayerID activePlayer)`
					`GetNumTimesIntrigueSharedBy`
					`GetNumTimesRobbedBy`
				`int`	`GetNumTradeResourceImports(PlayerID player)`
				`int`	`GetNumUnassignedSpies()`
				`int`	`GetNumUnitGoldenAges()`
				`int`	`GetNumUnits()`
				`int`	`GetNumUnitsOutOfSupply()`
				`int`	`GetNumUnitsSupplied()`
				`int`	`GetNumUnitsSuppliedByCities()`
				`int`	`GetNumUnitsSuppliedByHandicap()`
				`int`	`GetNumUnitsSuppliedByPopulation()`
				`int`	`GetNumWarsFought(PlayerID otherPlayer)`
					`GetNumWondersBeatenTo`
				`int`	`GetNumWorldWonders()`
				`int`	`GetOccupiedPopulationUnhappinessMod()`
				`table(unknown => unknown)`	`GetOpinionTable(PlayerID activePlayer)`
				`int`	`GetOtherPlayerNumProtectedMinorsAttacked(PlayerID activePlayer)`
				`int`	`GetOtherPlayerNumProtectedMinorsKilled(PlayerID activePlayer)`
				`int`	`GetOverflowResearch()`
				`MinorCivPersonalityType`	`GetPersonality()`
				`unknown`	`GetPersonalityType()`
				`int`	`GetPlayerBuildingClassHappiness(BuildingClassType buildingClass)`
				`int`	`GetPlayerBuildingClassYieldChange(BuildingClassType buildingClass, YieldType arg1)`
				`ColorType`	`GetPlayerColor()`
				`Vector4, Vector4`	`GetPlayerColors()`
				`unknown`	`GetPlayerVisiblePlot(Player player)`
				`int`	`GetPlotDanger(Plot plot)`
				`bool`	`GetPlotHasOrder(Plot Plot)`
				`bool`	`GetPolicyBranchChosen(PolicyType policyBranch)`
				`int`	`GetPolicyBuildingClassYieldChange(BuildingClassType buildingClass, YieldType arg1)`
				`int`	`GetPolicyBuildingClassYieldModifier(BuildingClassType buildingClass, YieldType arg1)`
				`int`	`GetPolicyCatchSpiesModifier()`
				`int`	`GetPolicyEspionageCatchSpiesModifier(int i)`
				`int`	`GetPolicyEspionageModifier(int i)`
				`int`	`GetPopScore()`
				`int`	`GetPower()`
				`int`	`GetPowerHistory(int turn)`
				`unknown`	`GetPrevCity()`
					`GetProductionModifier`
					`GetProjectProductionModifier`
				`int`	`GetProjectProductionNeeded(ProjectType project)`
				`int`	`GetProximityToPlayer(PlayerID index)`
				`int`	`GetQuestData1(PlayerID major, MinorCivQuestType type = nil)`
				`int`	`GetQuestData2(PlayerID major, MinorCivQuestType type = nil)`
				`int`	`GetQuestTurnsRemaining(PlayerID major, MinorCivQuestType type, PlayerID arg2)`
				`int`	`GetQueuePosition(TechType tech)`
				`int`	`GetRealPopulation()`
				`int`	`GetRecentAssistValue(PlayerID activePlayer)`
				`SpecialistType, int`	`GetRecentIntrigueInfo(PlayerID aIPlayer)`
				`int`	`GetRecentTradeValue(PlayerID activePlayer)`
				`table(unknown => unknown)`	`GetRecommendedFoundCityPlots()`
				`table(unknown => unknown)`	`GetRecommendedWorkerPlots()`
				`ReligionType`	`GetReligionCreatedByPlayer()`
				`table(unknown => unknown)`	`GetReplayData()`
				`int`	`GetResearchCost(TechType currentTech)`
				`int`	`GetResearchProgress(TechType currentTech)`
				`int`	`GetResearchTurnsLeft(TechType tech, bool overflow)`
				`int`	`GetResourceExport(ResourceType resource)`
				`int`	`GetResourceFromMinors(ResourceType resource)`
				`int`	`GetResourceImport(ResourceType resource)`
				`int`	`GetRouteGoldTimes100(City city)`
				`int`	`GetScience()`
				`int`	`GetScienceFromBudgetDeficitTimes100()`
				`int`	`GetScienceFromCitiesTimes100()`
				`int`	`GetScienceFromHappinessTimes100()`
				`int`	`GetScienceFromOtherPlayersTimes100()`
				`int`	`GetScienceFromResearchAgreementsTimes100()`
				`int`	`GetScienceTimes100()`
				`int`	`GetScore(bool arg0 = nil, bool winner = nil)`
				`int`	`GetScoreFromCities()`
				`int`	`GetScoreFromFutureTech()`
				`int`	`GetScoreFromLand()`
				`int`	`GetScoreFromPopulation()`
				`int`	`GetScoreFromTechs()`
				`int`	`GetScoreFromWonders()`
				`int`	`GetScoreHistory(int turn)`
				`string`	`GetScriptData()`
				`int`	`GetSeaPlotYield(YieldType index)`
				`int`	`GetSettlerProductionModifier()`
				`int`	`GetSpaceProductionModifier()`
				`int`	`GetSpecialistExtraYield(SpecialistType index1, YieldType index2)`
					`GetSpecialistProductionModifier`
				`Plot`	`GetStartingPlot()`
				`string`	`GetStateReligionKey()`
				`string`	`GetStateReligionName()`
				`int`	`GetStrikeTurns()`
				`PlayerID`	`GetTeam()`
				`int`	`GetTechScore()`
				`unknown`	`GetTotalFaithPerTurn()`
				`int`	`GetTotalJONSCulturePerTurn()`
				`int`	`GetTotalLand()`
				`int`	`GetTotalLandScored()`
				`int`	`GetTotalPopulation()`
				`int`	`GetTotalTimePlayed()`
				`int`	`GetTradeRouteGoldModifier()`
				`int`	`GetTraitCityStateCombatModifier()`
				`int`	`GetTraitCityUnhappinessMod()`
				`int`	`GetTraitGoldenAgeCombatModifier()`
				`int`	`GetTraitGreatGeneralExtraBonus()`
				`int`	`GetTraitGreatScientistRateModifier()`
				`int`	`GetTraitPopUnhappinessMod()`
				`int`	`GetTurnLastPledgeBrokenByMajor(PlayerID activePlayer)`
				`int`	`GetTurnLastPledgedProtectionByMajor(PlayerID activePlayer)`
					`GetTurnsSincePlayerBulliedProtectedMinor`
					`GetTurnsSinceThreatenedAnnouncement`
				`int`	`GetTurnsSinceThreatenedByBarbarians()`
				`int`	`GetUnhappiness()`
				`int`	`GetUnhappinessForecast(City newCity, City newCity)`
				`int`	`GetUnhappinessFromCapturedCityCount()`
				`int`	`GetUnhappinessFromCityCount()`
				`int`	`GetUnhappinessFromCityForUI(City city)`
				`int`	`GetUnhappinessFromCityPopulation()`
				`int`	`GetUnhappinessFromCitySpecialists()`
				`int`	`GetUnhappinessFromOccupiedCities()`
				`int`	`GetUnhappinessFromPuppetCityPopulation()`
				`int`	`GetUnhappinessFromUnits()`
				`int`	`GetUnhappinessMod()`
				`unknown`	`GetUnimprovedAvailableLuxuryResource()`
				`int`	`GetUnitBaktun(UnitType arg0)`
				`Unit`	`GetUnitByID(UnitID unit)`
				`int`	`GetUnitClassCount(UnitClassType index)`
				`int`	`GetUnitClassCountPlusMaking(UnitClassType index)`
				`int`	`GetUnitClassMaking(UnitClassType index)`
				`int`	`GetUnitProductionMaintenanceMod()`
					`GetUnitProductionModifier`
				`int`	`GetUnitProductionNeeded(UnitType index)`
				`int`	`GetVictoryDisputeLevel()`
				`int`	`GetVotes(VoteType vote, VoteSourceType voteSource)`
				`ThreatType`	`GetWarmongerThreat(PlayerID activePlayer)`
				`int`	`GetWeDeclaredWarOnFriendCount()`
				`int`	`GetWeDenouncedFriendCount()`
				`DisputeLevelType`	`GetWonderDisputeLevel(PlayerID activePlayer)`
				`int`	`GetWonderProductionModifier()`
				`int`	`GetWondersScore()`
				`int`	`GetWorkerSpeedModifier()`
				`string`	`GetWorstEnemyName()`
				`int`	`GetYieldRateModifier(YieldType index)`
				`int`	`GreatAdmiralThreshold()`
				`int`	`GreatGeneralThreshold(bool military)`

H

				`___________________________`
				`bool`	`HasBusyMovingUnit()`
				`bool`	`HasBusyUnit()`
				`int`	`HasCreatedPantheon()`
				`int`	`HasCreatedReligion()`
					`HasOthersReligionInMostCities`
				`int`	`HasPolicy(PolicyType policy)`
				`bool`	`HasReadyUnit()`
				`int`	`HasReceivedNetTurnComplete()`
				`int`	`HasRecentIntrigueAbout(PlayerID player)`
				`bool`	`HasReligionInMostCities(ReligionType religion)`
				`bool`	`HasSpyEstablishedSurveillance(unknown arg0)`

I

				`___________________________`
				`City`	`InitCity(int x, int y, bool bumpUnits = true)`
				`Unit`	`InitUnit(UnitType unit, ResourceType x, ResourceType y, UnitAIType unitAI = NO_UNITAI, DirectionType facingDirection = NO_DIRECTION)`
				`int`	`IsAbleToAnnexCityStates()`
				`int`	`IsAlive()`
				`bool`	`IsAllies(PlayerID major)`
				`bool`	`IsAlwaysSeeBarbCamps()`
				`bool`	`IsAnarchy()`
					`IsAngryAboutProtectedMinorAttacked`
					`IsAngryAboutProtectedMinorBullied`
					`IsAngryAboutProtectedMinorKilled`
					`IsAngryAboutSidedWithTheirProtectedMinor`
				`bool`	`IsAnyGoodyPlotAccessible()`
				`bool`	`IsAnyPlotImproved()`
				`bool`	`IsBarbarian()`
				`bool`	`IsBuildBlockedByFeature(BuildActionType build, FeatureType feature)`
				`bool`	`IsBuildingClassMaxedOut(BuildingClassType buildingClass, int extra)`
				`bool`	`IsBuildingFree(BuildingType building)`
				`bool`	`IsCanHurry(HurryType index)`
				`int`	`IsCanPurchaseAnyCity(bool arg0, bool arg1, UnitType arg2, BuildingType arg3, YieldType arg4)`
				`bool`	`IsCapitalCapturedBy(PlayerID activePlayer)`
				`int`	`IsCapitalConnectedToCity(City city)`
				`bool`	`IsCurrentResearchRepeat()`
				`bool`	`IsDemandEverMade(PlayerID activePlayer)`
				`bool`	`IsDenouncedPlayer(PlayerID otherPlayer)`
				`bool`	`IsDenouncingPlayer(PlayerID player)`
				`bool`	`IsDoF(PlayerID otherPlayer)`
				`bool`	`IsDoFMessageTooSoon(PlayerID activePlayer)`
				`bool`	`IsDontSettleMessageTooSoon(PlayerID withPlayer)`
				`bool`	`IsEmpireSuperUnhappy()`
				`bool`	`IsEmpireUnhappy()`
				`int`	`IsEmpireVeryUnhappy()`
				`int`	`IsEverAlive()`
				`bool`	`IsExtendedGame()`
				`bool`	`IsFoundedFirstCity()`
				`bool`	`IsFreeMayaGreatPersonChoice()`
					`IsFreePromotion`
				`int`	`IsFriendDeclaredWarOnUs(PlayerID activePlayer)`
				`int`	`IsFriendDenouncedUs(PlayerID activePlayer)`
				`int`	`IsFriends(PlayerID major = nil)`
				`bool`	`IsFullMember(VoteSourceType voteSource)`
				`bool`	`IsGaveAssistanceTo(PlayerID activePlayer)`
				`int`	`IsGoldenAge()`
				`bool`	`IsHalfSpecialistUnhappiness()`
				`bool`	`IsHasAccessToHurry(HurryType index)`
				`int`	`IsHasLostCapital()`
				`bool`	`IsHasPaidTributeTo(PlayerID activePlayer)`
					`IsHasPlayerBulliedProtectedMinor`
				`int`	`IsHuman()`
				`bool`	`IsLiberatedCapital(PlayerID activePlayer)`
				`bool`	`IsLiberatedCity(PlayerID activePlayer)`
				`bool`	`IsLoyalMember(PlayerID minor)`
				`bool`	`IsMilitaryFoodProduction()`
				`int`	`IsMinorCiv()`
				`bool`	`IsMinorCivActiveQuestForPlayer(PlayerID major, MinorCivQuestType type)`
				`bool`	`IsMinorCivContestLeader(PlayerID major, MinorCivQuestType arg1)`
				`bool`	`IsMinorCivHasUniqueUnit()`
				`bool`	`IsMinorCivRouteEstablishedWithMajor()`
				`bool`	`IsMinorCivUnitSpawningDisabled(PlayerID activePlayer)`
				`bool`	`IsMinorPermanentWar(TeamID activeTeam)`
				`bool`	`IsMinorWarQuestWithMajorActive(PlayerID playerLoop = nil)`
				`bool`	`IsNoResearchAvailable()`
				`bool`	`IsNukedBy(PlayerID activePlayer)`
				`bool`	`IsOption(PlayerOptionType index)`
				`bool`	`IsPeaceBlocked(TeamID activeTeam)`
				`bool`	`IsPlayable()`
					`IsPlayerBrokenAttackCityStatePromise`
				`bool`	`IsPlayerBrokenBorderPromise(PlayerID activePlayer)`
					`IsPlayerBrokenBullyCityStatePromise`
				`bool`	`IsPlayerBrokenCityStatePromise(PlayerID activePlayer)`
				`bool`	`IsPlayerBrokenCoopWarPromise(PlayerID activePlayer)`
				`bool`	`IsPlayerBrokenExpansionPromise(PlayerID activePlayer)`
				`bool`	`IsPlayerBrokenMilitaryPromise(PlayerID activePlayer)`
					`IsPlayerBrokenNoConvertPromise`
					`IsPlayerBrokenSpyPromise`
				`bool`	`IsPlayerDenouncedEnemy(PlayerID otherPlayer)`
				`bool`	`IsPlayerDenouncedFriend(PlayerID activePlayer)`
				`bool`	`IsPlayerDoFwithAnyEnemy(PlayerID activePlayer)`
				`bool`	`IsPlayerDoFwithAnyFriend(PlayerID otherPlayer)`
					`IsPlayerForgivenForSpying`
				`bool`	`IsPlayerHasOpenBorders(PlayerID major)`
				`bool`	`IsPlayerHasOpenBordersAutomatically(PlayerID major)`
					`IsPlayerIgnoredAttackCityStatePromise`
				`bool`	`IsPlayerIgnoredBorderPromise(PlayerID activePlayer)`
					`IsPlayerIgnoredBullyCityStatePromise`
				`bool`	`IsPlayerIgnoredCityStatePromise(PlayerID activePlayer)`
				`bool`	`IsPlayerIgnoredExpansionPromise(PlayerID activePlayer)`
				`bool`	`IsPlayerIgnoredMilitaryPromise(PlayerID activePlayer)`
					`IsPlayerIgnoredNoConvertPromise`
					`IsPlayerIgnoredSpyPromise`
				`bool`	`IsPlayerNoSettleRequestEverAsked(PlayerID activePlayer)`
				`bool`	`IsPlayerRecklessExpander(PlayerID activePlayer)`
					`IsPlayerStopSpyingRequestEverAsked`
				`bool`	`IsPolicyBlocked(PolicyType i)`
				`bool`	`IsPolicyBranchBlocked(PolicyBranchType policyBranchIndex)`
				`bool`	`IsPolicyBranchFinished(PolicyBranchType arg0)`
				`int`	`IsPolicyBranchUnlocked(PolicyBranchType policyBranchIndex)`
				`bool`	`IsProductionMaxedBuildingClass(BuildingClassType buildingClass, bool acquireCity)`
				`bool`	`IsProductionMaxedProject(ProjectType project)`
				`bool`	`IsProductionMaxedUnitClass(UnitClassType unitClass)`
				`bool`	`IsProtectedByMajor(PlayerID activePlayer)`
				`int`	`IsProtectingMinor(PlayerID player)`
				`bool`	`IsResearch()`
				`bool`	`IsResearchingTech(int index)`
				`bool`	`IsStopSpyingMessageTooSoon(PlayerID activePlayer)`
				`bool`	`IsStrike()`
				`bool`	`IsThreateningBarbariansEventActiveForPlayer(PlayerID major)`
				`bool`	`IsTraitBonusReligiousBelief()`
				`int`	`IsTurnActive(unknown void)`
				`bool`	`IsUnitClassMaxedOut(UnitClassType index, int extra)`
					`IsUntrustworthyFriend`
				`bool`	`IsUsingMayaCalendar()`
				`bool`	`IsVotingMember(VoteSourceType voteSource)`
				`bool`	`IsWhiteFlag()`
				`bool`	`IsWillAcceptPeaceWithPlayer(PlayerID player)`

K

				`___________________________`
					`KillCities`
					`KillUnits`

P

				`___________________________`
					`PopResearch(TechType tech)`
				`bool`	`PushResearch(int index, bool clear)`

R

				`___________________________`
					`Raze(City city)`
					`ReceiveGoody(Plot plot, GoodyType goody, Unit unit)`
					`RemoveBuildingClass(BuildingClassType buildingClass)`

S

				`___________________________`
					`SetAdvancedStartPoints(int newValue)`
					`SetAlwaysSeeBarbCampsCount`
				`int`	`SetAnarchyNumTurns()`
					`SetBarbarianCombatBonus`
				`int`	`SetBaseBuildingGoldMaintenance()`
					`SetCombatExperience(int experience)`
					`SetConscriptCount(int newValue)`
					`SetEmbarkedGraphicOverride(string arg0)`
					`SetFaith(int arg0)`
					`SetFaithPurchaseIndex(int v2)`
					`SetFaithPurchaseType(FaithPurchaseType v1)`
					`SetGold(int newValue)`
					`SetGoldenAgeProgressMeter`
					`SetHappiness(int newValue)`
					`SetHappinessPerGarrisonedUnit(int value)`
					`SetHappinessPerTradeRoute(int value)`
					`SetHasPolicy(PolicyType index, bool newValue)`
					`SetJONSCulture(int newValue)`
					`SetLoyalMember(PlayerID minor, bool newValue)`
					`SetNavalCombatExperience`
					`SetNumFaithGreatPeople`
					`SetNumFreeGreatPeople`
					`SetNumFreePolicies`
					`SetNumFreeTechs`
					`SetNumGoldenAges`
					`SetNumMayaBoosts`
					`SetNumPlotsBought(int value)`
					`SetNumWondersBeatenTo`
					`SetOption(PlayerOptionType index, bool newValue)`
					`SetPersonalityType(MinorCivPersonalityType newValue)`
					`SetPlayable(bool newValue)`
					`SetPolicyBranchUnlocked(PolicyBranchType arg0, bool arg1)`
					`SetReplayDataValue`
					`SetResearchingTech(TechType index, bool newValue)`
					`SetScriptData(string newValue)`
					`SetStartingPlot(Plot plot)`
				`int`	`SpecialistYield(SpecialistType specialist, YieldType yield)`
					`StopTradingWithTeam(TeamID team)`

U

				`___________________________`
				`iterator(Unit)`	`Units()`
				`int`	`UnitsGoldenAgeCapable()`
				`int`	`UnitsGoldenAgeReady()`
				`int`	`UnitsRequiredForGoldenAge()`

W

				`___________________________`
					`WasResurrectedBy`
				`bool`	`WasResurrectedThisTurnBy(PlayerID player)`

Used by

`string`	`GetCityStateStatus(Player player, PlayerID forPlayer, int war)`
`string`	`GameplayUtilities.GetLocalizedLeaderTitle(Player player)`
`unknown`	`Player:GetPlayerVisiblePlot(Player player)`

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.

Player (Civ5 Type)

Contents

Instance Methods

A

C

D

F

G

H

I

K

P

R

S

U

W

Used by

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools