Lua Game Objects/Plot: Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
Line 1,636: Line 1,636:


==GetTerrainType==
==GetTerrainType==
''<summary>''
''Use to retrieve the type of terrain on a given plot.  <br>Use [[Lua_Game_Objects/Plot#SetTerrainType|plot:SetTerrainType]] to change a terrain type.''


'''Usage'''
'''Usage'''


plot:();
plot:GetTerrainType();


'''Parameters'''
'''Parameters'''
Line 1,649: Line 1,649:
''' Returns'''
''' Returns'''


No Description Available.
[[TerrainTypes]]


'''Example'''
'''Example'''

Revision as of 17:19, 27 October 2011

Plot objects represent a single instance of CvPlot.

Member Methods

AddFeatureDummyModel

<summary>

Usage

void plot:AddFeatureDummyModel(string dummyTag, string modelTag);

Parameters

dummyTag
No Description Available
modelTag
No Description Available

Returns

No Description Available.

Example 

No Example Available

Area

<summary>

Usage

plot:Area();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

At

<summary>

Usage

boolean plot:At(int iX, int iY);

Parameters

iX
No Description Available
iY
No Description Available

Returns

No Description Available.

Example 

No Example Available

CalculateBestNatureYield

<summary>

Usage

int plot:CalculateBestNatureYield(YieldTypes eIndex, TeamTypes eTeam);

Parameters

eIndex
No Description Available
eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

CalculateImprovementYieldChange

<summary>

Usage

int plot:CalculateImprovementYieldChange(ImprovementTypes eImprovement, YieldTypes eYield, PlayerTypes ePlayer, boolean bOptimal, RouteTypes eAssumeThisRoute);

Parameters

eImprovement
No Description Available
eYield
No Description Available
ePlayer
No Description Available
bOptimal
No Description Available
eAssumeThisRoute
No Description Available

Returns

No Description Available.

Example 

No Example Available

CalculateNatureYield

<summary>

Usage

int plot:CalculateNatureYield(YieldTypes eIndex, TeamTypes eTeam, boolean bIgnoreFeature = false);

Parameters

eIndex
No Description Available
eTeam
No Description Available
bIgnoreFeature
No Description Available

Returns

No Description Available.

Example 

No Example Available

CalculateTotalBestNatureYield

<summary>

Usage

int plot:CalculateTotalBestNatureYield(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

CalculateYield

<summary>

Usage

int plot:CalculateYield(YieldTypes eIndex, boolean bDisplay);

Parameters

eIndex
No Description Available
bDisplay
No Description Available

Returns

No Description Available.

Example 

No Example Available

CanBuild

<summary>

Usage

boolean plot:CanBuild(BuildTypes eBuild, PlayerTypes ePlayer, boolean bTestVisible);

Parameters

eBuild
No Description Available
ePlayer
No Description Available
bTestVisible
No Description Available

Returns

No Description Available.

Example 

No Example Available

CanHaveFeature

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

CanHaveImprovement

<summary>

Usage

boolean plot:CanHaveImprovement(ImprovementTypes eImprovement, TeamTypes eTeam, boolean bPotential);

Parameters

eImprovement
No Description Available
eTeam
No Description Available
bPotential
No Description Available

Returns

No Description Available.

Example 

No Example Available

CanHaveResource

<summary>

Usage

boolean plot:CanHaveResource(ResourceTypes eResource, boolean bIgnoreLatitude);

Parameters

eResource
No Description Available
bIgnoreLatitude
No Description Available

Returns

No Description Available.

Example 

No Example Available

CanSeePlot

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeBuildProgress

<summary>

Usage

boolean plot:ChangeBuildProgress(BuildTypes eBuild, int iChange, TeamTypes eTeam);

Parameters

eBuild
No Description Available
iChange
No Description Available
eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeCulture

Alters the culture 'yield' of the plot. This gives the tile a culture yield like that of a tile with a monument.

Usage

void plot:ChangeCulture(int iChange);

Parameters

iChange
The amount to change the tile's culture value by

Example 

No Example Available

ChangeExtraMovePathCost

<summary>

Usage

void plot:ChangeExtraMovePathCost(int iChange);

Parameters

iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeImprovementDuration

<summary>

Usage

void plot:ChangeImprovementDuration(int iChange);

Parameters

iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeInvisibleVisibilityCount

<summary>

Usage

void plot:ChangeInvisibleVisibilityCount(TeamTypes eTeam, InvisibleTypes eInvisible, int iChange);

Parameters

eTeam
No Description Available
eInvisible
No Description Available
iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeNumResource

<summary>

Usage

void plot:ChangeNumResource(int iChange);

Parameters

iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeOwnershipDuration

<summary>

Usage

void plot:ChangeOwnershipDuration(int iChange);

Parameters

iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeUpgradeProgress

<summary>

Usage

void plot:ChangeUpgradeProgress(int iChange);

Parameters

iChange
No Description Available

Returns

No Description Available.

Example 

No Example Available

ChangeVisibilityCount

<summary>

Usage

void plot:ChangeVisibilityCount(TeamTypes eTeam, int iChange, InvisibleTypes eSeeInvisibleType, boolean bInformExplorationTracking, boolean bAlwaysSeeInvisible);

Parameters

eTeam
No Description Available
iChange
No Description Available
eSeeInvisibleType
No Description Available
bInformExplorationTracking
No Description Available
bAlwaysSeeInvisible
No Description Available

Returns

No Description Available.

Example 

No Example Available

CountNumAirUnits

<summary>

Usage

int plot:CountNumAirUnits(TeamTypes ePlayer);

Parameters

ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

DefenseModifier

<summary>

Usage

int plot:DefenseModifier(TeamTypes iDefendTeam, boolean bIgnoreBuilding, boolean bHelp);

Parameters

iDefendTeam
No Description Available
bIgnoreBuilding
No Description Available
bHelp
No Description Available

Returns

No Description Available.

Example 

No Example Available

Erase

<summary>

Usage

void plot:Erase();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetArea

<summary>

Usage

int plot:GetArea();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetBestDefender

<summary>

Usage

plot:GetBestDefender(PlayerTypes eOwner, PlayerTypes eAttackingPlayer, <Unit> pAttacker, boolean bTestAtWar, boolean bTestPotentialEnemy, boolean bTestCanMove);

Parameters

eOwner
No Description Available
eAttackingPlayer
No Description Available
pAttacker
No Description Available
bTestAtWar
No Description Available
bTestPotentialEnemy
No Description Available
bTestCanMove
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetBuildProgress

<summary>

Usage

int plot:GetBuildProgress(BuildTypes eBuild);

Parameters

eBuild
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetBuildTime

<summary>

Usage

int plot:GetBuildTime(BuildTypes eBuild);

Parameters

eBuild
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetBuildTurnsLeft

<summary>

Usage

int plot:GetBuildTurnsLeft(BuildTypes eBuild, int iNowExtra, int iThenExtra);

Parameters

eBuild
No Description Available
iNowExtra
No Description Available
iThenExtra
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetBuildTurnsTotal

<summary>

Usage

int plot:GetBuildTurnsTotal(BuildTypes eBuild);

Parameters

eBuild
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetCityRadiusCount

<summary>

Usage

int plot:GetCityRadiusCount();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetContinentArtType

Determines continent for plot type.

Usage

plot:GetContinentArtType()

Parameters

No parameters.

Returns

Returns number 0=Ocean, 1=America, 2=Asia, 3=Africa, 4=Europa

Example 

local plot = Map.GetPlot(x, y);
if (plot:GetContinentArtType() == 1) then
print("America");

GetCulture

Determines the amount of culture yielded by working the plot.

Usage

int plot:GetCulture();

Parameters

None

Returns

The amount of culture yielded by working the plot.

Example 

No Example Available

GetExtraMovePathCost

<summary>

Usage

int plot:GetExtraMovePathCost();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetFeatureProduction

<summary>

Usage

int plot:GetFeatureProduction(BuildTypes eBuild, TeamTypes eTeam, <City> ppCity);

Parameters

eBuild
No Description Available
eTeam
No Description Available
ppCity
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetFeatureType

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

GetFeatureVariety

<summary>

Usage

int plot:GetFeatureVariety();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetFoundValue

<summary>

Usage

int plot:GetFoundValue(PlayerTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetImprovementDuration

<summary>

Usage

int plot:GetImprovementDuration();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetImprovementType

<summary>

Usage

ImprovementTypes plot:GetImprovementType();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetInlandCorner

<summary>

Usage

plot plot:GetInlandCorner();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetInvisibleVisibilityCount

<summary>

Usage

int plot:GetInvisibleVisibilityCount(TeamTypes eTeam, InvisibleTypes eInvisible);

Parameters

eTeam
No Description Available
eInvisible
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetLatitude

<summary>

Usage

int plot:GetLatitude();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetNearestLandArea

<summary>

Usage

int plot:GetNearestLandArea();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetNearestLandPlot

<summary>

Usage

plot:GetNearestLandPlot();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetNonObsoleteResourceType

<summary>

Usage

ResourceTypes plot:GetNonObsoleteResourceType(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetNumDefenders

<summary>

Usage

int plot:GetNumDefenders(PlayerTypes ePlayer);

Parameters

ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetNumFriendlyUnitsOfType

<summary>

Usage

int plot:GetNumFriendlyUnitsOfType(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetNumResource

<summary>

Usage

int plot:GetNumResource();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetNumUnits

<summary>

Usage

int plot:GetNumUnits();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetNumVisibleEnemyDefenders

<summary>

Usage

int plot:GetNumVisibleEnemyDefenders(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetNumVisiblePotentialEnemyDefenders

<summary>

Usage

int plot:GetNumVisiblePotentialEnemyDefenders(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetOwner

<summary>

Usage

PlayerTypes plot:GetOwner();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetOwnershipDuration

<summary>

Usage

int plot:GetOwnershipDuration();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetPlayerCityRadiusCount

<summary>

Usage

int plot:GetPlayerCityRadiusCount(PlayerTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetPlotCity

<summary>

Usage

plot:GetPlotCity();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetPlotType

<summary>

Usage

PlotTypes plot:GetPlotType();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetReconCount

<summary>

Usage

int plot:GetReconCount();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetResourceType

<summary>

Usage

ResourceTypes plot:GetResourceType(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetRevealedImprovementType

<summary>

Usage

ImprovementTypes plot:GetRevealedImprovementType(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetRevealedOwner

<summary>

Usage

PlayerTypes plot:GetRevealedOwner(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetRevealedRouteType

<summary>

Usage

RouteTypes plot:GetRevealedRouteType(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetRevealedTeam

<summary>

Usage

TeamTypes plot:GetRevealedTeam(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetRiverCrossingCount

<summary>

Usage

int plot:GetRiverCrossingCount();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetRiverEFlowDirection

<summary>

Usage

FlowDirectionTypes plot:GetRiverEFlowDirection();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetRiverSEFlowDirection

<summary>

Usage

FlowDirectionTypes plot:GetRiverSEFlowDirection();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetRiverSWFlowDirection

<summary>

Usage

FlowDirectionTypes plot:GetRiverSWFlowDirection();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetRouteType

<summary>

Usage

RouteTypes plot:GetRouteType();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetScriptData

<summary>

Usage

string plot:GetScriptData();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetSelectedUnit

<summary>

Usage

plot:GetSelectedUnit();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetTeam

<summary>

Usage

int plot:GetTeam();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetTerrainType

Use to retrieve the type of terrain on a given plot.
Use plot:SetTerrainType to change a terrain type.

Usage

plot:GetTerrainType();

Parameters

No Description Available

Returns

TerrainTypes

Example 

No Example Available

GetUnit

<summary>

Usage

plot:GetUnit(int iIndex);

Parameters

iIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetUnitPower

<summary>

Usage

int plot:GetUnitPower(PlayerTypes eOwner);

Parameters

eOwner
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetUpgradeProgress

<summary>

Usage

int plot:GetUpgradeProgress();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetUpgradeTimeLeft

<summary>

Usage

int plot:GetUpgradeTimeLeft(ImprovementTypes eImprovement, PlayerTypes ePlayer);

Parameters

eImprovement
No Description Available
ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetVisibilityCount

<summary>

Usage

int plot:GetVisibilityCount(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetWorkingCity

<summary>

Usage

plot:GetWorkingCity();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetWorkingCityOverride

<summary>

Usage

plot:GetWorkingCityOverride();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetX

<summary>

Usage

int plot:GetX();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetY

<summary>

Usage

int plot:GetY();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

GetYield

<summary>

Usage

int plot:GetYield(YieldTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

GetYieldWithBuild

<summary>

Usage

boolean plot:GetYieldWithBuild();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

HasBarbarianCamp

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

HasYield

<summary>

Usage

boolean plot:HasYield();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsActiveVisible

<summary>

Usage

boolean plot:IsActiveVisible(boolean bDebug);

Parameters

bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentNonrevealed

<summary>

Usage

boolean plot:IsAdjacentNonrevealed(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentNonvisible

<summary>

Usage

boolean plot:IsAdjacentNonvisible(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentOwned

<summary>

Usage

boolean plot:IsAdjacentOwned();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsAdjacentPlayer

<summary>

Usage

boolean plot:IsAdjacentPlayer(PlayerTypes ePlayer, boolean bLandOnly);

Parameters

ePlayer
No Description Available
bLandOnly
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentRevealed

<summary>

Usage

boolean plot:IsAdjacentRevealed(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentTeam

<summary>

Usage

boolean plot:IsAdjacentTeam(TeamTypes eTeam, boolean bLandOnly);

Parameters

eTeam
No Description Available
bLandOnly
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentToArea

<summary>

Usage

boolean plot:IsAdjacentToArea(<Area> pArea);

Parameters

pArea
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsAdjacentToLand

<summary>

Usage

boolean plot:IsAdjacentToLand();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsAdjacentToShallowWater

<summary>

Usage

boolean plot:IsAdjacentToShallowWater();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsAdjacentVisible

<summary>

Usage

boolean plot:IsAdjacentVisible(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsBarbarian

<summary>

Usage

boolean plot:IsBarbarian();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsBeingWorked

<summary>

Usage

boolean plot:IsBeingWorked();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsBestAdjacentFound

<summary>

Usage

boolean plot:IsBestAdjacentFound(PlayerTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsBuildRemovesFeature

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsCity

<summary>

Usage

boolean plot:IsCity();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsCityRadius

<summary>

Usage

int plot:IsCityRadius();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsCoastalLand

<summary>

Usage

boolean plot:IsCoastalLand();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsEnemyCity

<summary>

Usage

boolean plot:IsEnemyCity(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsFighting

<summary>

Usage

boolean plot:IsFighting();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsFlatlands

<summary>

Usage

boolean plot:IsFlatlands();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsFreshWater

<summary>

Usage

boolean plot:IsFreshWater();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsFriendlyCity

<summary>

Usage

boolean plot:IsFriendlyCity(<Unit> pUnit, boolean bCheckImprovement);

Parameters

pUnit
No Description Available
bCheckImprovement
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsFriendlyTerritory

<summary>

Usage

boolean plot:IsFriendlyTerritory(PlayerTypes ePlayer);

Parameters

ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsGoody

<summary>

Usage

boolean plot:IsGoody();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsHills

<summary>

Usage

boolean plot:IsHills();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsImpassable

<summary>

Usage

boolean plot:IsImpassable();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsImprovementPillaged

<summary>

Usage

boolean plot:IsImprovementPillaged();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsInvisibleVisible

<summary>

Usage

boolean plot:IsInvisibleVisible(TeamTypes eTeam, InvisibleTypes eInvisible);

Parameters

eTeam
No Description Available
eInvisible
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsLake

<summary>

Usage

boolean plot:IsLake();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsMountain

<summary>

Usage

boolean plot:IsMountain();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsNEOfRiver

<summary>

Usage

boolean plot:IsNEOfRiver();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsNone

<summary>

Usage

boolean plot:IsNone();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsNWOfRiver

<summary>

Usage

boolean plot:IsNWOfRiver();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsOpenGround

<summary>

Usage

boolean plot:IsOpenGround();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsOwned

<summary>

Usage

boolean plot:IsOwned();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsOwnershipScore

<summary>

Usage

boolean plot:IsOwnershipScore();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsPlayerCityRadius

<summary>

Usage

boolean plot:IsPlayerCityRadius(PlayerTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsPotentialCityWork

<summary>

Usage

boolean plot:IsPotentialCityWork();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsPotentialCityWorkForArea

<summary>

Usage

boolean plot:IsPotentialCityWorkForArea(<Area> pArea);

Parameters

pArea
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsResourceConnectedByImprovement

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRevealed

<summary>

Usage

boolean plot:IsRevealed(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRevealedBarbarian

<summary>

Usage

boolean plot:IsRevealedBarbarian();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsRevealedGoody

<summary>

Usage

boolean plot:IsRevealedGoody(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiver

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiverConnection

<summary>

Usage

boolean plot:IsRiverConnection(DirectionTypes eDirection);

Parameters

eDirection
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiverCrossing

<summary>

Usage

boolean plot:IsRiverCrossing(DirectionTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiverCrossingFlowClockwise

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiverCrossingToPlot

<summary>

Usage

boolean plot:IsRiverCrossingToPlot(DirectionTypes eIndex);

Parameters

eIndex
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsRiverSide

<summary>

Usage

boolean plot:IsRiverSide();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsRoughGround

<summary>

Usage

boolean plot:IsRoughGround();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsRoute

<summary>

Usage

boolean plot:IsRoute();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsRoutePillaged

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsStartingPlot

<summary>

Usage

boolean plot:IsStartingPlot();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsTradeRoute

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsUnit

<summary>

Usage

boolean plot:IsUnit();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsValidDomainForAction

<summary>

Usage

boolean plot:IsValidDomainForAction(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsValidDomainForLocation

<summary>

Usage

boolean plot:IsValidDomainForLocation(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsVisible

<summary>

Usage

boolean plot:IsVisible(TeamTypes eTeam, boolean bDebug);

Parameters

eTeam
No Description Available
bDebug
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsVisibleEnemyDefender

<summary>

Usage

boolean plot:IsVisibleEnemyDefender(<Unit> pUnit);

Parameters

pUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsVisibleEnemyUnit

<summary>

Usage

boolean plot:IsVisibleEnemyUnit(PlayerTypes ePlayer);

Parameters

ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsVisibleOtherUnit

<summary>

Usage

boolean plot:IsVisibleOtherUnit(PlayerTypes ePlayer);

Parameters

ePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsVisibleToWatchingHuman

<summary>

Usage

boolean plot:IsVisibleToWatchingHuman();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

IsWater

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

IsWithinTeamCityRadius

<summary>

Usage

boolean plot:IsWithinTeamCityRadius(TeamTypes eTeam, PlayerTypes eIgnorePlayer);

Parameters

eTeam
No Description Available
eIgnorePlayer
No Description Available

Returns

No Description Available.

Example 

No Example Available

IsWOfRiver

<summary>

Usage

boolean plot:IsWOfRiver();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

MovementCost

<summary>

Usage

int plot:MovementCost(<Unit> pUnit, <Plot> pFromPlot);

Parameters

pUnit
No Description Available
pFromPlot
No Description Available

Returns

No Description Available.

Example 

No Example Available

NukeExplosion

<summary>

Usage

void plot:NukeExplosion(int iRange, <Unit> pNukeUnit);

Parameters

iRange
No Description Available
pNukeUnit
No Description Available

Returns

No Description Available.

Example 

No Example Available

PickFeatureDummyTag

<summary>

Usage

string plot:PickFeatureDummyTag(int mouseX, int mouseY);

Parameters

mouseX
No Description Available
mouseY
No Description Available

Returns

No Description Available.

Example 

No Example Available

RemoveGoody

<summary>

Usage

void plot:RemoveGoody();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

ResetFeatureModel

<summary>

Usage

void plot:ResetFeatureModel();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

SeeFromLevel

<summary>

Usage

int plot:SeeFromLevel(TeamTypes eTeam);

Parameters

eTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

SeeThroughLevel

<summary>

Usage

int plot:SeeThroughLevel();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

SetArea

<summary>

Usage

int plot:SetArea();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

SetContinentArtType

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

SetFeatureDummyTexture

<summary>

Usage

void plot:SetFeatureDummyTexture(string dummyTag, string textureTag);

Parameters

dummyTag
No Description Available
textureTag
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetFeatureDummyVisibility

<summary>

Usage

void plot:SetFeatureDummyVisibility(string dummyTag, boolean show);

Parameters

dummyTag
No Description Available
show
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetFeatureType

<summary>

Usage

plot:();

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

SetImprovementDuration

<summary>

Usage

void plot:SetImprovementDuration(int iNewValue);

Parameters

iNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetImprovementPillaged

<summary>

Usage

void plot:SetImprovementType(boolean b);

Parameters

b
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetImprovementType

<summary>

Usage

void plot:SetImprovementType(ImprovementTypes eNewValue);

Parameters

eNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetNEOfRiver

<summary>

Usage

void plot:SetNEOfRiver(boolean bNewValue, FlowDirectionTypes eRiverDir);

Parameters

bNewValue
No Description Available
eRiverDir
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetNumResource

<summary>

Usage

void plot:SetNumResource(int iNum);

Parameters

iNum
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetNWOfRiver

<summary>

Usage

void plot:SetNWOfRiver(boolean bNewValue, FlowDirectionTypes eRiverDir);

Parameters

bNewValue
No Description Available
eRiverDir
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetOwner

<summary>

Usage

void plot:SetOwner(PlayerTypes eNewValue, int iAcquiringCityID, boolean bCheckUnits = true, boolean bUpdateResources = true);

Parameters

eNewValue
No Description Available
iAcquiringCityID
No Description Available
bCheckUnits
No Description Available
bUpdateResources
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetOwnershipDuration

<summary>

Usage

void plot:SetOwnershipDuration(int iNewValue);

Parameters

iNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetPlotType

<summary>

Usage

void plot:SetPlotType(PlotTypes eNewValue, boolean bRecalculate, boolean bRebuildGraphics);

Parameters

eNewValue
No Description Available
bRecalculate
No Description Available
bRebuildGraphics
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetResourceType

<summary>

Usage

void plot:SetResourceType(ResourceTypes eNewValue, int iNumResource);

Parameters

eNewValue
No Description Available
iNumResource
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetRevealed

<summary>

Usage

void plot:SetRevealed(TeamTypes eTeam, boolean bNewValue, boolean bTerrainOnly, TeamTypes eFromTeam);

Parameters

eTeam
No Description Available
bNewValue
No Description Available
bTerrainOnly
No Description Available
eFromTeam
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetRouteType

<summary>

Usage

void plot:SetRouteType(RouteTypes eNewValue);

Parameters

eNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetScriptData

<summary>

Usage

void plot:SetScriptData(string szNewValue);

Parameters

szNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetStartingPlot

<summary>

Usage

void plot:SetStartingPlot(boolean bNewValue);

Parameters

bNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetTerrainType

Use to set the terrain on a given plot.
Graphics will refresh only after a save, exit to main menu and reload
Use with plot:GetTerrainType

Usage

plot:SetTerrainType(TerrainTypes type);

Parameters

No Description Available

Returns

No Description Available.

Example 

No Example Available

SetUpgradeProgress

<summary>

Usage

void plot:SetUpgradeProgress(int iNewValue);

Parameters

iNewValue
No Description Available

Returns

No Description Available.

Example 

No Example Available

SetWOfRiver

<summary>

Usage

void plot:SetWOfRiver(boolean bNewValue, FlowDirectionTypes eRiverDir);

Parameters

bNewValue
No Description Available
eRiverDir
No Description Available

Returns

No Description Available.

Example 

No Example Available

ShareAdjacentArea

<summary>

Usage

boolean plot:ShareAdjacentArea(<Plot> pPlot);

Parameters

pPlot
No Description Available

Returns

No Description Available.

Example 

No Example Available

UpdateFog

<summary>

Usage

void plot:UpdateFog();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

UpdateVisibility

<summary>

Usage

void plot:UpdateVisibility();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

WaterArea

<summary>

Usage

plot:WaterArea();

Parameters

None

Returns

No Description Available.

Example 

No Example Available

See also

Retrieved from "https://modiki.civfanatics.com/index.php?title=Lua_Game_Objects/Plot&oldid=9217"