User:DonQuich

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

	Plot:AddFeatureDummyModel(string dummyTag, string modelTag)
	'
	Returned value: '
	dummyTag:
	modelTag:
	Plot:Area()
	'
	Returned value: '
bool	Plot:At(int x, int y)
	'
	Returned value: '
	x:
	y:
int	Plot:CalculateBestNatureYield(YieldID yieldID, TeamID eTeam)
	'
	Returned value: '
	yieldID:
	eTeam:
int	Plot:CalculateImprovementYieldChange(ImprovementID improvementID, YieldID yieldID, PlayerID ePlayer, bool optimal, RouteID assumeThisRouteID)
	'
	Returned value: '
	improvementID:
	yieldID:
	ePlayer:
	optimal:
	assumeThisRouteID:
int	Plot:CalculateNatureYield(YieldID yieldID, TeamID eTeam, bool ignoreFeature)
	'
	Returned value: '
	yieldID:
	eTeam:
	ignoreFeature:
int	Plot:CalculateTotalBestNatureYield(TeamID eTeam)
	'
	Returned value: '
	eTeam:
int	Plot:CalculateYield(YieldID yieldID, bool display)
	'
	Returned value: '
	yieldID:
	display:
bool	Plot:CanBuild(BuildActionID buildID, PlayerID ePlayer, bool testVisible)
	'
	Returned value: '
	buildID:
	ePlayer:
	testVisible:
	Plot:CanHaveFeature()
	'
	Returned value: '
bool	Plot:CanHaveImprovement(ImprovementID improvementID, TeamID eTeam, bool potential)
	'
	Returned value: '
	improvementID:
	eTeam:
	potential:
bool	Plot:CanHaveResource(ResourceID resourceID, bool ignoreLatitude)
	'
	Returned value: '
	resourceID:
	ignoreLatitude:
	Plot:CanSeePlot()
	'
	Returned value: '
bool	Plot:ChangeBuildProgress(BuildActionID buildID, int change, TeamID eTeam)
	'
	Returned value: '
	buildID:
	change:
	eTeam:
	Plot:ChangeExtraMovePathCost(int change)
	'
	Returned value: '
	change:
	Plot:ChangeImprovementDuration(int change)
	'
	Returned value: '
	change:
	Plot:ChangeInvisibleVisibilityCount(TeamID eTeam, InvisibilityScopeID invisibleID, int change)
	'
	Returned value: '
	eTeam:
	invisibleID:
	change:
	Plot:ChangeNumResource(int change)
	'
	Returned value: '
	change:
	Plot:ChangeOwnershipDuration(int change)
	'
	Returned value: '
	change:
	Plot:ChangeUpgradeProgress(int change)
	'
	Returned value: '
	change:
	Plot:ChangeVisibilityCount(TeamID eTeam, int change, InvisibilityScopeID seeInvisibleTypeID, bool informExplorationTracking, bool alwaysSeeInvisible)
	'
	Returned value: '
	eTeam:
	change:
	seeInvisibleTypeID:
	informExplorationTracking:
	alwaysSeeInvisible:
int	Plot:CountNumAirUnits(TeamID ePlayer)
	'
	Returned value: '
	ePlayer:
int	Plot:DefenseModifier(TeamID iDefendTeam, bool ignoreBuilding, bool help)
	'
	Returned value: '
	iDefendTeam:
	ignoreBuilding:
	help:
	Plot:Erase()
	'
	Returned value: '
	Plot:GetActiveFogOfWarMode(<unknown>)
	'
	Returned value: '
int	Plot:GetArea()
	'
	Returned value: '
	Plot:GetBestDefender(PlayerID eOwner, PlayerID eAttackingPlayer, Unit attacker, bool testAtWar, bool testPotentialEnemy, bool testCanMove)
	'
	Returned value: '
	eOwner:
	eAttackingPlayer:
	attacker:
	testAtWar:
	testPotentialEnemy:
	testCanMove:
int	Plot:GetBuildProgress(BuildActionID buildID)
	'
	Returned value: '
	buildID:
int	Plot:GetBuildTime(BuildActionID buildID)
	'
	Returned value: '
	buildID:
int	Plot:GetBuildTurnsLeft(BuildActionID buildID, int nowExtra, int thenExtra)
	'
	Returned value: '
	buildID:
	nowExtra:
	thenExtra:
int	Plot:GetBuildTurnsTotal(BuildActionID buildID)
	'
	Returned value: '
	buildID:
int	Plot:GetCityRadiusCount()
	'
	Returned value: '
	Plot:GetContinentArtType()
	'Determines continent for plot type.'
	Returned value: Returns number 0=Ocean, 1=America, 2=Asia, 3=Africa, 4=Europa
int	Plot:GetExtraMovePathCost()
	'
	Returned value: '
int	Plot:GetFeatureProduction(BuildActionID buildID, TeamID eTeam, City city)
	'
	Returned value: '
	buildID:
	eTeam:
	city:
	Plot:GetFeatureType()
	'
	Returned value: '
int	Plot:GetFeatureVariety()
	'
	Returned value: '
int	Plot:GetFoundValue(PlayerID eIndex)
	'
	Returned value: '
	eIndex:
int	Plot:GetImprovementDuration()
	'
	Returned value: '
ImprovementID	Plot:GetImprovementType()
	'
	Returned value: '
Plot	Plot:GetInlandCorner()
	'
	Returned value: '
int	Plot:GetInvisibleVisibilityCount(TeamID eTeam, InvisibilityScopeID invisibleID)
	'
	Returned value: '
	eTeam:
	invisibleID:
int	Plot:GetLatitude()
	'
	Returned value: '
int	Plot:GetNearestLandArea()
	'
	Returned value: '
	Plot:GetNearestLandPlot()
	'
	Returned value: '
ResourceID	Plot:GetNonObsoleteResourceType(TeamID eTeam)
	'
	Returned value: '
	eTeam:
int	Plot:GetNumDefenders(PlayerID ePlayer)
	'
	Returned value: '
	ePlayer:
int	Plot:GetNumFriendlyUnitsOfType(Unit unit)
	'
	Returned value: '
	unit:
int	Plot:GetNumResource()
	'
	Returned value: '
int	Plot:GetNumUnits()
	'
	Returned value: '
int	Plot:GetNumVisibleEnemyDefenders(Unit unit)
	'
	Returned value: '
	unit:
int	Plot:GetNumVisiblePotentialEnemyDefenders(Unit unit)
	'
	Returned value: '
	unit:
PlayerID	Plot:GetOwner()
	'
	Returned value: '
int	Plot:GetOwnershipDuration()
	'
	Returned value: '
int	Plot:GetPlayerCityRadiusCount(PlayerID eIndex)
	'
	Returned value: '
	eIndex:
	Plot:GetPlotCity()
	'
	Returned value: '
	Plot:GetPlotType()
	'
	Returned value: '
int	Plot:GetReconCount()
	'
	Returned value: '
ResourceID	Plot:GetResourceType(TeamID eTeam)
	'
	Returned value: '
	eTeam:
ImprovementID	Plot:GetRevealedImprovementType(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
PlayerID	Plot:GetRevealedOwner(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
RouteID	Plot:GetRevealedRouteType(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
TeamID	Plot:GetRevealedTeam(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
int	Plot:GetRiverCrossingCount()
	'
	Returned value: '
FlowDirectionID	Plot:GetRiverEFlowDirection()
	'
	Returned value: '
FlowDirectionID	Plot:GetRiverSEFlowDirection()
	'
	Returned value: '
FlowDirectionID	Plot:GetRiverSWFlowDirection()
	'
	Returned value: '
RouteID	Plot:GetRouteType()
	'
	Returned value: '
string	Plot:GetScriptData()
	'
	Returned value: '
	Plot:GetSelectedUnit()
	'
	Returned value: '
int	Plot:GetTeam()
	'
	Returned value: '
	Plot:GetTerrainType()
	'
	Returned value: '
	Plot:GetUnit(int index)
	'
	Returned value: '
	index:
int	Plot:GetUnitPower(PlayerID eOwner)
	'
	Returned value: '
	eOwner:
int	Plot:GetUpgradeProgress()
	'
	Returned value: '
int	Plot:GetUpgradeTimeLeft(ImprovementID improvementID, PlayerID ePlayer)
	'
	Returned value: '
	improvementID:
	ePlayer:
int	Plot:GetVisibilityCount(TeamID eTeam)
	'
	Returned value: '
	eTeam:
	Plot:GetWorkingCity()
	'
	Returned value: '
	Plot:GetWorkingCityOverride()
	'
	Returned value: '
int	Plot:GetX()
	'
	Returned value: '
int	Plot:GetY()
	'
	Returned value: '
int	Plot:GetYield(YieldID yieldID)
	'
	Returned value: '
	yieldID:
bool	Plot:GetYieldWithBuild()
	'
	Returned value: '
	Plot:HasBarbarianCamp()
	'
	Returned value: '
bool	Plot:HasYield()
	'
	Returned value: '
bool	Plot:IsActiveVisible(bool debug)
	'
	Returned value: '
	debug:
bool	Plot:IsAdjacentNonrevealed(TeamID eTeam)
	'
	Returned value: '
	eTeam:
bool	Plot:IsAdjacentNonvisible(TeamID eTeam)
	'
	Returned value: '
	eTeam:
bool	Plot:IsAdjacentOwned()
	'
	Returned value: '
bool	Plot:IsAdjacentPlayer(PlayerID ePlayer, bool landOnly)
	'
	Returned value: '
	ePlayer:
	landOnly:
bool	Plot:IsAdjacentRevealed(TeamID eTeam)
	'
	Returned value: '
	eTeam:
bool	Plot:IsAdjacentTeam(TeamID eTeam, bool landOnly)
	'
	Returned value: '
	eTeam:
	landOnly:
bool	Plot:IsAdjacentToArea(Area area)
	'
	Returned value: '
	area:
bool	Plot:IsAdjacentToLand()
	'
	Returned value: '
bool	Plot:IsAdjacentToShallowWater()
	'
	Returned value: '
bool	Plot:IsAdjacentVisible(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
bool	Plot:IsBarbarian()
	'
	Returned value: '
bool	Plot:IsBeingWorked()
	'
	Returned value: '
bool	Plot:IsBestAdjacentFound(PlayerID eIndex)
	'
	Returned value: '
	eIndex:
	Plot:IsBuildRemovesFeature()
	'
	Returned value: '
bool	Plot:IsCity()
	'
	Returned value: '
int	Plot:IsCityRadius()
	'
	Returned value: '
bool	Plot:IsCoastalLand()
	'
	Returned value: '
bool	Plot:IsEnemyCity(Unit unit)
	'
	Returned value: '
	unit:
bool	Plot:IsFighting()
	'
	Returned value: '
bool	Plot:IsFlatlands()
	'
	Returned value: '
bool	Plot:IsFreshWater()
	'
	Returned value: '
bool	Plot:IsFriendlyCity(Unit unit, bool checkImprovement)
	'
	Returned value: '
	unit:
	checkImprovement:
bool	Plot:IsFriendlyTerritory(PlayerID ePlayer)
	'
	Returned value: '
	ePlayer:
bool	Plot:IsGoody()
	'
	Returned value: '
bool	Plot:IsHills()
	'
	Returned value: '
bool	Plot:IsImpassable()
	'
	Returned value: '
bool	Plot:IsImprovementPillaged()
	'
	Returned value: '
bool	Plot:IsInvisibleVisible(TeamID eTeam, InvisibilityScopeID invisibleID)
	'
	Returned value: '
	eTeam:
	invisibleID:
bool	Plot:IsLake()
	'
	Returned value: '
bool	Plot:IsMountain()
	'
	Returned value: '
bool	Plot:IsNEOfRiver()
	'
	Returned value: '
bool	Plot:IsNone()
	'
	Returned value: '
bool	Plot:IsNWOfRiver()
	'
	Returned value: '
bool	Plot:IsOpenGround()
	'
	Returned value: '
bool	Plot:IsOwned()
	'
	Returned value: '
bool	Plot:IsOwnershipScore()
	'
	Returned value: '
bool	Plot:IsPlayerCityRadius(PlayerID eIndex)
	'
	Returned value: '
	eIndex:
bool	Plot:IsPotentialCityWork()
	'
	Returned value: '
bool	Plot:IsPotentialCityWorkForArea(Area area)
	'
	Returned value: '
	area:
	Plot:IsResourceConnectedByImprovement()
	'
	Returned value: '
bool	Plot:IsRevealed(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
bool	Plot:IsRevealedBarbarian()
	'
	Returned value: '
bool	Plot:IsRevealedGoody(TeamID eTeam)
	'
	Returned value: '
	eTeam:
	Plot:IsRiver()
	'
	Returned value: '
bool	Plot:IsRiverConnection(DirectionID directionID)
	'
	Returned value: '
	directionID:
bool	Plot:IsRiverCrossing(DirectionID directionID)
	'
	Returned value: '
	directionID:
	Plot:IsRiverCrossingFlowClockwise()
	'
	Returned value: '
bool	Plot:IsRiverCrossingToPlot(DirectionID directionID)
	'
	Returned value: '
	directionID:
bool	Plot:IsRiverSide()
	'
	Returned value: '
bool	Plot:IsRoughGround()
	'
	Returned value: '
bool	Plot:IsRoute()
	'
	Returned value: '
	Plot:IsRoutePillaged()
	'
	Returned value: '
bool	Plot:IsStartingPlot()
	'
	Returned value: '
	Plot:IsTradeRoute()
	'
	Returned value: '
bool	Plot:IsUnit()
	'
	Returned value: '
bool	Plot:IsValidDomainForAction(Unit unit)
	'
	Returned value: '
	unit:
bool	Plot:IsValidDomainForLocation(Unit unit)
	'
	Returned value: '
	unit:
bool	Plot:IsVisible(TeamID eTeam, bool debug)
	'
	Returned value: '
	eTeam:
	debug:
bool	Plot:IsVisibleEnemyDefender(Unit unit)
	'
	Returned value: '
	unit:
bool	Plot:IsVisibleEnemyUnit(PlayerID ePlayer)
	'
	Returned value: '
	ePlayer:
bool	Plot:IsVisibleOtherUnit(PlayerID ePlayer)
	'
	Returned value: '
	ePlayer:
bool	Plot:IsVisibleToWatchingHuman()
	'
	Returned value: '
	Plot:IsWater()
	'
	Returned value: '
bool	Plot:IsWithinTeamCityRadius(TeamID eTeam, PlayerID eIgnorePlayer)
	'
	Returned value: '
	eTeam:
	eIgnorePlayer:
bool	Plot:IsWOfRiver()
	'
	Returned value: '
int	Plot:MovementCost(Unit unit, Plot fromPlot)
	'
	Returned value: '
	unit:
	fromPlot:
	Plot:NukeExplosion(int range, Unit nukeUnit)
	'
	Returned value: '
	range:
	nukeUnit:
string	Plot:PickFeatureDummyTag(int mouseX, int mouseY)
	'
	Returned value: '
	mouseX:
	mouseY:
	Plot:RemoveGoody()
	'
	Returned value: '
	Plot:ResetFeatureModel()
	'
	Returned value: '
int	Plot:SeeFromLevel(TeamID eTeam)
	'
	Returned value: '
	eTeam:
int	Plot:SeeThroughLevel()
	'
	Returned value: '
int	Plot:SetArea()
	'
	Returned value: '
	Plot:SetContinentArtType()
	'
	Returned value: '
	Plot:SetFeatureDummyTexture(string dummyTag, string textureTag)
	'
	Returned value: '
	dummyTag:
	textureTag:
	Plot:SetFeatureDummyVisibility(string dummyTag, bool show)
	'
	Returned value: '
	dummyTag:
	show:
	Plot:SetFeatureType()
	'
	Returned value: '
	Plot:SetImprovementDuration(int newValue)
	'
	Returned value: '
	newValue:
	Plot:SetImprovementPillaged(bool b)
	'
	Returned value: '
	b:
	Plot:SetImprovementType(ImprovementID newValueID)
	'
	Returned value: '
	newValueID:
	Plot:SetNEOfRiver(bool newValue, FlowDirectionID riverDirID)
	'
	Returned value: '
	newValue:
	riverDirID:
	Plot:SetNumResource(int num)
	'
	Returned value: '
	num:
	Plot:SetNWOfRiver(bool newValue, FlowDirectionID riverDirID)
	'
	Returned value: '
	newValue:
	riverDirID:
	Plot:SetOwner(PlayerID eNewValue, int acquiringCityID, bool checkUnits, bool updateResources)
	'
	Returned value: '
	eNewValue:
	acquiringCityID:
	checkUnits:
	updateResources:
	Plot:SetOwnershipDuration(int newValue)
	'
	Returned value: '
	newValue:
	Plot:SetPlotType(PlotTypeID newValueID, bool recalculate, bool rebuildGraphics)
	'
	Returned value: '
	newValueID:
	recalculate:
	rebuildGraphics:
	Plot:SetResourceType(ResourceID newValueID, int numResource)
	'
	Returned value: '
	newValueID:
	numResource:
	Plot:SetRevealed(TeamID eTeam, bool newValue, bool terrainOnly, TeamID eFromTeam)
	'
	Returned value: '
	eTeam:
	newValue:
	terrainOnly:
	eFromTeam:
	Plot:SetRouteType(RouteID newValueID)
	'
	Returned value: '
	newValueID:
	Plot:SetScriptData(string szNewValue)
	'
	Returned value: '
	szNewValue:
	Plot:SetStartingPlot(bool newValue)
	'
	Returned value: '
	newValue:
	Plot:SetTerrainType(TerrainID type)
	'
	Returned value: '
	type:
	Plot:SetUpgradeProgress(int newValue)
	'
	Returned value: '
	newValue:
	Plot:SetWOfRiver(bool newValue, FlowDirectionID riverDirID)
	'
	Returned value: '
	newValue:
	riverDirID:
bool	Plot:ShareAdjacentArea(Plot plot)
	'
	Returned value: '
	plot:
	Plot:UpdateFog()
	'
	Returned value: '
	Plot:UpdateVisibility()
	'
	Returned value: '
	Plot:WaterArea()
	'
	Returned value: '