Civilization Modding Wiki - User contributions [en]

TeamTechs.SetHasTech (Civ5 API)

2014-10-29T04:38:16Z

Slserpent: parameters and such

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|TeamTechs}}. 
This is an instance method, invoke it with a colon.
}}

Gives or removes a technology from a team. Can also work on disabled techs.

=Usage=
<code>'''void''' TeamTechs:SetHasTech({{Type5|TechType}} tech, '''bool''' giveTech)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|tech:
|valign="top"| ''The technology to give or remove.''
|-
|valign="top" style="padding-right:6px;"|giveTech:
|valign="top"| ''If true, gives the team this technology. If false, removes the technology.''
|}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|SetHasTech]]
[[Category:Civ5 Science API|SetHasTech]]

Fractal.GetHeight (Civ5 API)

2014-06-27T09:29:11Z

Slserpent: /* Usage */

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is an instance method, invoke it with a colon. 
Used to get the value of the 2D fractal array or the value of a certain percentage of the array.
}}

=Usage=
<code>'''int''' Fractal:GetHeight('''int''' percentage)</code>

'''Returned Value'''
:Returns the threshold value of a percentage of the fractal array. For example, if you pass in 70, this function will return a number close to 178, give or take some depending on the breakdown of the values in the array. Seems to have trouble with smaller arrays (<10x10).
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|percentage:
|valign="top"| ''A number between 0 and 100.''
|}

<code>'''int''' Fractal:GetHeight('''int''' x, '''int''' y)</code>

'''Returned Value'''
:Returns the value of the fractal array at coordinates X, Y. The value is between 0 and 255.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''X coordinate of the value to retrieve.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''Y coordinate of the value to retrieve.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 603 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0075}}<syntaxhighlight lang="lua">local iHillsTop2 = hillsFrac:GetHeight(80);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0080}}<syntaxhighlight lang="lua">local iPeakAndes = peaksFrac:GetHeight(63);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0271}}<syntaxhighlight lang="lua">local iAndesGrass = grass_check:GetHeight(65)</syntaxhighlight>
{{CodeLine5|0272}}<syntaxhighlight lang="lua">local iAndesDesert = desert_check:GetHeight(75)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0312}}<syntaxhighlight lang="lua">local desertVal = desert_check:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iOpenLevel = open_lands:GetHeight(100 - iOpenPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local featureForest = FeatureTypes.FEATURE_FOREST;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0397}}<syntaxhighlight lang="lua">if plot:CanHaveFeature(featureForest) and forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0418}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0423}}<syntaxhighlight lang="lua">if marshes:GetHeight(x, y) >= iRiverMarshLevel then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">local iLakesThreshold = lakesFrac:GetHeight(94);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0138}}<syntaxhighlight lang="lua">local iHillsNearMountains = mountainsFrac:GetHeight(hillsNearMountains);</syntaxhighlight>
{{CodeLine5|0139}}<syntaxhighlight lang="lua">local iMountainThreshold = mountainsFrac:GetHeight(mountains);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0148}}<syntaxhighlight lang="lua">local lakeVal = lakesFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0153}}<syntaxhighlight lang="lua">local hillVal = hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0184}}<syntaxhighlight lang="lua">local iSnowThreshold = snowFrac:GetHeight(65);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">local iHillsTop2 = self.hillsFrac:GetHeight(75);</syntaxhighlight>
{{CodeLine5|0114}}<syntaxhighlight lang="lua">local iHillsClumps = self.mountainsFrac:GetHeight(4);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0447}}<syntaxhighlight lang="lua">local iGrassTop = grass_frac:GetHeight(iGrassPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0520}}<syntaxhighlight lang="lua">local val = snow_frac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0257}}<syntaxhighlight lang="lua">local marsh_height = self.marsh:GetHeight(iX, iY)</syntaxhighlight>
{{CodeLine5|0258}}<syntaxhighlight lang="lua">if(marsh_height >= self.iMarshLevel) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0276}}<syntaxhighlight lang="lua">if (self.forests:GetHeight(iX, iY) >= self.iForestLevel) or (self.forestclumps:GetHeight(iX, iY) >= self.iClumpLevel) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0680}}<syntaxhighlight lang="lua">local iHillsBottom1 = self.hillsFrac:GetHeight(hillsBottom1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">local iMountain95 = self.mountainsFrac:GetHeight(95);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0717}}<syntaxhighlight lang="lua">local hillVal = self.hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local iPlainsThreshold = hillsFrac:GetHeight(8);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">lat = lat + (128 - regionsFrac:GetHeight(x, y))/(255.0 * 5.0);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iTexDesertBottom = plains:GetHeight(iTexDesertBottomPercent)</syntaxhighlight>
{{CodeLine5|0375}}<syntaxhighlight lang="lua">local iGrassTop = plains:GetHeight(iGrassTopPercent)</syntaxhighlight>
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local iGrassBottom = plains:GetHeight(iGrassBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0379}}<syntaxhighlight lang="lua">local iEastDTop = east:GetHeight(iEastDTopPercent)</syntaxhighlight>
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local iEastDBottom = east:GetHeight(iEastDBottomPercent)</syntaxhighlight>
{{CodeLine5|0381}}<syntaxhighlight lang="lua">local iEastPTop = east:GetHeight(iEastPTopPercent)</syntaxhighlight>
{{CodeLine5|0382}}<syntaxhighlight lang="lua">local iEastPBottom = east:GetHeight(iEastPBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0425}}<syntaxhighlight lang="lua">local val = east:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0497}}<syntaxhighlight lang="lua">local iRockyForestLevel = forests:GetHeight(iRockyForestPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0499}}<syntaxhighlight lang="lua">local featureFloodPlains = FeatureTypes.FEATURE_FLOOD_PLAINS;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0541}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) <= iEastForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1493}}<syntaxhighlight lang="lua">local iHerdsTop1 = herds:GetHeight(27)</syntaxhighlight>
{{CodeLine5|1494}}<syntaxhighlight lang="lua">local iHerdsBottom2 = herds:GetHeight(73)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0822}}<syntaxhighlight lang="lua">local iHillsBottom1 = regionHillsFrac:GetHeight(20);</syntaxhighlight>
{{CodeLine5|0823}}<syntaxhighlight lang="lua">local iHillsTop1 = regionHillsFrac:GetHeight(35);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0180}}<syntaxhighlight lang="lua">local iHillsThreshold = terrainFrac:GetHeight(hills);</syntaxhighlight>
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local iPeaksThreshold = terrainFrac:GetHeight(peaks);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local iPassThreshold = mountain_passFrac:GetHeight(85);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">local passVal = mountain_passFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0369}}<syntaxhighlight lang="lua">local iWaterThreshold = regionContinentsFrac:GetHeight(iWaterPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0372}}<syntaxhighlight lang="lua">local iHillsBottom2 = regionHillsFrac:GetHeight(75 - adjustment);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local val = regionContinentsFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Ring.lua}}
:<code>Maps/Ring.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0511}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(80) -- 20% forest coverage</syntaxhighlight>
{{CodeLine5|0512}}<syntaxhighlight lang="lua">self.iClumpLevel = self.forestclumps:GetHeight(94) -- 6% forest clumps</syntaxhighlight>
{{CodeLine5|0513}}<syntaxhighlight lang="lua">self.iMarshLevel = self.marsh:GetHeight(100 - self.fMarshPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">if dominant_terrain == 3 then -- Forest</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0517}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(55) -- 45% forest coverage of what isn't covered by clumps.</syntaxhighlight>
{{CodeLine5|0518}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0307}}<syntaxhighlight lang="lua">elseif desertVal >= self.deserts:GetHeight(94) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">self.iDesertBottom = self.deserts:GetHeight(self.iDesertBottomPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0119}}<syntaxhighlight lang="lua">self.iPlainsTop = self.plains:GetHeight(self.iPlainsTopPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsVal = self.plains:GetHeight(iX, iY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GetHeight]]

Basic DLL tasks

2014-02-27T17:19:26Z

Slserpent: /* Requirements */

=Basic DLL Tasks=

The Civilization V SDK ships with the C++ source code for the Civilization V CvGameCoreDLL. This is the most powerful tool modders have, as it allows us to directly alter game code and game logic, but also one of the least used, as it has a codebase in excess of 100,000 lines of code and the architecture of the program is not always clear. In this article some basic tasks in modding the DLL will be covered, as well as some more advanced ones as well.

=Requirements=

This article is NOT a C++ tutorial. If you need one of those, Google is your friend. I will assume that you have knowledge of C++ coding, as well as knowledge of how a civ game works. I will not assume knowledge of the Civ 5 dll or the civ 4 dll, which was very similar architecture-wise.

=Compiling the DLL=

The DLL source comes with solutions for Visual Studio 2008, 2010, and 2012 (the 2012 one also compiles in 2013). However the project requires the VC++ 2008 toolchain. Since Visual Studio 2008 is a slightly outdated IDE it doesn't have the best features, so you should install Visual C++ 2008 Express and Visual C++ 2013 express to get the best development experience. If you don't want to do that just developing in VC2008 is fine as well. Any of the paid versions of Visual studio from these years will also work. Both of the express ones can be downloaded for free from Microsoft's website.

Once you have your IDE(s) installed you only need to make one change to make the DLL compile. In CvGameCoreDLL.rc for each project (there are 3, one for each dll) you need to change the reference to afxres.h to windows.h. After this simply build (you may need to clean first) and you should get 3 dlls, one for vanilla, G&K, and BNW. Note, you can safely remove the projects for versions your mod will not support (ie, you can only have it build the BNW dll).

To add a new DLL to a mod, open up ModBuddy, and right click your mod project and select 'Add existing item'. Navigate to the output folder from Visual Studio and select the DLL file, then click 'add'. After this you need to set import to VFS for true for the DLL, and when your mod loads it should also tell the Civilization 5 exe to unload the normal DLL and load yours.

=Basic Civ 5 DLL Architecture=

The civilization 5 DLL has a lot of code in it and can be confusing to a newcomer. In this section I will endeavor to give a 30000 foot overview of the internals of the DLL.

The Game Objects: The Civilization 5 game is represented by a few major classes.

'''CvGame:''' This class is the current game in progress. It contains basic info about the game, such as the settings used to create the game. It also does game-level things such as track score and check for winners, among other things.

'''CvMap:''' This class contains the game map. It contains all of the CvPlots, as well as map-wide methods, such as the areas visible, the areas which contain water, the number of owned plots, etc.

'''CvPlot:''' This is one hex tile in the game map. It contains enough data to describe what it is (terrain, features, improvements, resources, etc). It is also referenced by all location-based game objects and functions, so if you are making any edits to location based game mechanics you will need to edit CvPlot to be aware of these mechanics.

'''CvPlayer:''' This is a human or AI player. If AI, it owns all of the AI objects. NOTE: Any player-wide effects you want to add should normally be handled through CvTeam, which deals with permanent allies and other instances of multiple civs working together. CvPlayer should only be used if you want to expressly want the effect to only be on one civ.

'''CvCity:''' This is one city. It (through other objects) handles all buildings inside it, and processes many different effects. It also is responsible for ensuring that construction of anything is properly handled.

'''CvUnit:''' This is a unit. It mainly contains info about itself and it's situation. It is also responsible for moving itself around and performing actions on it's environment. It is NOT responsible for combat. See CvUnitCombat if you really want to mess with combat mechanics.

These are far from the only objects, and each of these objects is more complex than this. This is only meant as a top-level overview for new dll coders on where to go if you want to do certain things. Later I will explain how these interact with the data loading code when I write about new XML/SQL items.

=Creating a new boolean XML tag/SQL column=

Coming Soon...

=Creating a new integer/floating point value XML tag/SQL column=

Coming Soon...

=Creating a new multi-level XML tag/SQL column=

Coming Soon...

=Debugging your custom DLL=

Coming Soon...

=Advanced Tips and Tricks=

Coming Soon...

Player.InitUnit (Civ5 API)

2014-02-21T20:51:04Z

Slserpent: cleanup

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Player}}. 
This is an instance method, invoke it with a colon. 
}}

Creates a new unit for the calling player. Note: Using this function in a map script may crash WorldBuilder.

=Usage=
<code>{{Type5|Unit}} Player:InitUnit({{Type5|UnitType}} unit, '''int''' x, '''int''' y, {{Type5|UnitAIType}} unitAI = NO_UNITAI, {{Type5|DirectionType}} facingDirection = NO_DIRECTION)</code>

'''Returned Value'''
:Returns a reference to the created unit.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The {{Type5|UnitType}} ID of the unit to be created.''
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The X coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''The Y coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|unitAI:
|valign="top"| ''Optional. The AI tactics for the unit to use upon being created. If not specified, it will be the default AI for this unit type.''
|-
|valign="top" style="padding-right:6px;"|facingDirection:
|valign="top"| ''Optional. The direction for the newly created unit to be facing. If not specified, it will be random.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 350 are listed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">unit = pLoopPlayer:InitUnit (iUnitID, pLoopPlayer:GetStartingPlot():GetX(), pLoopPlayer:GetStartingPlot():GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0413}}<syntaxhighlight lang="lua">pPlayer:InitUnit (iUnitID, adjacentPlot:GetX(), adjacentPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, playerStartPlot:GetX(), playerStartPlot:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0545}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 36, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0549}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 37, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0553}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 38, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0561}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 40, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0599}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 21, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0607}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 19, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0615}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 19, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0623}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 53, 21, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0653}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 31, 34, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0665}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 29, 33, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0669}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 30, 34, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 50, 11, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0701}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 13, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0713}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 11, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/SteampunkScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0850}}<syntaxhighlight lang="lua">local pUnit = pPlayer:InitUnit(eUnitType, pPlot:GetX(), pPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0378}}<syntaxhighlight lang="lua">unit = newPlayer:InitUnit(iUnitID, iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1309}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 20, 47); -- Legion @ Lutetia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1323}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_BALLISTA"], 26, 49); -- Ballista @ Trier</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1330}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 22, 42); -- Horseman @ Lugundium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1344}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 49, 34); -- Archer @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1346}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 75, 26); -- Archer @ Melitene</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1352}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 76, 21); -- Catapult @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1358}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 76, 21); -- Legion @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1369}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 49, 34); -- Cataphract @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1371}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 71, 30); -- Cataphract @ Amasia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1388}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 81, 33); -- Swordsman @ Anium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1413}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 79, 24); -- Swordsman @ Amida</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1432}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 84, 58); -- Horseman @ Attila's Court -- extra to encourage an attack</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1442}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_HORSE_ARCHER"], 84, 58); -- Horse archer @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1448}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_BATTERING_RAM"], 84, 58); -- battering ram! @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1476}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 17, 57); -- Bowman @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1480}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 17, 57); -- Catapult @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1528}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 32, 54); -- Bowman @ Tongres</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1556}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_GOTH_GADRAUHT"], 50, 37); -- Gadrauht @ ERE border</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1586}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 4, 19); -- Bowman @ Caput Vada -- added to get army up to city-attacking size</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1592}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CARTHAGINIAN_QUINQUEREME"], 4, 19); -- Tri @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1594}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_VANDAL_AXEMAN"], 4, 19); -- Axeman @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1600}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 4, 19); -- Catapult @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1816}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1819}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2018}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CELT_PICTISH_WARRIOR"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2108}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_FRANK_SEAXMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1064}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1276}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_WORKER, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1300}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_GENERAL, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1612}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_SETTLE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldView.lua}}
:<code>UI/InGame/WorldView/WorldView.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0264}}<syntaxhighlight lang="lua">pActivePlayer:InitUnit(iUnitID, plotX, plotY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|InitUnit]]
[[Category:Civ5 Units API|InitUnit]]

GameEvents.UnitSetXY (Civ5 API)

2014-02-21T20:47:55Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

Triggered whenever any unit moves by any means, for every tile they move into. This includes units that are being created. Note that this event fires before animations are completed.

=Usage=
<code>'''void''' GameEvents.UnitSetXY({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>

'''Event Type'''
:Unknown

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''The ID of the player the unit belongs to.''
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The ID of the unit.''
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The location of the plot the unit has moved into.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''No description available.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 3 are listed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0130}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(function(iPlayer, iUnitID, iX, iY)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">local plot = Map.GetPlot(iX, iY);</syntaxhighlight>
{{CodeLine5|0133}}<syntaxhighlight lang="lua">local player = Players[iPlayer];</syntaxhighlight>
{{CodeLine5|0134}}<syntaxhighlight lang="lua">local unit = player:GetUnitByID(iUnitID);</syntaxhighlight>
{{CodeLine5|0135}}<syntaxhighlight lang="lua">if (unit == nil or unit:IsDelayedDeath()) then</syntaxhighlight>
{{CodeLine5|0136}}<syntaxhighlight lang="lua">return false;</syntaxhighlight>
{{CodeLine5|0137}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0139}}<syntaxhighlight lang="lua">-- Caravel that has reached China?</syntaxhighlight>
{{CodeLine5|0140}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_CARAVEL"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0142}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0143}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0145}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian()) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0147}}<syntaxhighlight lang="lua">if(iPlayer == Game.GetActivePlayer()) then</syntaxhighlight>
{{CodeLine5|0148}}<syntaxhighlight lang="lua">UI.UnlockAchievement("ACHIEVEMENT_SCENARIO_02_ROUTE_TO_ORIENT");</syntaxhighlight>
{{CodeLine5|0149}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0151}}<syntaxhighlight lang="lua">-- How many have already been? (KLUDGE - using an unused modern era CvGame data field as a counter)</syntaxhighlight>
{{CodeLine5|0152}}<syntaxhighlight lang="lua">local iTotalCircumnavigators = Game:GetNukesExploded();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0154}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators < 3) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0156}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0158}}<syntaxhighlight lang="lua">local iGoldReceived;</syntaxhighlight>
{{CodeLine5|0159}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0161}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0162}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators == 0) then</syntaxhighlight>
{{CodeLine5|0163}}<syntaxhighlight lang="lua">iGoldReceived = 200;</syntaxhighlight>
{{CodeLine5|0164}}<syntaxhighlight lang="lua">iVPReceived = 200;</syntaxhighlight>
{{CodeLine5|0165}}<syntaxhighlight lang="lua">elseif (iTotalCircumnavigators == 1) then</syntaxhighlight>
{{CodeLine5|0166}}<syntaxhighlight lang="lua">iGoldReceived = 100;</syntaxhighlight>
{{CodeLine5|0167}}<syntaxhighlight lang="lua">iVPReceived = 100;</syntaxhighlight>
{{CodeLine5|0168}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0169}}<syntaxhighlight lang="lua">iGoldReceived = 50;</syntaxhighlight>
{{CodeLine5|0170}}<syntaxhighlight lang="lua">iVPReceived = 50;</syntaxhighlight>
{{CodeLine5|0171}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0173}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0174}}<syntaxhighlight lang="lua">local iNumWondersToCredit = iVPReceived / GameDefines["SCORE_WONDER_MULTIPLIER"];</syntaxhighlight>
{{CodeLine5|0175}}<syntaxhighlight lang="lua">player:ChangeNumWorldWonders( iNumWondersToCredit );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0177}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0178}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0179}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0180}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0181}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0183}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0184}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0185}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators == 0) then</syntaxhighlight>
{{CodeLine5|0186}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_FIRST_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0187}}<syntaxhighlight lang="lua">elseif (iTotalCircumnavigators == 1) then</syntaxhighlight>
{{CodeLine5|0188}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_SECOND_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0189}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0190}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_THIRD_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0191}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0192}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0193}}<syntaxhighlight lang="lua">local iRemaining = 2 - iTotalCircumnavigators;</syntaxhighlight>
{{CodeLine5|0194}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_OTHER_CIRCUMNAVIGATION", player:GetName(), iRemaining);</syntaxhighlight>
{{CodeLine5|0195}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0197}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0199}}<syntaxhighlight lang="lua">Game:ChangeNukesExploded(1);</syntaxhighlight>
{{CodeLine5|0200}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0201}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0202}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0204}}<syntaxhighlight lang="lua">-- Treasure unit that has reached capital?</syntaxhighlight>
{{CodeLine5|0205}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_TREASURE"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0207}}<syntaxhighlight lang="lua">-- At my capital?</syntaxhighlight>
{{CodeLine5|0208}}<syntaxhighlight lang="lua">local capital = player:GetCapitalCity();</syntaxhighlight>
{{CodeLine5|0209}}<syntaxhighlight lang="lua">if (capital ~= nil and capital:GetX() == iX and capital:GetY() == iY) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0211}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0213}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0214}}<syntaxhighlight lang="lua">local iGoldReceived = 100;</syntaxhighlight>
{{CodeLine5|0215}}<syntaxhighlight lang="lua">local iVPReceived = 50;</syntaxhighlight>
{{CodeLine5|0216}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0217}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0219}}<syntaxhighlight lang="lua">-- Put out notification</syntaxhighlight>
{{CodeLine5|0220}}<syntaxhighlight lang="lua">local text;</syntaxhighlight>
{{CodeLine5|0221}}<syntaxhighlight lang="lua">local heading;</syntaxhighlight>
{{CodeLine5|0222}}<syntaxhighlight lang="lua">text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_TREASURE_RETURNED", capital:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0223}}<syntaxhighlight lang="lua">heading = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_TREASURE_RETURNED_SHORT");</syntaxhighlight>
{{CodeLine5|0224}}<syntaxhighlight lang="lua">player:AddNotification(NotificationTypes.NOTIFICATION_GENERIC, text, heading);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0226}}<syntaxhighlight lang="lua">if(iPlayer == Game.GetActivePlayer()) then</syntaxhighlight>
{{CodeLine5|0227}}<syntaxhighlight lang="lua">if(capital:GetX() > 50) then</syntaxhighlight>
{{CodeLine5|0228}}<syntaxhighlight lang="lua">UI.UnlockAchievement("ACHIEVEMENT_SCENARIO_02_RETURN_TREASURE");</syntaxhighlight>
{{CodeLine5|0229}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0230}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0231}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0232}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0234}}<syntaxhighlight lang="lua">return true;</syntaxhighlight>
{{CodeLine5|0235}}<syntaxhighlight lang="lua">end);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1030}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(UpdatePromotion);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0594}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(function(iPlayer, iUnitID, iX, iY)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0596}}<syntaxhighlight lang="lua">local plot = Map.GetPlot(iX, iY);</syntaxhighlight>
{{CodeLine5|0597}}<syntaxhighlight lang="lua">local player = Players[iPlayer];</syntaxhighlight>
{{CodeLine5|0598}}<syntaxhighlight lang="lua">local unit = player:GetUnitByID(iUnitID);</syntaxhighlight>
{{CodeLine5|0599}}<syntaxhighlight lang="lua">if (unit == nil or unit:IsDelayedDeath()) then</syntaxhighlight>
{{CodeLine5|0600}}<syntaxhighlight lang="lua">return false;</syntaxhighlight>
{{CodeLine5|0601}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0602}}<syntaxhighlight lang="lua">local iNumCaravels = GetPersistentProperty("NumCaravels");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0604}}<syntaxhighlight lang="lua">-- Caravel that has reached China?</syntaxhighlight>
{{CodeLine5|0605}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_CARAVEL"] and iNumCaravels < 5) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0607}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0608}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0610}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian()) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0612}}<syntaxhighlight lang="lua">-- How many have already been?</syntaxhighlight>
{{CodeLine5|0613}}<syntaxhighlight lang="lua">iNumCaravels = iNumCaravels + 1;</syntaxhighlight>
{{CodeLine5|0614}}<syntaxhighlight lang="lua">SetPersistentProperty("NumCaravels", iNumCaravels);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0616}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0618}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0620}}<syntaxhighlight lang="lua">-- Grant VP</syntaxhighlight>
{{CodeLine5|0621}}<syntaxhighlight lang="lua">iVPReceived = 600 - (iNumCaravels * 100);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0623}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0625}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0626}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0627}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0628}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0629}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0631}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0632}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0633}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_CARAVEL", unit:GetName(), iVPReceived, (5 - iNumCaravels));</syntaxhighlight>
{{CodeLine5|0634}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0635}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0636}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_OTHER_CARAVEL", player:GetName(), iVPReceived, (5 - iNumCaravels));</syntaxhighlight>
{{CodeLine5|0637}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0638}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0639}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0640}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0642}}<syntaxhighlight lang="lua">-- Conquistador that has reached China?</syntaxhighlight>
{{CodeLine5|0643}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_SPANISH_CONQUISTADOR"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0645}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0646}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0648}}<syntaxhighlight lang="lua">-- How many have already been?</syntaxhighlight>
{{CodeLine5|0649}}<syntaxhighlight lang="lua">local iNumConquistadors = GetPersistentProperty("NumConquistadors");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0651}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian() and iNumConquistadors < 3) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0653}}<syntaxhighlight lang="lua">local pTeam;</syntaxhighlight>
{{CodeLine5|0654}}<syntaxhighlight lang="lua">pTeam = Teams[player:GetTeam()];</syntaxhighlight>
{{CodeLine5|0655}}<syntaxhighlight lang="lua">if (pTeam:IsHasTech(GameInfoTypes["TECH_EXPLORATION"])) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0657}}<syntaxhighlight lang="lua">iNumConquistadors = iNumConquistadors + 1;</syntaxhighlight>
{{CodeLine5|0658}}<syntaxhighlight lang="lua">SetPersistentProperty("NumConquistadors", iNumConquistadors);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0660}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0662}}<syntaxhighlight lang="lua">local iGoldReceived;</syntaxhighlight>
{{CodeLine5|0663}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0665}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0666}}<syntaxhighlight lang="lua">iGoldReceived = 500;</syntaxhighlight>
{{CodeLine5|0667}}<syntaxhighlight lang="lua">iVPReceived = 250;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0669}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0670}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0672}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0673}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0674}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0675}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0676}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0678}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0679}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0680}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_CONQUISTADOR", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0681}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0682}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0683}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0684}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0685}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0687}}<syntaxhighlight lang="lua">return true;</syntaxhighlight>
{{CodeLine5|0688}}<syntaxhighlight lang="lua">end);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|UnitSetXY]]
[[Category:Civ5 Units API|UnitSetXY]]

Unit (Civ5 Type)

2014-02-21T19:09:45Z

Slserpent: /* G */ getx and gety return type

{{Civ5 API Beta Banner}}
''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 <code>caller:SomeMethod(<args>)</code>, where ''caller'' is an instance of Unit. 
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: <code>caller.SomeMethod(caller, <args>)</code>
==A==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|AirSweepCombatMod}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|At}}('''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|AtPlot}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|AttackFortifiedModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|AttackWoundedModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|AttackXPValue}}()</code>
|}

==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAcquirePromotion}}({{Type5|PromotionType}} promotion)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAcquirePromotionAny}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAirAttack}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAirDefend}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAirlift}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAirliftAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAirPatrol}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanAutomate}}({{Type5|AutomateType}} automate)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanBuild}}({{Type5|Plot}} plot, {{Type5|BuildActionType}} build, '''bool''' testVisible = false, '''bool''' testGold = true)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanBuildRoute}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanBuildSpaceship}}({{Type5|Plot}} plot, '''bool''' visible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanCargoAllMove}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanCoexistWithEnemyUnit}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanConstruct}}({{Type5|Plot}} plot, {{Type5|BuildingType}} building)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanDiscover}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanDisembark}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanDisembarkOnto}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanDistanceGift}}({{Type5|TaskType}} toPlayer)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanDoCommand}}({{Type5|CommandType}} command, '''int''' data1, '''int''' data2, '''bool''' testVisible = false, '''bool''' testBusy = true)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanEmbark}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanEmbarkOnto}}({{Type5|Plot}} plot, {{Type5|Plot}} targetPlot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanEnterTerritory}}({{Type5|TeamID}} team, '''bool''' ignoreRightOfPassage = false, '''bool''' isCity = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanFortify}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanFound}}({{Type5|Plot}} plot, '''bool''' testVisible = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanGift}}('''bool''' testVisible = false, '''bool''' testTransport = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanGiveExperience}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanGoldenAge}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanHeal}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanHold}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanJoin}}({{Type5|Plot}} plot, {{Type5|SpecialistType}} specialist)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanLead}}({{Type5|Plot}} plot, '''int''' unitId)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanLoad}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanLoadUnit}}({{Type5|Unit}} unit, {{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanMove}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanMoveAllTerrain}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanMoveImpassable}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanMoveOrAttackInto}}({{Type5|Plot}} plot, '''bool''' declareWar = false, '''bool''' destination = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanMoveThrough}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanNuke}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanNukeAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanParadrop}}({{Type5|Plot}} plot, '''bool''' arg1)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanParadropAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanPillage}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanPromote}}({{Type5|PromotionType}} promotion, '''int''' leaderUnitId)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanRangeStrike}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanRangeStrikeAt}}('''int''' x, '''int''' y, '''bool''' arg2 = nil, '''bool''' noncombatAllowed = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanRebaseAt}}({{Type5|Plot}} sourcePlot, '''int''' targetX, '''int''' targetY)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanRepairFleet}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanScrap}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanSentry}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanSetUpForRangedAttack}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanSiege}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanSleep}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanStartMission}}('''int''' mission, '''int''' data1, '''int''' data2, {{Type5|Plot}} plot = nil, '''bool''' testVisible = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanTrade}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanUnload}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanUnloadAll}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CanUpgradeRightNow}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CapitalDefenseFalloff}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CapitalDefenseModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CargoSpace}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CargoSpaceAvailable}}({{Type5|SpecialUnitType}} specialCargo, {{Type5|DomainType}} domainCargo)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|ChanceFirstStrikes}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ChangeCargoSpace}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ChangeDamage}}('''int''' change, {{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ChangeExperience}}('''int''' change, '''int''' max = -1, '''bool''' fromCombat = false, '''bool''' inBorders = false, '''bool''' updateGlobal = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ChangeLevel}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ChangeMoves}}('''int''' change)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CityAttackModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CityDefenseModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|Convert}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|CurrInterceptionProbability}}()</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|DefenseXPValue}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|DoCommand}}({{Type5|CommandType}} command, '''int''' data1, '''int''' data2)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|DomainType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|DomainCargo}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|DomainModifier}}({{Type5|DomainType}} domain)</code>
|}

==E==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|Embark}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|EvasionProbability}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|ExecuteSpecialExploreMove}}({{Type5|Plot}} targetPlot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|ExperienceNeeded}}()</code>
|}

==F==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FeatureAttackModifier}}({{Type5|FeatureType}} feature)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FeatureDefenseModifier}}({{Type5|FeatureType}} feature)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|FinishMoves}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FirstStrikes}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FlankAttackModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FlatMovementCost}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FlavorValue}}({{Type5|FlavorType}} flavor)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|FortifyModifier}}()</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GeneratePath}}({{Type5|Plot}} toPlot, '''int''' flags = 0, '''bool''' reuse = false, '''unknown''' piPathTurns = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ActivityType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetActivityType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetAdjacentModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetAdjacentTileHeal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetAirCombatDamage}}({{Type5|Unit}} defender)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetAmphibCount}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|Area}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetArea}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetAttackModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBaseCombatStrength}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBaseRangedCombatStrength}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBestInterceptor}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBestSeaPillageInterceptor}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBlitzCount}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|BuildActionType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetBuildType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCaptureUnitType}}({{Type5|CivilizationType}} civilization)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCargo}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|CivilizationType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCivilizationType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCombatDamage}}('''int''' strength, '''int''' opponentStrength, '''int''' currentDamage, '''bool''' includeRand = true, '''bool''' attackerIsCity = false, '''bool''' defenderIsCity = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCombatLimit}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCombatOwner}}({{Type5|TeamID}} forTeam)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetConversionStrength}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetCurrHitPoints}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetDamage}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetDeclareWarRangeStrike}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetDefenseModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|DomainType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetDomainType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetDropRange}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetEmbarkedUnitDefense}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExperience}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExperiencePercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraAttackFortifiedMod}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraAttackWoundedMod}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraChanceFirstStrikes}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraCityAttackPercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraCityDefensePercent}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraCombatPercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraDomainModifier}}({{Type5|DomainType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraEnemyHeal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraEvasion}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraFeatureAttackPercent}}({{Type5|FeatureType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraFeatureDefensePercent}}({{Type5|FeatureType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraFirstStrikes}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraFriendlyHeal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraHillsAttackPercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraHillsDefensePercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraIntercept}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraMoveDiscount}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraMoves}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraNeutralHeal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraOpenAttackPercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraOpenDefensePercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraOpenRangedAttackMod}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraRange}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraRoughAttackPercent}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraRoughRangedAttackMod}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraTerrainAttackPercent}}({{Type5|TerrainType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraTerrainDefensePercent}}({{Type5|TerrainType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraUnitCombatModifier}}({{Type5|UnitCombatType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraVisibilityRange}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetExtraWithdrawal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetFacingDirection}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Unit}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetFireSupportUnit}}({{Type5|PlayerID}} defender, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetFortifyTurns}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetFriendlyLandsAttackModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetFriendlyLandsModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetGameTurnCreated}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetGarrisonedCity}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetGoldenAgeTurns}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetGreatGeneralCombatModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|HandicapType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetHandicapType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetHotKeyNumber}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitID}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetID}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|InvisibilityScopeType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetInvisibleType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetKamikazePercent}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetLastMoveTurn}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetLeaderUnitType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetLevel}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ReligionType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMajorityReligionAfterSpread}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMaxAttackStrength}}({{Type5|Plot}} fromPlot, {{Type5|Plot}} toPlot, {{Type5|Unit}} defender)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMaxDefenseStrength}}({{Type5|Plot}} inPlot, {{Type5|Unit}} attacker, '''bool''' arg2 = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMaxHitPoints}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMaxRangedCombatStrength}}({{Type5|Unit}} other, '''int''' attacking, '''bool''' arg2, '''bool''' arg3)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetMoves}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetName}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNameKey}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNameNoDesc}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNearbyImprovementModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNumEnemyUnitsAdjacent}}({{Type5|Unit}} otherUnit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNumFollowersAfterSpread}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetNumResourceNeededToUpgrade}}({{Type5|ResourceType}} resourceLoop)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetOriginalOwner}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetOutsideFriendlyLandsModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlayerID}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetOwner}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetPathEndTurnPlot}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetPillageChange}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetPlot}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetRangeCombatDamage}}({{Type5|Unit}} defender, {{Type5|City}} city, '''bool''' includeRand)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetRangedAttackModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetRangedCombatLimit}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetReconPlot}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ReligionType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetReligion}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetReverseGreatGeneralModifier}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetRiverCrossingNoPenaltyCount}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetSameTileHeal}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetScenarioData}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetScrapGold}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetScriptData}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|InvisibilityScopeType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetSeeInvisibleType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|SpecialUnitType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetSpecialUnitType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetSpreadsLeft}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetStrategicResourceCombatPenalty}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetTeam}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetTradeGold}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetTransportUnit}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitAICargo}}({{Type5|UnitAIType}} unitAI)</code>

|-
{{FuncInfos5|yes |yes |yes|}}
|align="right" |<code>{{Type5|UnitAIType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitAIType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitClassModifier}}({{Type5|UnitClassType}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitClassType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitClassType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitCombatType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitCombatType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitFlagIconOffset}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitPortraitOffset}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUnitType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUpgradeDiscount}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Unit}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUpgradeUnitFromPlot}}({{Type5|Plot}} adjacentPlot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|UnitType}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetUpgradeUnitType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetVisualOwner}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetX}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GetY}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|GiveExperience}}()</code>
|}

==H==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|HasCargo}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|HasMoved}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|HasName}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|HillsAttackModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|HillsDefenseModifier}}()</code>
|}

==I==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IgnoreBuildingDefense}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IgnoreTerrainCost}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|ImmuneToFirstStrikes}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsActionRecommended}}({{Type5|ActionType}} action)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsAlwaysHeal}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsAmphib}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsAttacking}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsAutomated}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsBarbarian}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsBetterDefenderThan}}({{Type5|Unit}} defender, {{Type5|Unit}} attacker)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsBlitz}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsBusy}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCanAttack}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCanAttackRanged}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCanAttackWithMove}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCanAttackWithMoveNow}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCanDefend}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCargo}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCityAttackOnly}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsCombatUnit}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsDead}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsDefending}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsDelayedDeath}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsEmbarked}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsEnemyCityAdjacent}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsEnemyInMovementRange}}('''bool''' arg0, '''bool''' arg1)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsEnemyRoute}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsEverFortifyable}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFeatureDoubleMove}}({{Type5|FeatureType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFighting}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFortifyable}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFound}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFriendlyUnitAdjacent}}('''bool''' combatUnit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsFull}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsGarrisoned}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsGoldenAge}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsGreatPerson}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHasPromotion}}({{Type5|PromotionType}} promotion)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHealOutsideFriendly}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHigherTechThan}}({{Type5|UnitType}} arg0)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHillsDoubleMove}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHuman}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsHurt}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsImmobile}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsInCombat}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsInvisible}}({{Type5|TeamID}} team, '''bool''' debug, '''bool''' checkCargo = false)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsLargerCivThan}}({{Type5|Unit}} myUnit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsMustSetUpToRangedAttack}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNearGreatGeneral}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNeverInvisible}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNoBadGoodies}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNoCapture}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNone}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNukeImmune}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsNukeVictim}}({{Type5|Plot}} plot, {{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsOnlyDefensive}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsOutOfAttacks}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|isOutOfInterceptions}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsPromotionReady}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsPromotionValid}}({{Type5|PromotionType}} promotion)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsRangeAttackIgnoreLOS}}({{Type5|Plot}} plot)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsRangeAttackOnlyInDomain}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsRanged}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsReadyToMove}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsRivalTerritory}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsRiverCrossingNoPenalty}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsSelected}}('''unknown''' void)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsSetUpForRangedAttack}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsStackedGreatGeneral}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsTerrainDoubleMove}}({{Type5|TerrainType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsWaiting}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|IsWork}}()</code>
|}

==J==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|JumpToNearestValidPlot}}()</code>
|}

==K==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|Kill}}('''bool''' delay, {{Type5|PlayerID}} player = NO_PLAYER)</code>
|}

==L==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|LastMissionPlot}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|Lead}}('''int''' unitId)</code>
|}

==M==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|MaxFirstStrikes}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|MaxInterceptionProbability}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|MaxMoves}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|MaxXPValue}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|MovesLeft}}()</code>
|}

==N==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|NoDefensiveBonus}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|NukeDamageLevel}}()</code>
|}

==O==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|OpenAttackModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|OpenDefenseModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|OpenRangedAttackModifier}}()</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|PopMission}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|Promote}}({{Type5|PromotionType}} promotion, '''int''' leaderUnitId)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|PushMission}}({{Type5|MissionType}} mission, '''int''' data1 = -1, '''int''' data2 = -1, '''int''' flags = 0, '''bool''' append = false, '''bool''' manual = fa;se, {{Type5|MissionType}} missionAI = NO_MISSIONAI, {{Type5|Plot}} missionAIPlot = nil, {{Type5|Unit}} missionAIUnit = nil)</code>
|}

==R==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|Range}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|RangeStrike}}('''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|RotateFacingDirectionClockwise}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|RotateFacingDirectionCounterClockwise}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|RoughAttackModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|RoughDefenseModifier}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|RoughRangedAttackModifier}}()</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetBaseCombatStrength}}('''int''' combat)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetDamage}}('''int''' newValue, {{Type5|PlayerID}} player, '''bool''' notifyEntity = true)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetDeployFromOperationTurn}}('''int''' arg0)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetEmbarked}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetExperience}}('''int''' newValue, '''int''' max = -1)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetHasPromotion}}({{Type5|PromotionType}} index, '''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetHotKeyNumber}}('''int''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetLeaderUnitType}}({{Type5|UnitType}} leaderUnitType)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetLevel}}('''int''' newLevel)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetMadeAttack}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetMadeInterception}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetMoves}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetName}}('''string''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetOriginalOwner}}({{Type5|PlayerID}} oldOwner)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetPromotionReady}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetReconPlot}}({{Type5|Plot}} newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|SetScenarioData}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetScriptData}}('''string''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Unit|SetXY}}('''int''' x, '''int''' y, '''bool''' group = false, '''bool''' update = true, '''bool''' show = false, '''bool''' checkPlotVisible = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Unit|SpecialCargo}}</code>
|}

==T==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|TerrainAttackModifier}}({{Type5|TerrainType}} terrain)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|TerrainDefenseModifier}}({{Type5|TerrainType}} terrain)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|UnitClassAttackModifier}}({{Type5|UnitClassType}} unitClass)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|UnitClassDefenseModifier}}({{Type5|UnitClassType}} unitClass)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|UnitCombatModifier}}({{Type5|UnitCombatType}} unitCombat)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|UpgradePrice}}({{Type5|UnitType}} unit)</code>
|}

==V==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|VisibilityRange}}()</code>
|}

==W==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|WithdrawalProbability}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Unit|WorkRate}}('''bool''' max, {{Type5|BuildActionType}} build = nil)</code>
|}

=Used by=
{|cellspacing="4" cellpadding="0" width="100%" style="background-color:#F0F0F0"

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|AddProductionExperience}}({{Type5|Unit}} unit, '''bool''' conscript = false)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetGarrisonedUnit}}()</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|RangeCombatDamage}}({{Type5|Unit}} theirUnit, '''unknown''' arg1)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|RangeCombatUnitDefense}}({{Type5|Unit}} theirUnit)</code>

|-
|align="right" width="200" |<code>{{Type5|CombatPredictionType}}</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|GetCombatPrediction}}({{Type5|Unit}} myUnit, {{Type5|Unit}} theirUnit)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CanReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CreateGreatGeneral}}({{Type5|Unit}} eGreatPersonUnit, '''bool''' incrementThreshold, '''bool''' incrementExperience, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|DoGoody}}({{Type5|Plot}} plot, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetFirstReadyUnit}}()</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetUnitByID}}({{Type5|UnitID}} unit)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|InitUnit}}({{Type5|UnitType}} unit, {{Type5|ResourceType}} x, {{Type5|ResourceType}} y, {{Type5|UnitAIType}} unitAI = NO_UNITAI, {{Type5|DirectionType}} facingDirection = NO_DIRECTION)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|ReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>iterator({{Type5|Unit}})</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|Units}}()</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetBestDefender}}({{Type5|PlayerID}} owner, {{Type5|PlayerID}} attackingPlayer, {{Type5|Unit}} attacker, '''bool''' testAtWar, '''bool''' testPotentialEnemy, '''bool''' testCanMove)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetNumFriendlyUnitsOfType}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetNumVisibleEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetNumVisiblePotentialEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetUnit}}({{Type5|UnitID}} id)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|IsEnemyCity}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|IsFriendlyCity}}({{Type5|Unit}} unit, '''bool''' checkImprovement)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|IsValidDomainForAction}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|IsValidDomainForLocation}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|IsVisibleEnemyDefender}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|MovementCost}}({{Type5|Unit}} unit, {{Type5|Plot}} fromPlot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|NukeExplosion}}('''int''' range, {{Type5|Unit}} nukeUnit)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|GetHeadSelectedUnit}}()</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|HighlightCanPlacePlots}}({{Type5|Unit}} unit, {{Type5|Plot}} arg1)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|SelectUnit}}({{Type5|Unit}} v)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|SetPlaceUnit}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLoadUnit}}({{Type5|Unit}} unit, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|Convert}}({{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetAirCombatDamage}}({{Type5|Unit}} defender)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetFireSupportUnit}}({{Type5|PlayerID}} defender, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxAttackStrength}}({{Type5|Plot}} fromPlot, {{Type5|Plot}} toPlot, {{Type5|Unit}} defender)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxDefenseStrength}}({{Type5|Plot}} inPlot, {{Type5|Unit}} attacker, '''bool''' arg2 = nil)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxRangedCombatStrength}}({{Type5|Unit}} other, '''int''' attacking, '''bool''' arg2, '''bool''' arg3)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetNumEnemyUnitsAdjacent}}({{Type5|Unit}} otherUnit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetRangeCombatDamage}}({{Type5|Unit}} defender, {{Type5|City}} city, '''bool''' includeRand)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetUpgradeUnitFromPlot}}({{Type5|Plot}} adjacentPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsBetterDefenderThan}}({{Type5|Unit}} defender, {{Type5|Unit}} attacker)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsLargerCivThan}}({{Type5|Unit}} myUnit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|PushMission}}({{Type5|MissionType}} mission, '''int''' data1 = -1, '''int''' data2 = -1, '''int''' flags = 0, '''bool''' append = false, '''bool''' manual = fa;se, {{Type5|MissionType}} missionAI = NO_MISSIONAI, {{Type5|Plot}} missionAIPlot = nil, {{Type5|Unit}} missionAIUnit = nil)</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|Unit]]

Unit.GetY (Civ5 API)

2014-02-21T19:08:32Z

Slserpent: /* Usage */ wrong return type

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Unit}}. 
This is an instance method, invoke it with a colon.
}}

=Usage=
<code>'''int''' Unit:GetY()</code>

'''Returned Value'''
:No description available.

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|Bombardment.lua}}
:<code>UI/InGame/Bombardment.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0035}}<syntaxhighlight lang="lua">thisY = pHeadSelectedUnit:GetY();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0193}}<syntaxhighlight lang="lua">Events.SpawnArrowEvent( attacker:GetX(), attacker:GetY(), hexX, hexY );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|EnemyUnitPanel.lua (G&K)}}
:<code>DLC/Expansion/UI/InGame/WorldView/EnemyUnitPanel.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0931}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), pMyUnit:GetX(), pMyUnit:GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1480}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), pTheirUnit:GetX(), pTheirUnit:GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1821}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), theirUnit:GetX(), theirUnit:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InGame.lua}}
:<code>UI/InGame/InGame.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0422}}<syntaxhighlight lang="lua">local hexID = ToHexFromGrid( Vector2( unit:GetX(), unit:GetY() ) );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0451}}<syntaxhighlight lang="lua">local unitY = unit:GetY();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0545}}<syntaxhighlight lang="lua">local thisY = pHeadSelectedUnit:GetY();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0999}}<syntaxhighlight lang="lua">Events.RequestYieldDisplay( YieldDisplayTypes.AREA, 2, unit:GetX(), unit:GetY() );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0543}}<syntaxhighlight lang="lua">if (pUnit:GetY() < 11 or pUnit:GetY() > 69) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0556}}<syntaxhighlight lang="lua">iDistance = Map.PlotDistance(1, iY, pUnit:GetX(), pUnit:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0201}}<syntaxhighlight lang="lua">iY = unit:GetY();</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|UnitFlagManager.lua}}
:<code>UI/InGame/UnitFlagManager.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0242}}<syntaxhighlight lang="lua">local worldPosX, worldPosY, worldPosZ = GridToWorld( pUnit:GetX(), pUnit:GetY() );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1409}}<syntaxhighlight lang="lua">local plot = Map.GetPlot( unit:GetX(), unit:GetY() );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|UnitPanel.lua}}
:<code>UI/InGame/WorldView/UnitPanel.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0745}}<syntaxhighlight lang="lua">y = unit and unit:GetY() or 0,</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GetY]]

Unit.GetX (Civ5 API)

2014-02-21T19:07:58Z

Slserpent: /* Usage */ wrong return type

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Unit}}. 
This is an instance method, invoke it with a colon.
}}

=Usage=
<code>'''int''' Unit:GetX()</code>

'''Returned Value'''
:No description available.

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|Bombardment.lua}}
:<code>UI/InGame/Bombardment.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0034}}<syntaxhighlight lang="lua">thisX = pHeadSelectedUnit:GetX();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0193}}<syntaxhighlight lang="lua">Events.SpawnArrowEvent( attacker:GetX(), attacker:GetY(), hexX, hexY );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|EnemyUnitPanel.lua (G&K)}}
:<code>DLC/Expansion/UI/InGame/WorldView/EnemyUnitPanel.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0931}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), pMyUnit:GetX(), pMyUnit:GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1480}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), pTheirUnit:GetX(), pTheirUnit:GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1821}}<syntaxhighlight lang="lua">local plotDistance = Map.PlotDistance(pCapital:GetX(), pCapital:GetY(), theirUnit:GetX(), theirUnit:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InGame.lua}}
:<code>UI/InGame/InGame.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0422}}<syntaxhighlight lang="lua">local hexID = ToHexFromGrid( Vector2( unit:GetX(), unit:GetY() ) );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0450}}<syntaxhighlight lang="lua">local unitX = unit:GetX();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0544}}<syntaxhighlight lang="lua">local thisX = pHeadSelectedUnit:GetX();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0999}}<syntaxhighlight lang="lua">Events.RequestYieldDisplay( YieldDisplayTypes.AREA, 2, unit:GetX(), unit:GetY() );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0538}}<syntaxhighlight lang="lua">if (pUnit:GetX() > 9) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0556}}<syntaxhighlight lang="lua">iDistance = Map.PlotDistance(1, iY, pUnit:GetX(), pUnit:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0200}}<syntaxhighlight lang="lua">iX = unit:GetX();</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|UnitFlagManager.lua}}
:<code>UI/InGame/UnitFlagManager.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0242}}<syntaxhighlight lang="lua">local worldPosX, worldPosY, worldPosZ = GridToWorld( pUnit:GetX(), pUnit:GetY() );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1409}}<syntaxhighlight lang="lua">local plot = Map.GetPlot( unit:GetX(), unit:GetY() );</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|UnitPanel.lua}}
:<code>UI/InGame/WorldView/UnitPanel.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0744}}<syntaxhighlight lang="lua">x = unit and unit:GetX() or 0,</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GetX]]

Unit.Convert (Civ5 API)

2014-02-21T02:56:01Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Unit}}. 
This is an instance method, invoke it with a colon.
}}

Copies the attributes of one unit to another before removing the former unit. Useful for replacing units such as when upgrading. Note that this function does not create the unit to copy to, however. To do this, first use {{Func5|Player|InitUnit}}.

=Usage=
<code>'''void''' Unit:Convert({{Type5|Unit}} unit)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The unit to be copied from and then removed.''
|}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Convert]]

Unit.Kill (Civ5 API)

2014-02-21T01:20:06Z

Slserpent: parameters from source comments

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Unit}}. 
This is an instance method, invoke it with a colon.
}}

Removes a unit from the game.

=Usage=
<code>'''void''' Unit:Kill('''bool''' delay = false, {{Type5|PlayerID}} player = NO_PLAYER)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|delay:
|valign="top"| ''If true, the unit will be partially cleaned up, but its final removal will happen at the end of the frame. But what use does this have?''
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''Player ID of the player that has killed this unit or -1 for no player.''
|}

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0156}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0207}}<syntaxhighlight lang="lua">unit:Kill();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0470}}<syntaxhighlight lang="lua">pPlot:GetUnit(0):Kill(true, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1043}}<syntaxhighlight lang="lua">pPlot:GetUnit(0):Kill(false, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1078}}<syntaxhighlight lang="lua">pUnit:Kill();</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Kill]]

GameEvents (Civ5 Type)

2014-02-21T01:10:19Z

Slserpent: adding some more events

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

= Usage =
This object exposes events that you can use to modify the gameplay. As opposed to the events defined on {{Type5|Events}} and {{Type5|LuaEvents}}, most of those events are expected to return a value. This value may then be used by the game to prevent or trigger some game actions (such as a declaration of war), or to override some calculations (for example by adding a bonus or a malus to the diplomatic status between two civilizations). Please look at the events' pages to learn more.

=Static Events=
Events can be subscribed by using <code>GameEvents.SomeEvent.Add(SomeFunction)</code>. Regular events can also be fired through a '''dot''' by using <code>GameEvents.SomeEvent(<args>)</code>. This will invoke all subscribers with the provided arguments. 
==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Allows provision of criteria for the ability to declare war. As this is a TestAll event, all listeners must return true for the action to be permitted. As wars are between teams, it is based entirely on teams rather than players (as far as can be inferred from scenario files).}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CanDeclareWar}}({{Type5|TeamID}} myTeam, {{Type5|TeamID}} theirTeam)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityBuildingsIsBuildingSellable}}({{Type5|PlayerID}} player, {{Type5|BuildingType}} building)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyAnyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, this allows provision of critera for the ability to construct a particular building (including Wonders, presumably) in a particular city. Based on the behaviour in the 1066 scenario, it seems that returns of false lead to the building not appearing in the list of buildings available to construct, rather than being greyed out, but this hasn't been specifically checked. It makes some sense, though, as there's no way to provide a tooltip to explain the greying out under this mechanism. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanCreate}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|ProjectType}} projectType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanMaintain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|ProcessType}} processType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanPrepare}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|SpecialistType}} specialistType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

|-
{{FuncInfos5|yes |yes |yes|This event is triggered when a city is captured. We may infer from the name that it is triggered when the capture has been completed, the city now shows as owned by the conqueror, and buildings have been destroyed (this has not been confirmed). We might hope that there is a matching event when the capture has been determined, but ownership not yet changed and buildings not yet destroyed, but have no information on this as yet.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCaptureComplete}}({{Type5|PlayerID}} player, '''int''' capital, {{Type5|ResourceType}} x, {{Type5|ResourceType}} y, {{Type5|PlayerID}} newPlayer, '''int''' conquest, '''int''' conquest)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityConvertsReligion}}({{Type5|PlayerID}} owner, {{Type5|ReligionType}} religion, '''int''' x, '''int''' y)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|DoResolveVictoryVote}}('''bool''' preliminaryVote)</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreTestVictory}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateBegin}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateEnd}}()</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetFounderBenefitsReligion}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetReligionToSpread}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier1}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier2}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerAdoptPolicy}}({{Type5|PlayerID}} player, '''int''' policyID)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanConstruct}}({{Type5|PlayerID}} player, {{Type5|BuildingType}} buildingType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanCreate}}({{Type5|PlayerID}} player, {{Type5|ProjectType}} projectType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanMaintain}}({{Type5|PlayerID}} player, {{Type5|ProcessType}} processType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanPrepare}}({{Type5|PlayerID}} player, {{Type5|SpecialistType}} specialistType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanResearch}}({{Type5|PlayerID}} player, {{Type5|TechType}} techType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanEverResearch}}({{Type5|PlayerID}} player, {{Type5|TechType}} techType)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanTrain}}({{Type5|PlayerID}} player, {{Type5|UnitType}} unitType)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCityFounded}}({{Type5|PlayerID}} player, '''int''' cityX, '''int''' cityY)</code>

|-
{{FuncInfos5|yes |yes |yes|Fired once per turn for each player (not just active/human player). Modder experimentation has found that it is fired at the start of turn; also, it seems not to run for the first turn of the game (for all players), runs only for human player on the second turn, and thereafter it runs for all players. There is no indication as to why this is.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerDoTurn}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|On list provided by User:Sseckman, but no references yet found in scenario Lua files.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerPreAIUnitUpdate}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|Called before most items in the game are initialized. Was once used in scenario scripts, a different strategy was used; unclear how easy it would be to get a listener registered before it fires. Apparently does not pass any parameters.}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PreGameStart}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when the ally of a City-State changes (whether it changes from none or from another player).}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetAlly}}({{Type5|PlayerID}} cSPlayer, {{Type5|PlayerID}} oldAlly, {{Type5|PlayerID}} newAlly)</code>

|-
{{FuncInfos5|yes |maybe|yes|Triggered whenever any city changes population. At least, as far as we know. Information provided by User:Sseckman calls this CitySetPopulation, but the scenario Lua files refer to SetPopulation.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetPopulation}}('''int''' x, '''int''' y, '''unknown''' oldPopulation, '''int''' newPopulation)</code>
|}

==T==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|maybe|yes|Presumably called when players meet, but referring to teams. Sample usages have not been found.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamMeet}}('''unknown''' playeractive, '''unknown''' playermet)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamSetHasTech}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''bool''' adopted)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when a team researches a tech.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamTechResearched}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''int''' change)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target. ====Listener Prototype==== listener(iPlayerID, iUnitID) *iPlayerID The ID of the player who issued the explore order. *iUnitID The ID of the unit the order was issued to.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitGetSpecialExploreTarget}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unitID)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitKilledInCombat}}({{Type5|PlayerID}} killer, {{Type5|PlayerID}} killee, {{Type5|UnitType}} killeeUnitType)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered whenever any unit moves by any means, for every tile they move into.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitSetXY}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>
|}

=Static Methods=
Methods are functions that belong to an object. Static methods are invoked through a '''dot''', as in <code>GameEvents.SomeMethod(<args>)</code>. When a dot is used the caller object is not implicitly provided as the first argument.
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Accumulate}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|AccumulateINT}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Add}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Call}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Count}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Remove}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|RemoveAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAny}}</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|GameEvents]]

GameEvents.GameCoreUpdateBegin (Civ5 API)

2014-02-20T18:49:52Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

This event fires about once every 100ms.

=Usage=
<code>'''void''' GameEvents.GameCoreUpdateBegin()</code>

'''Event Type'''
:Unknown

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">GameEvents.GameCoreUpdateBegin.Remove(OnGameCoreUpdateBegin);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0117}}<syntaxhighlight lang="lua">GameEvents.GameCoreUpdateBegin.Add(OnGameCoreUpdateBegin);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/SteampunkScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0139}}<syntaxhighlight lang="lua">GameEvents.GameCoreUpdateBegin.Add( OnGameCoreUpdateBegin );</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GameCoreUpdateBegin]]

GameEvents (Civ5 Type)

2014-02-20T17:45:28Z

Slserpent: adding some more events

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

= Usage =
This object exposes events that you can use to modify the gameplay. As opposed to the events defined on {{Type5|Events}} and {{Type5|LuaEvents}}, most of those events are expected to return a value. This value may then be used by the game to prevent or trigger some game actions (such as a declaration of war), or to override some calculations (for example by adding a bonus or a malus to the diplomatic status between two civilizations). Please look at the events' pages to learn more.

=Static Events=
Events can be subscribed by using <code>GameEvents.SomeEvent.Add(SomeFunction)</code>. Regular events can also be fired through a '''dot''' by using <code>GameEvents.SomeEvent(<args>)</code>. This will invoke all subscribers with the provided arguments. 
==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Allows provision of criteria for the ability to declare war. As this is a TestAll event, all listeners must return true for the action to be permitted. As wars are between teams, it is based entirely on teams rather than players (as far as can be inferred from scenario files).}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CanDeclareWar}}({{Type5|TeamID}} myTeam, {{Type5|TeamID}} theirTeam)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityBuildingsIsBuildingSellable}}({{Type5|PlayerID}} player, {{Type5|BuildingType}} building)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyAnyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, this allows provision of critera for the ability to construct a particular building (including Wonders, presumably) in a particular city. Based on the behaviour in the 1066 scenario, it seems that returns of false lead to the building not appearing in the list of buildings available to construct, rather than being greyed out, but this hasn't been specifically checked. It makes some sense, though, as there's no way to provide a tooltip to explain the greying out under this mechanism. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanCreate}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|ProjectType}} projectType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanMaintain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|ProcessType}} processType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanPrepare}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|SpecialistType}} specialistType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

|-
{{FuncInfos5|yes |yes |yes|This event is triggered when a city is captured. We may infer from the name that it is triggered when the capture has been completed, the city now shows as owned by the conqueror, and buildings have been destroyed (this has not been confirmed). We might hope that there is a matching event when the capture has been determined, but ownership not yet changed and buildings not yet destroyed, but have no information on this as yet.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCaptureComplete}}({{Type5|PlayerID}} player, '''int''' capital, {{Type5|ResourceType}} x, {{Type5|ResourceType}} y, {{Type5|PlayerID}} newPlayer, '''int''' conquest, '''int''' conquest)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityConvertsReligion}}({{Type5|PlayerID}} owner, {{Type5|ReligionType}} religion, '''int''' x, '''int''' y)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|DoResolveVictoryVote}}('''bool''' preliminaryVote)</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreTestVictory}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateBegin}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateEnd}}()</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetFounderBenefitsReligion}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetReligionToSpread}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier1}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier2}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerAdoptPolicy}}({{Type5|PlayerID}} player, '''int''' policyID)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanAdoptPolicyBranch}}({{Type5|PlayerID}} player, '''int''' policyBranch)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCityFounded}}({{Type5|PlayerID}} player, '''int''' cityX, '''int''' cityY)</code>

|-
{{FuncInfos5|yes |yes |yes|Fired once per turn for each player (not just active/human player). Modder experimentation has found that it is fired at the start of turn; also, it seems not to run for the first turn of the game (for all players), runs only for human player on the second turn, and thereafter it runs for all players. There is no indication as to why this is.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerDoTurn}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|On list provided by User:Sseckman, but no references yet found in scenario Lua files.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerPreAIUnitUpdate}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|Called before most items in the game are initialized. Was once used in scenario scripts, a different strategy was used; unclear how easy it would be to get a listener registered before it fires. Apparently does not pass any parameters.}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PreGameStart}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when the ally of a City-State changes (whether it changes from none or from another player).}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetAlly}}({{Type5|PlayerID}} cSPlayer, {{Type5|PlayerID}} oldAlly, {{Type5|PlayerID}} newAlly)</code>

|-
{{FuncInfos5|yes |maybe|yes|Triggered whenever any city changes population. At least, as far as we know. Information provided by User:Sseckman calls this CitySetPopulation, but the scenario Lua files refer to SetPopulation.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetPopulation}}('''int''' x, '''int''' y, '''unknown''' oldPopulation, '''int''' newPopulation)</code>
|}

==T==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|maybe|yes|Presumably called when players meet, but referring to teams. Sample usages have not been found.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamMeet}}('''unknown''' playeractive, '''unknown''' playermet)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamSetHasTech}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''bool''' adopted)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when a team researches a tech.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamTechResearched}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''int''' change)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target. ====Listener Prototype==== listener(iPlayerID, iUnitID) *iPlayerID The ID of the player who issued the explore order. *iUnitID The ID of the unit the order was issued to.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitGetSpecialExploreTarget}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unitID)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitKilledInCombat}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unitID)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered whenever any unit moves by any means, for every tile they move into.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitSetXY}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>
|}

=Static Methods=
Methods are functions that belong to an object. Static methods are invoked through a '''dot''', as in <code>GameEvents.SomeMethod(<args>)</code>. When a dot is used the caller object is not implicitly provided as the first argument.
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Accumulate}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|AccumulateINT}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Add}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Call}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Count}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Remove}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|RemoveAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAny}}</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|GameEvents]]

Plot (Civ5 Type)

2014-02-20T14:06:27Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

Plots apparently have an equality operator handler, i.e. two variables of plot type can be compared directly without having to compare both their X and Y coordinates.

=Instance Methods=
Methods are functions that belong to an object. Instance methods are invoked through a '''colon''', as in <code>caller:SomeMethod(<args>)</code>, where ''caller'' is an instance of Plot. 
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: <code>caller.SomeMethod(caller, <args>)</code>
==A==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|AddFeatureDummyModel}}('''string''' dummyTag, '''string''' modelTag)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Area}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|Area}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|At}}('''int''' x, '''int''' y)</code>
|}

==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateBestNatureYield}}({{Type5|YieldType}} index, {{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateImprovementYieldChange}}({{Type5|ImprovementType}} improvement, {{Type5|YieldType}} yield, {{Type5|PlayerID}} player, '''bool''' optimal, {{Type5|RouteType}} assumeThisRoute)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateNatureYield}}({{Type5|YieldType}} index, {{Type5|TeamID}} team, '''bool''' ignoreFeature = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateTotalBestNatureYield}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateYield}}({{Type5|YieldType}} index, '''bool''' display)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanBuild}}({{Type5|BuildActionType}} build, {{Type5|PlayerID}} player, '''bool''' testVisible)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveFeature}}({{Type5|FeatureType}} featureForest)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveImprovement}}({{Type5|ImprovementType}} improvement, {{Type5|TeamID}} team, '''bool''' potential)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveResource}}({{Type5|ResourceType}} resource, '''bool''' ignoreLatitude)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanSeePlot}}({{Type5|Plot}} target, {{Type5|TeamID}} team, '''int''' range)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeBuildProgress}}({{Type5|BuildActionType}} build, '''int''' change, {{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeExtraMovePathCost}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeImprovementDuration}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeInvisibleVisibilityCount}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible, '''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeNumResource}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeOwnershipDuration}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeUpgradeProgress}}('''int''' change)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeVisibilityCount}}({{Type5|TeamID}} team, '''int''' change, {{Type5|InvisibilityScopeType}} seeInvisibleType, '''bool''' informExplorationTracking, '''bool''' alwaysSeeInvisible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CountNumAirUnits}}({{Type5|PlayerID}} player)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|DefenseModifier}}({{Type5|TeamID}} defendTeam, '''bool''' ignoreBuilding, '''bool''' help)</code>
|}

==E==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|Erase}}</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetActiveFogOfWarMode}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|AreaID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetArea}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBestDefender}}({{Type5|PlayerID}} owner, {{Type5|PlayerID}} attackingPlayer, {{Type5|Unit}} attacker, '''bool''' testAtWar, '''bool''' testPotentialEnemy, '''bool''' testCanMove)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildProgress}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTime}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTurnsLeft}}({{Type5|BuildActionType}} build, '''int''' nowExtra, '''int''' thenExtra)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTurnsTotal}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetCityRadiusCount}}()</code>

|-
{{FuncInfos5|yes |yes |yes|Determines continent for plot type.}}
|align="right" |<code>{{Type5|ArtStyleType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetContinentArtType}}()</code>

|-
{{FuncInfos5|yes |no |yes|Determines the amount of culture yielded by working the plot.}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetCulture}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetExtraMovePathCost}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureProduction}}({{Type5|BuildActionType}} build, {{Type5|TeamID}} team, {{Type5|City}} city)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|FeatureType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureVariety}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFoundValue}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetImprovementDuration}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ImprovementType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetImprovementType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetInlandCorner}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetInvisibleVisibilityCount}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetLatitude}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|AreaID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNearestLandArea}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNearestLandPlot}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|ResourceType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNonObsoleteResourceType}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumDefenders}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumFriendlyUnitsOfType}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumResource}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumUnits}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumVisibleEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumVisiblePotentialEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlayerID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetOwner}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetOwnershipDuration}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlayerCityRadiusCount}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlotCity}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlotType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlotType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetReconCount}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ResourceType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetResourceType}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ImprovementType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedImprovementType}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlayerID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedOwner}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|RouteType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedRouteType}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedTeam}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverCrossingCount}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverEFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverSEFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverSWFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|RouteType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRouteType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetScriptData}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetSelectedUnit}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetTeam}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TerrainType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetTerrainType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Unit}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUnit}}({{Type5|UnitID}} id)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUnitPower}}({{Type5|PlayerID}} owner)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUpgradeProgress}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUpgradeTimeLeft}}({{Type5|ImprovementType}} improvement, {{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetVisibilityCount}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|City}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetWorkingCity}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetWorkingCityOverride}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetX}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetY}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetYield}}({{Type5|YieldType}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetYieldWithBuild}}({{Type5|BuildActionType}} build, {{Type5|YieldType}} yield, '''bool''' arg2, {{Type5|PlayerID}} activePlayer)</code>
|}

==H==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|HasBarbarianCamp}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|HasYield}}({{Type5|YieldType}} yield)</code>
|}

==I==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsActiveVisible}}('''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentNonrevealed}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentNonvisible}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentOwned}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentPlayer}}({{Type5|PlayerID}} player, '''bool''' landOnly)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentRevealed}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentTeam}}({{Type5|TeamID}} team, '''bool''' landOnly)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToArea}}({{Type5|Area}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToLand}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToShallowWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentVisible}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBarbarian}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBeingWorked}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBestAdjacentFound}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBuildRemovesFeature}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCity}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCityRadius}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCoastalLand}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsEnemyCity}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFighting}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFlatlands}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFreshWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFriendlyCity}}({{Type5|Unit}} unit, '''bool''' checkImprovement)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFriendlyTerritory}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsGoody}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsHills}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsImpassable}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsImprovementPillaged}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsInvisibleVisible}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsLake}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsMountain}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNEOfRiver}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNone}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNWOfRiver}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOpenGround}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOwned}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOwnershipScore}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPlayerCityRadius}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPotentialCityWork}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPotentialCityWorkForArea}}({{Type5|Area}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsResourceConnectedByImprovement}}({{Type5|ImprovementType}} improvement)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealed}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealedBarbarian}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealedGoody}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiver}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverConnection}}({{Type5|DirectionType}} direction)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossing}}({{Type5|DirectionType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossingFlowClockwise}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossingToPlot}}({{Type5|DirectionType}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverSide}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoughGround}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoute}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoutePillaged}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsStartingPlot}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsTradeRoute}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsUnit}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsValidDomainForAction}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsValidDomainForLocation}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisible}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleEnemyDefender}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleEnemyUnit}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleOtherUnit}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleToWatchingHuman}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWithinTeamCityRadius}}({{Type5|TeamID}} team, {{Type5|PlayerID}} ignorePlayer)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWOfRiver}}()</code>
|}

==M==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|MovementCost}}({{Type5|Unit}} unit, {{Type5|Plot}} fromPlot)</code>
|}

==N==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|NukeExplosion}}('''int''' range, {{Type5|Unit}} nukeUnit)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|PickFeatureDummyTag}}('''int''' mouseX, '''int''' mouseY)</code>
|}

==R==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|RemoveGoody}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|ResetFeatureModel}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|SeeFromLevel}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|SeeThroughLevel}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetArea}}({{Type5|AreaID}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetContinentArtType}}({{Type5|ArtStyleType}} style)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureDummyTexture}}('''string''' dummyTag, '''string''' textureTag)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureDummyVisibility}}('''string''' dummyTag, '''bool''' show)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureType}}('''int''' featureID, '''int''' arg1 = nil)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementDuration}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementPillaged}}('''bool''' pillaged)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementType}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNEOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNumResource}}('''int''' num)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNWOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetOwner}}({{Type5|PlayerID}} newValue, '''int''' acquiringCityID, '''bool''' checkUnits = true, '''bool''' updateResources = true)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetOwnershipDuration}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetPlotType}}({{Type5|PlotType}} terrain, '''bool''' recalculateAreas = nil, '''bool''' rebuildGraphics) = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetResourceType}}('''int''' newValue, {{Type5|ResourceType}} numResource)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetRevealed}}({{Type5|TeamID}} team, '''bool''' newValue, '''bool''' terrainOnly, {{Type5|TeamID}} fromTeam)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetRouteType}}('''int''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetScriptData}}('''string''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetStartingPlot}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetTerrainType}}({{Type5|TerrainType}} terrain, '''bool''' recalculateAreas, '''bool''' rebuildGraphics))</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetUpgradeProgress}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetWOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|ShareAdjacentArea}}({{Type5|Plot}} plot)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|UpdateFog}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|UpdateVisibility}}</code>
|}

==W==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|WaterArea}}</code>
|}

=Used by=
{|cellspacing="4" cellpadding="0" width="100%" style="background-color:#F0F0F0"

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Func5|CanPlaceGoodyAt}}({{Type5|ImprovementType}} improvement, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Func5|DoRiver}}({{Type5|Plot}} startPlot, {{Type5|FlowDirectionType}} thisFlowDirection = nil, {{Type5|FlowDirectionType}} originalFlowDirection = nil, '''int''' riverID = nil)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetCivStateQuestString}}({{Type5|Plot}} plot, '''bool''' shortVersion)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetImprovementString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetNatureString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetOwnerString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetResourceString}}({{Type5|Plot}} plot, '''bool''' longForm)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Func5|GetRiverValueAtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetUnitsString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetYieldString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|AtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|CanWork}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetCityIndexPlot}}({{Type5|CityPlotID}} index)</code>

|-
|align="right" width="200" |<code>{{Type5|CityPlotID}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetCityPlotIndex}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetNumForcedWorkingPlots}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsForcedWorkingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsPlotBlockaded}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsWorkingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|Plot}}()</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddForestsAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddIceAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddJunglesAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddMarshAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddOasisAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|CanHandleAction}}({{Type5|ActionType}} action, {{Type5|Plot}} plot = nil, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|CyclePlotUnits}}({{Type5|Plot}} plot, '''bool''' forward, '''bool''' auto, '''int''' count)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|GetImprovementUpgradeTime}}({{Type5|ImprovementType}} improvement, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|SelectionListMove}}({{Type5|Plot}} plot, '''int''' alt, '''bool''' shift, '''int''' ctrl)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|FindWater}}({{Type5|Plot}} plot, '''int''' range, '''bool''' isFreshWater)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlot}}('''int''' x, '''int''' y = nil)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlotByIndex}}({{Type5|PlotID}} index)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlotXY}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|PlotDirection}}('''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|PlotXYWithRangeCheck}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset, '''int''' maxRange)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CanBuild}}({{Type5|Plot}} plot, {{Type5|BuildActionType}} build, '''bool''' testEra = false, '''bool''' testVisible = false, '''bool''' testGold = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CanReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|DoGoody}}({{Type5|Plot}} plot, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartCityCost}}('''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartImprovementCost}}({{Type5|ImprovementType}} improvement, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartRouteCost}}({{Type5|RouteType}} route, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartUnitCost}}({{Type5|UnitType}} unit, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartVisibilityCost}}('''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetBestRoute}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetClosestGoodyPlot}}('''unknown''' void)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetFoundedReligionEnemyCityCombatMod}}({{Type5|Plot}} toPlot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetFoundedReligionFriendlyCityCombatMod}}({{Type5|Plot}} toPlot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetPlotDanger}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetPlotHasOrder}}({{Type5|Plot}} Plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetStartingPlot}}()</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|ReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|SetStartingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|CanSeePlot}}({{Type5|Plot}} target, {{Type5|TeamID}} team, '''int''' range)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetInlandCorner}}()</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetNearestLandPlot}}()</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|MovementCost}}({{Type5|Unit}} unit, {{Type5|Plot}} fromPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|ShareAdjacentArea}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|CanPlaceUnitAt}}('''unknown''' unit, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|DoSelectCityAtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|HighlightCanPlacePlots}}({{Type5|Unit}} unit, {{Type5|Plot}} arg1)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|LocationSelect}}({{Type5|Plot}} plot, '''int''' ctrl, '''int''' alt, '''bool''' shift)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|LookAt}}({{Type5|Plot}} plot, '''int''' arg1 = nil)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|AtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirDefend}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirlift}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirliftAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirPatrol}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanBuild}}({{Type5|Plot}} plot, {{Type5|BuildActionType}} build, '''bool''' testVisible = false, '''bool''' testGold = true)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanBuildSpaceship}}({{Type5|Plot}} plot, '''bool''' visible)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanConstruct}}({{Type5|Plot}} plot, {{Type5|BuildingType}} building)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDiscover}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDisembark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDisembarkOnto}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanEmbark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanEmbarkOnto}}({{Type5|Plot}} plot, {{Type5|Plot}} targetPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanFortify}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanFound}}({{Type5|Plot}} plot, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanGiveExperience}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanGoldenAge}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanHeal}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanHold}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanJoin}}({{Type5|Plot}} plot, {{Type5|SpecialistType}} specialist)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLead}}({{Type5|Plot}} plot, '''int''' unitId)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLoad}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLoadUnit}}({{Type5|Unit}} unit, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanMoveOrAttackInto}}({{Type5|Plot}} plot, '''bool''' declareWar = false, '''bool''' destination = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanMoveThrough}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanNuke}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanNukeAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanParadrop}}({{Type5|Plot}} plot, '''bool''' arg1)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanParadropAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanPillage}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanRebaseAt}}({{Type5|Plot}} sourcePlot, '''int''' targetX, '''int''' targetY)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanSentry}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanSleep}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanStartMission}}('''int''' mission, '''int''' data1, '''int''' data2, {{Type5|Plot}} plot = nil, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanTrade}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|Embark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|ExecuteSpecialExploreMove}}({{Type5|Plot}} targetPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GeneratePath}}({{Type5|Plot}} toPlot, '''int''' flags = 0, '''bool''' reuse = false, '''unknown''' piPathTurns = nil)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetBestInterceptor}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetBestSeaPillageInterceptor}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|TeamID}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetDeclareWarRangeStrike}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxAttackStrength}}({{Type5|Plot}} fromPlot, {{Type5|Plot}} toPlot, {{Type5|Unit}} defender)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxDefenseStrength}}({{Type5|Plot}} inPlot, {{Type5|Unit}} attacker, '''bool''' arg2 = nil)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetPlot}}()</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetTradeGold}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetUpgradeUnitFromPlot}}({{Type5|Plot}} adjacentPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsCanDefend}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsNukeVictim}}({{Type5|Plot}} plot, {{Type5|TeamID}} team)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsRangeAttackIgnoreLOS}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|PushMission}}({{Type5|MissionType}} mission, '''int''' data1 = -1, '''int''' data2 = -1, '''int''' flags = 0, '''bool''' append = false, '''bool''' manual = fa;se, {{Type5|MissionType}} missionAI = NO_MISSIONAI, {{Type5|Plot}} missionAIPlot = nil, {{Type5|Unit}} missionAIUnit = nil)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|SetReconPlot}}({{Type5|Plot}} newValue)</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|Plot]]

Plot (Civ5 Type)

2014-02-20T14:05:57Z

Slserpent: plot equality operator

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

Plots apparently have an equality operator handler, i.e. two variables of plot type can be compared directly without have to compare both their X and Y coordinates.

=Instance Methods=
Methods are functions that belong to an object. Instance methods are invoked through a '''colon''', as in <code>caller:SomeMethod(<args>)</code>, where ''caller'' is an instance of Plot. 
A colon implictly passes the caller object as the first argument. That is, the former call is equivalent to this one: <code>caller.SomeMethod(caller, <args>)</code>
==A==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|AddFeatureDummyModel}}('''string''' dummyTag, '''string''' modelTag)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Area}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|Area}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|At}}('''int''' x, '''int''' y)</code>
|}

==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateBestNatureYield}}({{Type5|YieldType}} index, {{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateImprovementYieldChange}}({{Type5|ImprovementType}} improvement, {{Type5|YieldType}} yield, {{Type5|PlayerID}} player, '''bool''' optimal, {{Type5|RouteType}} assumeThisRoute)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateNatureYield}}({{Type5|YieldType}} index, {{Type5|TeamID}} team, '''bool''' ignoreFeature = false)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateTotalBestNatureYield}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CalculateYield}}({{Type5|YieldType}} index, '''bool''' display)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanBuild}}({{Type5|BuildActionType}} build, {{Type5|PlayerID}} player, '''bool''' testVisible)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveFeature}}({{Type5|FeatureType}} featureForest)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveImprovement}}({{Type5|ImprovementType}} improvement, {{Type5|TeamID}} team, '''bool''' potential)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanHaveResource}}({{Type5|ResourceType}} resource, '''bool''' ignoreLatitude)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CanSeePlot}}({{Type5|Plot}} target, {{Type5|TeamID}} team, '''int''' range)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeBuildProgress}}({{Type5|BuildActionType}} build, '''int''' change, {{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeExtraMovePathCost}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeImprovementDuration}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeInvisibleVisibilityCount}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible, '''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeNumResource}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeOwnershipDuration}}('''int''' change)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeUpgradeProgress}}('''int''' change)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|ChangeVisibilityCount}}({{Type5|TeamID}} team, '''int''' change, {{Type5|InvisibilityScopeType}} seeInvisibleType, '''bool''' informExplorationTracking, '''bool''' alwaysSeeInvisible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|CountNumAirUnits}}({{Type5|PlayerID}} player)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|DefenseModifier}}({{Type5|TeamID}} defendTeam, '''bool''' ignoreBuilding, '''bool''' help)</code>
|}

==E==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|Erase}}</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetActiveFogOfWarMode}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|AreaID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetArea}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBestDefender}}({{Type5|PlayerID}} owner, {{Type5|PlayerID}} attackingPlayer, {{Type5|Unit}} attacker, '''bool''' testAtWar, '''bool''' testPotentialEnemy, '''bool''' testCanMove)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildProgress}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTime}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTurnsLeft}}({{Type5|BuildActionType}} build, '''int''' nowExtra, '''int''' thenExtra)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetBuildTurnsTotal}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetCityRadiusCount}}()</code>

|-
{{FuncInfos5|yes |yes |yes|Determines continent for plot type.}}
|align="right" |<code>{{Type5|ArtStyleType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetContinentArtType}}()</code>

|-
{{FuncInfos5|yes |no |yes|Determines the amount of culture yielded by working the plot.}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetCulture}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetExtraMovePathCost}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureProduction}}({{Type5|BuildActionType}} build, {{Type5|TeamID}} team, {{Type5|City}} city)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|FeatureType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFeatureVariety}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetFoundValue}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetImprovementDuration}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ImprovementType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetImprovementType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetInlandCorner}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetInvisibleVisibilityCount}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetLatitude}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|AreaID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNearestLandArea}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNearestLandPlot}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|ResourceType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNonObsoleteResourceType}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumDefenders}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumFriendlyUnitsOfType}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumResource}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumUnits}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumVisibleEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetNumVisiblePotentialEnemyDefenders}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlayerID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetOwner}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetOwnershipDuration}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlayerCityRadiusCount}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlotCity}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlotType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetPlotType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetReconCount}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ResourceType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetResourceType}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ImprovementType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedImprovementType}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|PlayerID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedOwner}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|RouteType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedRouteType}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRevealedTeam}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverCrossingCount}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverEFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverSEFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|FlowDirectionType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRiverSWFlowDirection}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{Type5|RouteType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetRouteType}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetScriptData}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetSelectedUnit}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TeamID}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetTeam}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|TerrainType}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetTerrainType}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Unit}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUnit}}({{Type5|UnitID}} id)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUnitPower}}({{Type5|PlayerID}} owner)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUpgradeProgress}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetUpgradeTimeLeft}}({{Type5|ImprovementType}} improvement, {{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetVisibilityCount}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|City}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetWorkingCity}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''unknown'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetWorkingCityOverride}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetX}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetY}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetYield}}({{Type5|YieldType}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|GetYieldWithBuild}}({{Type5|BuildActionType}} build, {{Type5|YieldType}} yield, '''bool''' arg2, {{Type5|PlayerID}} activePlayer)</code>
|}

==H==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|HasBarbarianCamp}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|HasYield}}({{Type5|YieldType}} yield)</code>
|}

==I==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsActiveVisible}}('''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentNonrevealed}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentNonvisible}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentOwned}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentPlayer}}({{Type5|PlayerID}} player, '''bool''' landOnly)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentRevealed}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentTeam}}({{Type5|TeamID}} team, '''bool''' landOnly)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToArea}}({{Type5|Area}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToLand}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentToShallowWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsAdjacentVisible}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBarbarian}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBeingWorked}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBestAdjacentFound}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsBuildRemovesFeature}}({{Type5|BuildActionType}} build)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCity}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCityRadius}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsCoastalLand}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsEnemyCity}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFighting}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFlatlands}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFreshWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFriendlyCity}}({{Type5|Unit}} unit, '''bool''' checkImprovement)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsFriendlyTerritory}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsGoody}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsHills}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsImpassable}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsImprovementPillaged}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsInvisibleVisible}}({{Type5|TeamID}} team, {{Type5|InvisibilityScopeType}} invisible)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsLake}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsMountain}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNEOfRiver}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNone}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsNWOfRiver}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOpenGround}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOwned}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsOwnershipScore}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPlayerCityRadius}}({{Type5|PlayerID}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPotentialCityWork}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsPotentialCityWorkForArea}}({{Type5|Area}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsResourceConnectedByImprovement}}({{Type5|ImprovementType}} improvement)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealed}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealedBarbarian}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRevealedGoody}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiver}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverConnection}}({{Type5|DirectionType}} direction)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossing}}({{Type5|DirectionType}} index)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossingFlowClockwise}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverCrossingToPlot}}({{Type5|DirectionType}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRiverSide}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoughGround}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoute}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsRoutePillaged}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsStartingPlot}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsTradeRoute}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsUnit}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsValidDomainForAction}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsValidDomainForLocation}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisible}}({{Type5|TeamID}} team, '''bool''' debug)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleEnemyDefender}}({{Type5|Unit}} unit)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleEnemyUnit}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleOtherUnit}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsVisibleToWatchingHuman}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWater}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWithinTeamCityRadius}}({{Type5|TeamID}} team, {{Type5|PlayerID}} ignorePlayer)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|IsWOfRiver}}()</code>
|}

==M==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|MovementCost}}({{Type5|Unit}} unit, {{Type5|Plot}} fromPlot)</code>
|}

==N==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|NukeExplosion}}('''int''' range, {{Type5|Unit}} nukeUnit)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''string'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|PickFeatureDummyTag}}('''int''' mouseX, '''int''' mouseY)</code>
|}

==R==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|RemoveGoody}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|ResetFeatureModel}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|SeeFromLevel}}({{Type5|TeamID}} team)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|SeeThroughLevel}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetArea}}({{Type5|AreaID}} area)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetContinentArtType}}({{Type5|ArtStyleType}} style)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureDummyTexture}}('''string''' dummyTag, '''string''' textureTag)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureDummyVisibility}}('''string''' dummyTag, '''bool''' show)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetFeatureType}}('''int''' featureID, '''int''' arg1 = nil)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementDuration}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementPillaged}}('''bool''' pillaged)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetImprovementType}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNEOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNumResource}}('''int''' num)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetNWOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetOwner}}({{Type5|PlayerID}} newValue, '''int''' acquiringCityID, '''bool''' checkUnits = true, '''bool''' updateResources = true)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetOwnershipDuration}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetPlotType}}({{Type5|PlotType}} terrain, '''bool''' recalculateAreas = nil, '''bool''' rebuildGraphics) = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetResourceType}}('''int''' newValue, {{Type5|ResourceType}} numResource)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetRevealed}}({{Type5|TeamID}} team, '''bool''' newValue, '''bool''' terrainOnly, {{Type5|TeamID}} fromTeam)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetRouteType}}('''int''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetScriptData}}('''string''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetStartingPlot}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetTerrainType}}({{Type5|TerrainType}} terrain, '''bool''' recalculateAreas, '''bool''' rebuildGraphics))</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetUpgradeProgress}}('''int''' newValue)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Plot|SetWOfRiver}}('''bool''' newValue)</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Plot|ShareAdjacentArea}}({{Type5|Plot}} plot)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|UpdateFog}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|UpdateVisibility}}</code>
|}

==W==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Plot|WaterArea}}</code>
|}

=Used by=
{|cellspacing="4" cellpadding="0" width="100%" style="background-color:#F0F0F0"

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Func5|CanPlaceGoodyAt}}({{Type5|ImprovementType}} improvement, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Func5|DoRiver}}({{Type5|Plot}} startPlot, {{Type5|FlowDirectionType}} thisFlowDirection = nil, {{Type5|FlowDirectionType}} originalFlowDirection = nil, '''int''' riverID = nil)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetCivStateQuestString}}({{Type5|Plot}} plot, '''bool''' shortVersion)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetImprovementString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetNatureString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetOwnerString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetResourceString}}({{Type5|Plot}} plot, '''bool''' longForm)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Func5|GetRiverValueAtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetUnitsString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''string'''</code>
|style="padding-left:6px" |<code>{{Func5|GetYieldString}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|AtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|CanWork}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetCityIndexPlot}}({{Type5|CityPlotID}} index)</code>

|-
|align="right" width="200" |<code>{{Type5|CityPlotID}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetCityPlotIndex}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|GetNumForcedWorkingPlots}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsForcedWorkingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsPlotBlockaded}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|IsWorkingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|City}}:{{Func5|City|Plot}}()</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddForestsAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddIceAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddJunglesAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddMarshAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|FeatureGenerator}}:{{Func5|FeatureGenerator|AddOasisAtPlot}}({{Type5|Plot}} plot, '''int''' x, '''int''' y, '''int''' lat)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|CanHandleAction}}({{Type5|ActionType}} action, {{Type5|Plot}} plot = nil, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|CyclePlotUnits}}({{Type5|Plot}} plot, '''bool''' forward, '''bool''' auto, '''int''' count)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|GetImprovementUpgradeTime}}({{Type5|ImprovementType}} improvement, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Game}}.{{Func5|Game|SelectionListMove}}({{Type5|Plot}} plot, '''int''' alt, '''bool''' shift, '''int''' ctrl)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|FindWater}}({{Type5|Plot}} plot, '''int''' range, '''bool''' isFreshWater)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlot}}('''int''' x, '''int''' y = nil)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlotByIndex}}({{Type5|PlotID}} index)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|GetPlotXY}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|PlotDirection}}('''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Map}}.{{Func5|Map|PlotXYWithRangeCheck}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset, '''int''' maxRange)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CanBuild}}({{Type5|Plot}} plot, {{Type5|BuildActionType}} build, '''bool''' testEra = false, '''bool''' testVisible = false, '''bool''' testGold = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|CanReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|DoGoody}}({{Type5|Plot}} plot, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartCityCost}}('''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartImprovementCost}}({{Type5|ImprovementType}} improvement, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartRouteCost}}({{Type5|RouteType}} route, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartUnitCost}}({{Type5|UnitType}} unit, '''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetAdvancedStartVisibilityCost}}('''bool''' add, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetBestRoute}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetClosestGoodyPlot}}('''unknown''' void)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetFoundedReligionEnemyCityCombatMod}}({{Type5|Plot}} toPlot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetFoundedReligionFriendlyCityCombatMod}}({{Type5|Plot}} toPlot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetPlotDanger}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetPlotHasOrder}}({{Type5|Plot}} Plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|GetStartingPlot}}()</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|ReceiveGoody}}({{Type5|Plot}} plot, {{Type5|GoodyType}} goody, {{Type5|Unit}} unit)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Player}}:{{Func5|Player|SetStartingPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|CanSeePlot}}({{Type5|Plot}} target, {{Type5|TeamID}} team, '''int''' range)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetInlandCorner}}()</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|GetNearestLandPlot}}()</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|MovementCost}}({{Type5|Unit}} unit, {{Type5|Plot}} fromPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Plot}}:{{Func5|Plot|ShareAdjacentArea}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|CanPlaceUnitAt}}('''unknown''' unit, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|DoSelectCityAtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|HighlightCanPlacePlots}}({{Type5|Unit}} unit, {{Type5|Plot}} arg1)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|LocationSelect}}({{Type5|Plot}} plot, '''int''' ctrl, '''int''' alt, '''bool''' shift)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|UI}}.{{Func5|UI|LookAt}}({{Type5|Plot}} plot, '''int''' arg1 = nil)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|AtPlot}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirDefend}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirlift}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirliftAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanAirPatrol}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanBuild}}({{Type5|Plot}} plot, {{Type5|BuildActionType}} build, '''bool''' testVisible = false, '''bool''' testGold = true)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanBuildSpaceship}}({{Type5|Plot}} plot, '''bool''' visible)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanConstruct}}({{Type5|Plot}} plot, {{Type5|BuildingType}} building)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDiscover}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDisembark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanDisembarkOnto}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanEmbark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanEmbarkOnto}}({{Type5|Plot}} plot, {{Type5|Plot}} targetPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanFortify}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanFound}}({{Type5|Plot}} plot, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanGiveExperience}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanGoldenAge}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanHeal}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanHold}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanJoin}}({{Type5|Plot}} plot, {{Type5|SpecialistType}} specialist)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLead}}({{Type5|Plot}} plot, '''int''' unitId)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLoad}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanLoadUnit}}({{Type5|Unit}} unit, {{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanMoveOrAttackInto}}({{Type5|Plot}} plot, '''bool''' declareWar = false, '''bool''' destination = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanMoveThrough}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanNuke}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanNukeAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanParadrop}}({{Type5|Plot}} plot, '''bool''' arg1)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanParadropAt}}({{Type5|Plot}} plot, '''int''' x, '''int''' y)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanPillage}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanRebaseAt}}({{Type5|Plot}} sourcePlot, '''int''' targetX, '''int''' targetY)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanSentry}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanSleep}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanStartMission}}('''int''' mission, '''int''' data1, '''int''' data2, {{Type5|Plot}} plot = nil, '''bool''' testVisible = false)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|CanTrade}}({{Type5|Plot}} plot, '''bool''' testVisible)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|Embark}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|ExecuteSpecialExploreMove}}({{Type5|Plot}} targetPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GeneratePath}}({{Type5|Plot}} toPlot, '''int''' flags = 0, '''bool''' reuse = false, '''unknown''' piPathTurns = nil)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetBestInterceptor}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''unknown'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetBestSeaPillageInterceptor}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|TeamID}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetDeclareWarRangeStrike}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxAttackStrength}}({{Type5|Plot}} fromPlot, {{Type5|Plot}} toPlot, {{Type5|Unit}} defender)</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetMaxDefenseStrength}}({{Type5|Plot}} inPlot, {{Type5|Unit}} attacker, '''bool''' arg2 = nil)</code>

|-
|align="right" width="200" |<code>{{Type5|Plot}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetPlot}}()</code>

|-
|align="right" width="200" |<code>'''int'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetTradeGold}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>{{Type5|Unit}}</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|GetUpgradeUnitFromPlot}}({{Type5|Plot}} adjacentPlot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsCanDefend}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsNukeVictim}}({{Type5|Plot}} plot, {{Type5|TeamID}} team)</code>

|-
|align="right" width="200" |<code>'''bool'''</code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|IsRangeAttackIgnoreLOS}}({{Type5|Plot}} plot)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|PushMission}}({{Type5|MissionType}} mission, '''int''' data1 = -1, '''int''' data2 = -1, '''int''' flags = 0, '''bool''' append = false, '''bool''' manual = fa;se, {{Type5|MissionType}} missionAI = NO_MISSIONAI, {{Type5|Plot}} missionAIPlot = nil, {{Type5|Unit}} missionAIUnit = nil)</code>

|-
|align="right" width="200" |<code></code>
|style="padding-left:6px" |<code>{{Type5|Unit}}:{{Func5|Unit|SetReconPlot}}({{Type5|Plot}} newValue)</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|Plot]]

GameEvents.CityCanTrain (Civ5 API)

2014-02-15T18:19:15Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

This works exactly the same as {{FuncLabel5|GameEvents|CityCanConstruct}} but for units instead. Note however that the prerequisites for training units that are defined in the XML files have to be met before this event fires. Thus this event can be used to hide units that would otherwise be shown but not the other way around.

=Usage=
<code>'''void''' GameEvents.CityCanTrain({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

'''Event Type'''
:Unknown

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''the index identifying the player who might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|city:
|valign="top"| ''the index identifying the city that might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|buildingType:
|valign="top"| ''the ID of the unit that might or might not be able to be constructed''
|}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|CityCanConstruct]]
[[Category:Civ5 Cities API|CityCanConstruct]]
[[Category:Civ5 City Production API|CityCanConstruct]]

GameEvents.UnitSetXY (Civ5 API)

2014-02-15T18:15:46Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

Triggered whenever any unit moves by any means, for every tile they move into. Note that this event fires before animations are completed.

=Usage=
<code>'''void''' GameEvents.UnitSetXY({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>

'''Event Type'''
:Unknown

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''The ID of the player the unit belongs to.''
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The ID of the unit.''
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The location of the plot the unit has moved into.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''No description available.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 3 are listed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0130}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(function(iPlayer, iUnitID, iX, iY)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">local plot = Map.GetPlot(iX, iY);</syntaxhighlight>
{{CodeLine5|0133}}<syntaxhighlight lang="lua">local player = Players[iPlayer];</syntaxhighlight>
{{CodeLine5|0134}}<syntaxhighlight lang="lua">local unit = player:GetUnitByID(iUnitID);</syntaxhighlight>
{{CodeLine5|0135}}<syntaxhighlight lang="lua">if (unit == nil or unit:IsDelayedDeath()) then</syntaxhighlight>
{{CodeLine5|0136}}<syntaxhighlight lang="lua">return false;</syntaxhighlight>
{{CodeLine5|0137}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0139}}<syntaxhighlight lang="lua">-- Caravel that has reached China?</syntaxhighlight>
{{CodeLine5|0140}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_CARAVEL"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0142}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0143}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0145}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian()) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0147}}<syntaxhighlight lang="lua">if(iPlayer == Game.GetActivePlayer()) then</syntaxhighlight>
{{CodeLine5|0148}}<syntaxhighlight lang="lua">UI.UnlockAchievement("ACHIEVEMENT_SCENARIO_02_ROUTE_TO_ORIENT");</syntaxhighlight>
{{CodeLine5|0149}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0151}}<syntaxhighlight lang="lua">-- How many have already been? (KLUDGE - using an unused modern era CvGame data field as a counter)</syntaxhighlight>
{{CodeLine5|0152}}<syntaxhighlight lang="lua">local iTotalCircumnavigators = Game:GetNukesExploded();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0154}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators < 3) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0156}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0158}}<syntaxhighlight lang="lua">local iGoldReceived;</syntaxhighlight>
{{CodeLine5|0159}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0161}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0162}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators == 0) then</syntaxhighlight>
{{CodeLine5|0163}}<syntaxhighlight lang="lua">iGoldReceived = 200;</syntaxhighlight>
{{CodeLine5|0164}}<syntaxhighlight lang="lua">iVPReceived = 200;</syntaxhighlight>
{{CodeLine5|0165}}<syntaxhighlight lang="lua">elseif (iTotalCircumnavigators == 1) then</syntaxhighlight>
{{CodeLine5|0166}}<syntaxhighlight lang="lua">iGoldReceived = 100;</syntaxhighlight>
{{CodeLine5|0167}}<syntaxhighlight lang="lua">iVPReceived = 100;</syntaxhighlight>
{{CodeLine5|0168}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0169}}<syntaxhighlight lang="lua">iGoldReceived = 50;</syntaxhighlight>
{{CodeLine5|0170}}<syntaxhighlight lang="lua">iVPReceived = 50;</syntaxhighlight>
{{CodeLine5|0171}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0173}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0174}}<syntaxhighlight lang="lua">local iNumWondersToCredit = iVPReceived / GameDefines["SCORE_WONDER_MULTIPLIER"];</syntaxhighlight>
{{CodeLine5|0175}}<syntaxhighlight lang="lua">player:ChangeNumWorldWonders( iNumWondersToCredit );</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0177}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0178}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0179}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0180}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0181}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0183}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0184}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0185}}<syntaxhighlight lang="lua">if (iTotalCircumnavigators == 0) then</syntaxhighlight>
{{CodeLine5|0186}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_FIRST_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0187}}<syntaxhighlight lang="lua">elseif (iTotalCircumnavigators == 1) then</syntaxhighlight>
{{CodeLine5|0188}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_SECOND_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0189}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0190}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_THIRD_CIRCUMNAVIGATION", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0191}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0192}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0193}}<syntaxhighlight lang="lua">local iRemaining = 2 - iTotalCircumnavigators;</syntaxhighlight>
{{CodeLine5|0194}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_OTHER_CIRCUMNAVIGATION", player:GetName(), iRemaining);</syntaxhighlight>
{{CodeLine5|0195}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0197}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0199}}<syntaxhighlight lang="lua">Game:ChangeNukesExploded(1);</syntaxhighlight>
{{CodeLine5|0200}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0201}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0202}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0204}}<syntaxhighlight lang="lua">-- Treasure unit that has reached capital?</syntaxhighlight>
{{CodeLine5|0205}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_TREASURE"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0207}}<syntaxhighlight lang="lua">-- At my capital?</syntaxhighlight>
{{CodeLine5|0208}}<syntaxhighlight lang="lua">local capital = player:GetCapitalCity();</syntaxhighlight>
{{CodeLine5|0209}}<syntaxhighlight lang="lua">if (capital ~= nil and capital:GetX() == iX and capital:GetY() == iY) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0211}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0213}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0214}}<syntaxhighlight lang="lua">local iGoldReceived = 100;</syntaxhighlight>
{{CodeLine5|0215}}<syntaxhighlight lang="lua">local iVPReceived = 50;</syntaxhighlight>
{{CodeLine5|0216}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0217}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0219}}<syntaxhighlight lang="lua">-- Put out notification</syntaxhighlight>
{{CodeLine5|0220}}<syntaxhighlight lang="lua">local text;</syntaxhighlight>
{{CodeLine5|0221}}<syntaxhighlight lang="lua">local heading;</syntaxhighlight>
{{CodeLine5|0222}}<syntaxhighlight lang="lua">text = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_TREASURE_RETURNED", capital:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0223}}<syntaxhighlight lang="lua">heading = Locale.ConvertTextKey("TXT_KEY_NEWWORLD_SCENARIO_TREASURE_RETURNED_SHORT");</syntaxhighlight>
{{CodeLine5|0224}}<syntaxhighlight lang="lua">player:AddNotification(NotificationTypes.NOTIFICATION_GENERIC, text, heading);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0226}}<syntaxhighlight lang="lua">if(iPlayer == Game.GetActivePlayer()) then</syntaxhighlight>
{{CodeLine5|0227}}<syntaxhighlight lang="lua">if(capital:GetX() > 50) then</syntaxhighlight>
{{CodeLine5|0228}}<syntaxhighlight lang="lua">UI.UnlockAchievement("ACHIEVEMENT_SCENARIO_02_RETURN_TREASURE");</syntaxhighlight>
{{CodeLine5|0229}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0230}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0231}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0232}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0234}}<syntaxhighlight lang="lua">return true;</syntaxhighlight>
{{CodeLine5|0235}}<syntaxhighlight lang="lua">end);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1030}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(UpdatePromotion);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0594}}<syntaxhighlight lang="lua">GameEvents.UnitSetXY.Add(function(iPlayer, iUnitID, iX, iY)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0596}}<syntaxhighlight lang="lua">local plot = Map.GetPlot(iX, iY);</syntaxhighlight>
{{CodeLine5|0597}}<syntaxhighlight lang="lua">local player = Players[iPlayer];</syntaxhighlight>
{{CodeLine5|0598}}<syntaxhighlight lang="lua">local unit = player:GetUnitByID(iUnitID);</syntaxhighlight>
{{CodeLine5|0599}}<syntaxhighlight lang="lua">if (unit == nil or unit:IsDelayedDeath()) then</syntaxhighlight>
{{CodeLine5|0600}}<syntaxhighlight lang="lua">return false;</syntaxhighlight>
{{CodeLine5|0601}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0602}}<syntaxhighlight lang="lua">local iNumCaravels = GetPersistentProperty("NumCaravels");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0604}}<syntaxhighlight lang="lua">-- Caravel that has reached China?</syntaxhighlight>
{{CodeLine5|0605}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_CARAVEL"] and iNumCaravels < 5) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0607}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0608}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0610}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian()) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0612}}<syntaxhighlight lang="lua">-- How many have already been?</syntaxhighlight>
{{CodeLine5|0613}}<syntaxhighlight lang="lua">iNumCaravels = iNumCaravels + 1;</syntaxhighlight>
{{CodeLine5|0614}}<syntaxhighlight lang="lua">SetPersistentProperty("NumCaravels", iNumCaravels);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0616}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0618}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0620}}<syntaxhighlight lang="lua">-- Grant VP</syntaxhighlight>
{{CodeLine5|0621}}<syntaxhighlight lang="lua">iVPReceived = 600 - (iNumCaravels * 100);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0623}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0625}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0626}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0627}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0628}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0629}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0631}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0632}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0633}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_CARAVEL", unit:GetName(), iVPReceived, (5 - iNumCaravels));</syntaxhighlight>
{{CodeLine5|0634}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0635}}<syntaxhighlight lang="lua">else</syntaxhighlight>
{{CodeLine5|0636}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_OTHER_CARAVEL", player:GetName(), iVPReceived, (5 - iNumCaravels));</syntaxhighlight>
{{CodeLine5|0637}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0638}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0639}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0640}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0642}}<syntaxhighlight lang="lua">-- Conquistador that has reached China?</syntaxhighlight>
{{CodeLine5|0643}}<syntaxhighlight lang="lua">if (unit:GetUnitType() == GameInfoTypes["UNIT_SPANISH_CONQUISTADOR"]) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0645}}<syntaxhighlight lang="lua">-- Adjacent to plot owned by China?</syntaxhighlight>
{{CodeLine5|0646}}<syntaxhighlight lang="lua">local bAdjacentChina = IsAdjacentToChina (iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0648}}<syntaxhighlight lang="lua">-- How many have already been?</syntaxhighlight>
{{CodeLine5|0649}}<syntaxhighlight lang="lua">local iNumConquistadors = GetPersistentProperty("NumConquistadors");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0651}}<syntaxhighlight lang="lua">if (bAdjacentChina and not player:IsMinorCiv() and not player:IsBarbarian() and iNumConquistadors < 3) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0653}}<syntaxhighlight lang="lua">local pTeam;</syntaxhighlight>
{{CodeLine5|0654}}<syntaxhighlight lang="lua">pTeam = Teams[player:GetTeam()];</syntaxhighlight>
{{CodeLine5|0655}}<syntaxhighlight lang="lua">if (pTeam:IsHasTech(GameInfoTypes["TECH_EXPLORATION"])) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0657}}<syntaxhighlight lang="lua">iNumConquistadors = iNumConquistadors + 1;</syntaxhighlight>
{{CodeLine5|0658}}<syntaxhighlight lang="lua">SetPersistentProperty("NumConquistadors", iNumConquistadors);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0660}}<syntaxhighlight lang="lua">unit:Kill(true, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0662}}<syntaxhighlight lang="lua">local iGoldReceived;</syntaxhighlight>
{{CodeLine5|0663}}<syntaxhighlight lang="lua">local iVPReceived;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0665}}<syntaxhighlight lang="lua">-- Grant gold and VP</syntaxhighlight>
{{CodeLine5|0666}}<syntaxhighlight lang="lua">iGoldReceived = 500;</syntaxhighlight>
{{CodeLine5|0667}}<syntaxhighlight lang="lua">iVPReceived = 250;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0669}}<syntaxhighlight lang="lua">player:ChangeGold(iGoldReceived);</syntaxhighlight>
{{CodeLine5|0670}}<syntaxhighlight lang="lua">player:ChangeScoreFromFutureTech(iVPReceived);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0672}}<syntaxhighlight lang="lua">-- Put up dialog box</syntaxhighlight>
{{CodeLine5|0673}}<syntaxhighlight lang="lua">local popupInfo = {</syntaxhighlight>
{{CodeLine5|0674}}<syntaxhighlight lang="lua">Data1 = 500,</syntaxhighlight>
{{CodeLine5|0675}}<syntaxhighlight lang="lua">Type = ButtonPopupTypes.BUTTONPOPUP_TEXT,</syntaxhighlight>
{{CodeLine5|0676}}<syntaxhighlight lang="lua">}</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0678}}<syntaxhighlight lang="lua">-- Human player?</syntaxhighlight>
{{CodeLine5|0679}}<syntaxhighlight lang="lua">if (iPlayer == 0) then</syntaxhighlight>
{{CodeLine5|0680}}<syntaxhighlight lang="lua">popupInfo.Text = Locale.ConvertTextKey("TXT_KEY_MEDIEVAL_SCENARIO_CONQUISTADOR", unit:GetName(), iGoldReceived, iVPReceived);</syntaxhighlight>
{{CodeLine5|0681}}<syntaxhighlight lang="lua">UI.AddPopup(popupInfo);</syntaxhighlight>
{{CodeLine5|0682}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0683}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0684}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeLine5|0685}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0687}}<syntaxhighlight lang="lua">return true;</syntaxhighlight>
{{CodeLine5|0688}}<syntaxhighlight lang="lua">end);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|UnitSetXY]]
[[Category:Civ5 Units API|UnitSetXY]]

GameEvents.CityCanTrain (Civ5 API)

2014-02-14T18:01:59Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

This works exactly the same as {{FuncLabel5|GameEvents|CityCanConstruct}} but for units instead. Note however that the prerequisites for training units that are defined in the XML files have to be met before this event fires.

=Usage=
<code>'''void''' GameEvents.CityCanTrain({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

'''Event Type'''
:Unknown

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''the index identifying the player who might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|city:
|valign="top"| ''the index identifying the city that might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|buildingType:
|valign="top"| ''the ID of the unit that might or might not be able to be constructed''
|}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|CityCanConstruct]]
[[Category:Civ5 Cities API|CityCanConstruct]]
[[Category:Civ5 City Production API|CityCanConstruct]]

GameEvents (Civ5 Type)

2014-02-14T17:48:04Z

Slserpent: /* C */

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

= Usage =
This object exposes events that you can use to modify the gameplay. As opposed to the events defined on {{Type5|Events}} and {{Type5|LuaEvents}}, most of those events are expected to return a value. This value may then be used by the game to prevent or trigger some game actions (such as a declaration of war), or to override some calculations (for example by adding a bonus or a malus to the diplomatic status between two civilizations). Please look at the events' pages to learn more.

=Static Events=
Events can be subscribed by using <code>GameEvents.SomeEvent.Add(SomeFunction)</code>. Regular events can also be fired through a '''dot''' by using <code>GameEvents.SomeEvent(<args>)</code>. This will invoke all subscribers with the provided arguments. 
==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Allows provision of criteria for the ability to declare war. As this is a TestAll event, all listeners must return true for the action to be permitted. As wars are between teams, it is based entirely on teams rather than players (as far as can be inferred from scenario files).}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CanDeclareWar}}({{Type5|TeamID}} myTeam, {{Type5|TeamID}} theirTeam)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityBuildingsIsBuildingSellable}}({{Type5|PlayerID}} player, {{Type5|BuildingType}} building)</code>

|-
{{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, this allows provision of critera for the ability to construct a particular building (including Wonders, presumably) in a particular city. Based on the behaviour in the 1066 scenario, it seems that returns of false lead to the building not appearing in the list of buildings available to construct, rather than being greyed out, but this hasn't been specifically checked. It makes some sense, though, as there's no way to provide a tooltip to explain the greying out under this mechanism. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyAnyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city)</code>

|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanBuyPlot}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, '''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |yes |yes|This event is triggered when a city is captured. We may infer from the name that it is triggered when the capture has been completed, the city now shows as owned by the conqueror, and buildings have been destroyed (this has not been confirmed). We might hope that there is a matching event when the capture has been determined, but ownership not yet changed and buildings not yet destroyed, but have no information on this as yet.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCaptureComplete}}({{Type5|PlayerID}} player, '''int''' capital, {{Type5|ResourceType}} x, {{Type5|ResourceType}} y, {{Type5|PlayerID}} newPlayer, '''int''' conquest, '''int''' conquest)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityConvertsReligion}}({{Type5|PlayerID}} owner, {{Type5|ReligionType}} religion, '''int''' x, '''int''' y)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|DoResolveVictoryVote}}('''bool''' preliminaryVote)</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreTestVictory}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateBegin}}()</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetFounderBenefitsReligion}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetReligionToSpread}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier1}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier2}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerAdoptPolicy}}({{Type5|PlayerID}} player, '''int''' policyID)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanAdoptPolicyBranch}}({{Type5|PlayerID}} player, '''int''' policyBranch)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCityFounded}}({{Type5|PlayerID}} player, '''int''' cityX, '''int''' cityY)</code>

|-
{{FuncInfos5|yes |yes |yes|Fired once per turn for each player (not just active/human player). Modder experimentation has found that it is fired at the start of turn; also, it seems not to run for the first turn of the game (for all players), runs only for human player on the second turn, and thereafter it runs for all players. There is no indication as to why this is.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerDoTurn}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|On list provided by User:Sseckman, but no references yet found in scenario Lua files.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerPreAIUnitUpdate}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|Called before most items in the game are initialized. Was once used in scenario scripts, a different strategy was used; unclear how easy it would be to get a listener registered before it fires. Apparently does not pass any parameters.}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PreGameStart}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when the ally of a City-State changes (whether it changes from none or from another player).}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetAlly}}({{Type5|PlayerID}} cSPlayer, {{Type5|PlayerID}} oldAlly, {{Type5|PlayerID}} newAlly)</code>

|-
{{FuncInfos5|yes |maybe|yes|Triggered whenever any city changes population. At least, as far as we know. Information provided by User:Sseckman calls this CitySetPopulation, but the scenario Lua files refer to SetPopulation.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetPopulation}}('''int''' x, '''int''' y, '''unknown''' oldPopulation, '''int''' newPopulation)</code>
|}

==T==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|maybe|yes|Presumably called when players meet, but referring to teams. Sample usages have not been found.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamMeet}}('''unknown''' playeractive, '''unknown''' playermet)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamSetHasTech}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''bool''' adopted)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when a team researches a tech.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamTechResearched}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''int''' change)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target. ====Listener Prototype==== listener(iPlayerID, iUnitID) *iPlayerID The ID of the player who issued the explore order. *iUnitID The ID of the unit the order was issued to.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitGetSpecialExploreTarget}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unitID)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered whenever any unit moves by any means, for every tile they move into.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitSetXY}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>
|}

=Static Methods=
Methods are functions that belong to an object. Static methods are invoked through a '''dot''', as in <code>GameEvents.SomeMethod(<args>)</code>. When a dot is used the caller object is not implicitly provided as the first argument.
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Accumulate}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|AccumulateINT}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Add}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Call}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Count}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Remove}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|RemoveAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAny}}</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|GameEvents]]

GameEvents.CityCanTrain (Civ5 API)

2014-02-14T17:13:46Z

Slserpent: CityCanTrain

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|GameEvents}}. 
This is a static method, invoke it with a dot.
}}

This works exactly the same as {{FuncLabel5|GameEvents|CityCanConstruct}} but for units instead. Note however that it doesn't work for Workboats.

=Usage=
<code>'''void''' GameEvents.CityCanTrain({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

'''Event Type'''
:Unknown

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|player:
|valign="top"| ''the index identifying the player who might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|city:
|valign="top"| ''the index identifying the city that might or might not be able to construct''
|-
|valign="top" style="padding-right:6px;"|buildingType:
|valign="top"| ''the ID of the unit that might or might not be able to be constructed''
|}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|CityCanConstruct]]
[[Category:Civ5 Cities API|CityCanConstruct]]
[[Category:Civ5 City Production API|CityCanConstruct]]

GameEvents (Civ5 Type)

2014-02-14T16:43:41Z

Slserpent: /* C */

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

= Usage =
This object exposes events that you can use to modify the gameplay. As opposed to the events defined on {{Type5|Events}} and {{Type5|LuaEvents}}, most of those events are expected to return a value. This value may then be used by the game to prevent or trigger some game actions (such as a declaration of war), or to override some calculations (for example by adding a bonus or a malus to the diplomatic status between two civilizations). Please look at the events' pages to learn more.

=Static Events=
Events can be subscribed by using <code>GameEvents.SomeEvent.Add(SomeFunction)</code>. Regular events can also be fired through a '''dot''' by using <code>GameEvents.SomeEvent(<args>)</code>. This will invoke all subscribers with the provided arguments. 
==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Allows provision of criteria for the ability to declare war. As this is a TestAll event, all listeners must return true for the action to be permitted. As wars are between teams, it is based entirely on teams rather than players (as far as can be inferred from scenario files).}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CanDeclareWar}}({{Type5|TeamID}} myTeam, {{Type5|TeamID}} theirTeam)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityBuildingsIsBuildingSellable}}({{Type5|PlayerID}} player, {{Type5|BuildingType}} building)</code>

|-
{{FuncInfos5|yes |maybe|yes|Similar to CanDeclareWar, this allows provision of critera for the ability to construct a particular building (including Wonders, presumably) in a particular city. Based on the behaviour in the 1066 scenario, it seems that returns of false lead to the building not appearing in the list of buildings available to construct, rather than being greyed out, but this hasn't been specifically checked. It makes some sense, though, as there's no way to provide a tooltip to explain the greying out under this mechanism. As with CanDeclareWar, it's unclear whether multiple listeners' returns are combined with AND or OR; either seems possible according to the detailed explanation of how these events are handled.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanConstruct}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|BuildingType}} buildingType)</code>
|-
{{FuncInfos5|yes |maybe|yes|}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCanTrain}}({{Type5|PlayerID}} player, {{Type5|CityID}} city, {{Type5|UnitType}} unitType)</code>

|-
{{FuncInfos5|yes |yes |yes|This event is triggered when a city is captured. We may infer from the name that it is triggered when the capture has been completed, the city now shows as owned by the conqueror, and buildings have been destroyed (this has not been confirmed). We might hope that there is a matching event when the capture has been determined, but ownership not yet changed and buildings not yet destroyed, but have no information on this as yet.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityCaptureComplete}}({{Type5|PlayerID}} player, '''int''' capital, {{Type5|ResourceType}} x, {{Type5|ResourceType}} y, {{Type5|PlayerID}} newPlayer, '''int''' conquest, '''int''' conquest)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|CityConvertsReligion}}({{Type5|PlayerID}} owner, {{Type5|ReligionType}} religion, '''int''' x, '''int''' y)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|DoResolveVictoryVote}}('''bool''' preliminaryVote)</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreTestVictory}}()</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GameCoreUpdateBegin}}()</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetFounderBenefitsReligion}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetReligionToSpread}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier1}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|GetScenarioDiploModifier2}}({{Type5|PlayerID}} player1, {{Type5|PlayerID}} player2)</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerAdoptPolicy}}({{Type5|PlayerID}} player, '''int''' policyID)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCanAdoptPolicyBranch}}({{Type5|PlayerID}} player, '''int''' policyBranch)</code>

|-
{{FuncInfos5|no |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerCityFounded}}({{Type5|PlayerID}} player, '''int''' cityX, '''int''' cityY)</code>

|-
{{FuncInfos5|yes |yes |yes|Fired once per turn for each player (not just active/human player). Modder experimentation has found that it is fired at the start of turn; also, it seems not to run for the first turn of the game (for all players), runs only for human player on the second turn, and thereafter it runs for all players. There is no indication as to why this is.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerDoTurn}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|On list provided by User:Sseckman, but no references yet found in scenario Lua files.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PlayerPreAIUnitUpdate}}({{Type5|PlayerID}} player)</code>

|-
{{FuncInfos5|maybe|maybe|yes|Called before most items in the game are initialized. Was once used in scenario scripts, a different strategy was used; unclear how easy it would be to get a listener registered before it fires. Apparently does not pass any parameters.}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|PreGameStart}}</code>
|}

==S==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when the ally of a City-State changes (whether it changes from none or from another player).}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetAlly}}({{Type5|PlayerID}} cSPlayer, {{Type5|PlayerID}} oldAlly, {{Type5|PlayerID}} newAlly)</code>

|-
{{FuncInfos5|yes |maybe|yes|Triggered whenever any city changes population. At least, as far as we know. Information provided by User:Sseckman calls this CitySetPopulation, but the scenario Lua files refer to SetPopulation.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|SetPopulation}}('''int''' x, '''int''' y, '''unknown''' oldPopulation, '''int''' newPopulation)</code>
|}

==T==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|maybe|maybe|yes|Presumably called when players meet, but referring to teams. Sample usages have not been found.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamMeet}}('''unknown''' playeractive, '''unknown''' playermet)</code>

|-
{{FuncInfos5|maybe|yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamSetHasTech}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''bool''' adopted)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered when a team researches a tech.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TeamTechResearched}}({{Type5|TeamID}} team, {{Type5|TechType}} tech, '''int''' change)</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |maybe|yes|Appears to be triggered when the 'explore' order is given, or some subset thereof. The unit structure for the relevant unit is manipulated to set the explore target. ====Listener Prototype==== listener(iPlayerID, iUnitID) *iPlayerID The ID of the player who issued the explore order. *iUnitID The ID of the unit the order was issued to.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitGetSpecialExploreTarget}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unitID)</code>

|-
{{FuncInfos5|yes |yes |yes|Triggered whenever any unit moves by any means, for every tile they move into.}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|GameEvents|UnitSetXY}}({{Type5|PlayerID}} player, {{Type5|UnitID}} unit, '''int''' x, '''int''' y)</code>
|}

=Static Methods=
Methods are functions that belong to an object. Static methods are invoked through a '''dot''', as in <code>GameEvents.SomeMethod(<args>)</code>. When a dot is used the caller object is not implicitly provided as the first argument.
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Accumulate}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|AccumulateINT}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Add}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Call}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Count}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|Remove}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|RemoveAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAll}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|GameEvents|TestAny}}</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|GameEvents]]

Fractal.Create (Civ5 API)

2014-02-11T06:45:22Z

Slserpent: clarification about some parameters

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is a static method, invoke it with a dot. 
Used to create a 2D-array of random values using [Fractal] (insert wikipedia link here) math.
}}

=Usage=
<code>{{Type5|Fractal}} Fractal.Create('''int''' width, '''int''' height, '''int''' grain, '''table''' fractalFlags, '''int''' xExponent, '''int''' yExponent)</code>

'''Returned Value'''
:Returns an instance of Fractal.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|width:
|valign="top"| ''The width of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|height:
|valign="top"| ''The height of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|grain:
|valign="top"| ''Amount of grain to add to fractal. 0 is no grain (smooth), 7 is lots of grain (jagged).''
|-
|valign="top" style="padding-right:6px;"|fractalFlags:
|valign="top"| ''A table that holds certain additional options used in creating the fractal. See below.''
|-
|valign="top" style="padding-right:6px;"|xExponent:
|valign="top"| ''Width resolution of the fractal. Higher values will produce sharper fractals, while lower values will produce blurry ones.''
|-
|valign="top" style="padding-right:6px;"|yExponent:
|valign="top"| ''Height resolution of the fractal.''
|}

'''A note about fractal exponents from MultilayeredFractal.lua:'''
<blockquote>FracXExp is the width of the source fractal.
FracYExp is the height of the source fractal.
These exponents are raised to powers of two. So a value of FracXExp = 7
means 2^7, which would be 128 units wide. FracXExp = 6 would be only 64
units wide. FracYExp works the same way.</blockquote>

'''Fractal Flags'''
:{|
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_WRAP_X:
|valign="top"| ''Whether or not the fractal should wrap around the X axis.''
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_WRAP_Y:
|valign="top"| ''???''
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_POLAR:
|valign="top"| ''???''
|}

=Source code samples=
''Too many occurences. Only 50 out of 130 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0269}}<syntaxhighlight lang="lua">local grass_check = Fractal.Create(iW, iH, 5, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0270}}<syntaxhighlight lang="lua">local desert_check = Fractal.Create(iW, iH, 4, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0366}}<syntaxhighlight lang="lua">local marshes = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0367}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0126}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, 2, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0127}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0128}}<syntaxhighlight lang="lua">local mountainsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local snowFrac = Fractal.Create(iW, iH, 3, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local snowFrac2 = Fractal.Create(iW, 1 + math.floor(iH * 0.4), 2, iFlags, 7, 6);</syntaxhighlight>
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsFrac = Fractal.Create(iW, iH, 4, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0102}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, 4, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0440}}<syntaxhighlight lang="lua">local snow_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0441}}<syntaxhighlight lang="lua">local tundra_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0442}}<syntaxhighlight lang="lua">local grass_frac = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0128}}<syntaxhighlight lang="lua">self.jungles = Fractal.Create(width, height, self.jungle_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0129}}<syntaxhighlight lang="lua">self.forests = Fractal.Create(width, height, self.forest_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0130}}<syntaxhighlight lang="lua">self.forestclumps = Fractal.Create(width, height, self.clump_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0059}}<syntaxhighlight lang="lua">self.riftsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, rift_grain, {}, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0062}}<syntaxhighlight lang="lua">self.continentsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, continent_grain, fracFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0662}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0663}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0070}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0071}}<syntaxhighlight lang="lua">local regionsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0361}}<syntaxhighlight lang="lua">local rocky = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0362}}<syntaxhighlight lang="lua">local plains = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0363}}<syntaxhighlight lang="lua">local east = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0364}}<syntaxhighlight lang="lua">local variation = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0492}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, iFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1490}}<syntaxhighlight lang="lua">local herds = Fractal.Create(iW, iH, 7, {}, -1, -1)</syntaxhighlight>
{{CodeLine5|1491}}<syntaxhighlight lang="lua">local iHerdsClumps = herds:GetHeight(3)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0820}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iW, iH, 5, {}, 7, 7);</syntaxhighlight>
{{CodeLine5|0821}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iW, iH, 6, {}, 7, 7);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0169}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0170}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0171}}<syntaxhighlight lang="lua">local mountain_passFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InlandSea.lua}}
:<code>Maps/InlandSea.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local seaFrac = Fractal.Create(iWidth, iHeight, grain, fracFlags, -1, -1)</syntaxhighlight>
{{CodeLine5|0074}}<syntaxhighlight lang="lua">local seaThreshold = seaFrac:GetHeight(47);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Lakes.lua}}
:<code>Maps/Lakes.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">local riftsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRiftGrain, {}, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0341}}<syntaxhighlight lang="lua">regionContinentsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionGrain, iRegionPlotFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0350}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeLine5|0351}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain + 1, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0708}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeLine5|0709}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|North_vs_South.lua}}
:<code>Maps/North_vs_South.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0090}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Oval.lua}}
:<code>Maps/Oval.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local baysFrac = Fractal.Create(iW, iH, 3, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0146}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0151}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0108}}<syntaxhighlight lang="lua">self.deserts = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0109}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0110}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0115}}<syntaxhighlight lang="lua">self.plains = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0116}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0117}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Create]]
[[Category:Civ5 City Production API|Create]]

User talk:Slserpent

2014-02-09T10:57:24Z

Slserpent:

Man, that edit you made on your page was dangerous ;). Was nearly about to kick you as a bot, but good that I remembered that name ^^. [[User:The J|The J]] ([[User talk:The J|talk]]) 16:51, 8 February 2014 (UTC)
:Yeh, I guess it does look suspicious. Normally I would just put a link, but that's not allowed. You guys sure are getting boned by bots and spam.--[[User:Slserpent|Slserpent]] ([[User talk:Slserpent|talk]]) 10:57, 9 February 2014 (UTC)

User:Slserpent

2014-02-08T15:02:28Z

Slserpent: Created page with "Find me at SnakeByte Studios"

Find me at SnakeByte Studios

Player.InitUnit (Civ5 API)

2014-02-08T11:39:01Z

Slserpent:

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Player}}. 
This is an instance method, invoke it with a colon. 
Creates a new unit for the calling player.
}}

=Usage=
<code>{{Type5|Unit}} Player:InitUnit({{Type5|UnitType}} unit, '''int''' x, '''int''' y, {{Type5|UnitAIType}} unitAI = NO_UNITAI, {{Type5|DirectionType}} facingDirection = NO_DIRECTION)</code>

Note: Using this function in a map script may crash Civilization 5.

'''Returned Value'''
:Returns a reference to the created unit.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The {{Type5|UnitType}} ID of the unit to be created.''
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The X coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''The Y coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|unitAI:
|valign="top"| ''Optional. The AI tactics for the unit to use upon being created. If not specified, it will be the default AI for this unit type.''
|-
|valign="top" style="padding-right:6px;"|facingDirection:
|valign="top"| ''Optional. The direction for the newly created unit to be facing. If not specified, it will be random.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 350 are listed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">unit = pLoopPlayer:InitUnit (iUnitID, pLoopPlayer:GetStartingPlot():GetX(), pLoopPlayer:GetStartingPlot():GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0413}}<syntaxhighlight lang="lua">pPlayer:InitUnit (iUnitID, adjacentPlot:GetX(), adjacentPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, playerStartPlot:GetX(), playerStartPlot:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0545}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 36, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0549}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 37, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0553}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 38, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0561}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 40, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0599}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 21, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0607}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 19, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0615}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 19, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0623}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 53, 21, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0653}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 31, 34, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0665}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 29, 33, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0669}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 30, 34, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 50, 11, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0701}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 13, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0713}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 11, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/SteampunkScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0850}}<syntaxhighlight lang="lua">local pUnit = pPlayer:InitUnit(eUnitType, pPlot:GetX(), pPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0378}}<syntaxhighlight lang="lua">unit = newPlayer:InitUnit(iUnitID, iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1309}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 20, 47); -- Legion @ Lutetia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1323}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_BALLISTA"], 26, 49); -- Ballista @ Trier</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1330}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 22, 42); -- Horseman @ Lugundium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1344}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 49, 34); -- Archer @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1346}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 75, 26); -- Archer @ Melitene</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1352}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 76, 21); -- Catapult @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1358}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 76, 21); -- Legion @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1369}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 49, 34); -- Cataphract @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1371}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 71, 30); -- Cataphract @ Amasia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1388}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 81, 33); -- Swordsman @ Anium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1413}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 79, 24); -- Swordsman @ Amida</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1432}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 84, 58); -- Horseman @ Attila's Court -- extra to encourage an attack</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1442}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_HORSE_ARCHER"], 84, 58); -- Horse archer @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1448}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_BATTERING_RAM"], 84, 58); -- battering ram! @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1476}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 17, 57); -- Bowman @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1480}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 17, 57); -- Catapult @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1528}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 32, 54); -- Bowman @ Tongres</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1556}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_GOTH_GADRAUHT"], 50, 37); -- Gadrauht @ ERE border</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1586}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 4, 19); -- Bowman @ Caput Vada -- added to get army up to city-attacking size</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1592}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CARTHAGINIAN_QUINQUEREME"], 4, 19); -- Tri @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1594}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_VANDAL_AXEMAN"], 4, 19); -- Axeman @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1600}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 4, 19); -- Catapult @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1816}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1819}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2018}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CELT_PICTISH_WARRIOR"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2108}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_FRANK_SEAXMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1064}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1276}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_WORKER, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1300}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_GENERAL, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1612}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_SETTLE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldView.lua}}
:<code>UI/InGame/WorldView/WorldView.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0264}}<syntaxhighlight lang="lua">pActivePlayer:InitUnit(iUnitID, plotX, plotY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|InitUnit]]
[[Category:Civ5 Units API|InitUnit]]

Map.Rand (Civ5 API)

2014-02-05T09:19:02Z

Slserpent: more information

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Map}}. 
This is a static method, invoke it with a dot. 
Generates a random number.
}}

=Usage=
<code>'''int''' Map.Rand('''int''' maxValues, '''string''' logEntry)</code>

'''Returned Value'''
:A random number between 0 and maxValues - 1.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|maxValues:
|valign="top"| ''The number of possible random values to make.''
|-
|valign="top" style="padding-right:6px;"|logEntry:
|valign="top"| ''Not optional, but in what log does this appear? May need to set RandLog = 1 in config.ini.''
|}
'''Wrapper''' 
This is a wrapper function for working with Map.Rand which makes it much easier to use. Returns a random number between lower and upper and including both.
<syntaxhighlight lang="lua" class="civ5-example">
function GetRandom(lower, upper)
return Map.Rand((upper + 1) - lower, "") + lower
end
</syntaxhighlight>

=Source code samples=
''Too many occurences. Only 50 out of 668 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1134}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(10000, "Choose resource type - Assign Luxury To Region - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1390}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(3, "Resource selection - Place Small Quantities LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1417}}<syntaxhighlight lang="lua">local strat_radius = Map.Rand(4, "Resource Radius - Place Small Quantities LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Arborea.lua (G&K)}}
:<code>DLC/Expansion/Maps/Arborea.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0115}}<syntaxhighlight lang="lua">sea_level = 1 + Map.Rand(3, "Random Sea Level - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0529}}<syntaxhighlight lang="lua">local grain_dice = Map.Rand(7, "Continental Grain roll - LUA Continents");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0535}}<syntaxhighlight lang="lua">local rift_dice = Map.Rand(3, "Rift Grain roll - LUA Continents");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0679}}<syntaxhighlight lang="lua">age = 1 + Map.Rand(3, "Random World Age - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0721}}<syntaxhighlight lang="lua">temp = 1 + Map.Rand(3, "Random Temperature - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|AssignStartingPlots.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/AssignStartingPlots.lua</code>
:{{CodeBegin5}}
{{CodeLine5|4291}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(iNumConversionCandidates, "Choosing plot to convert to Grass near food-poor Plains start - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|4971}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(table.maxn(candidate_regions), "Choosing from among Candidate Regions for start bias - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|7671}}<syntaxhighlight lang="lua">res_addition = Map.Rand(1 + (max_radius - min_radius), "Resource Radius - Place Resource LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0532}}<syntaxhighlight lang="lua">x_target = math.floor(iW / 5 + Map.Rand((iW * 0.6), "River Target - Lua"));</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0074}}<syntaxhighlight lang="lua">west_edge[y] = math.ceil(iW * 0.08) - 1 + Map.Rand(4, "Roughen coastline - Mediterranean LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0340}}<syntaxhighlight lang="lua">local atoll_number = atoll_target + Map.Rand(atoll_target, "Number of Atolls to place - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0435}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(100, "Atoll Placement Type - LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0341}}<syntaxhighlight lang="lua">local segmentLength = Map.Rand(primaryMaxLength + 1, "FractalWorld Center Rift Segment Length - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0346}}<syntaxhighlight lang="lua">local dice = Map.Rand(2, "FractalWorld Center Rift Direction - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0179}}<syntaxhighlight lang="lua">rightSeed = Map.Rand(5, "Ozarks Shape - Great Plains Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0517}}<syntaxhighlight lang="lua">if Map.Rand(100, "Add Oasis Lua") <= 5 then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0172}}<syntaxhighlight lang="lua">island_setting = 1 + Map.Rand(4, "Random Temperature - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0389}}<syntaxhighlight lang="lua">local x_shrinkage = Map.Rand(8, "Cell Width adjustment - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0435}}<syntaxhighlight lang="lua">local die_1 = Map.Rand(4, "Diceroll - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0547}}<syntaxhighlight lang="lua">local y_shrinkage = Map.Rand(9, "Cell Height adjustment - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0561}}<syntaxhighlight lang="lua">fTilt = 70 + Map.Rand(41, "Angle for island chain axis - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0580}}<syntaxhighlight lang="lua">local iInnerSouth2 = iCellHeight + 2 + Map.Rand(iCellHeight - 3, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0615}}<syntaxhighlight lang="lua">local iInnerWest1 = 3 + Map.Rand(iCellWidth - 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeLine5|0616}}<syntaxhighlight lang="lua">local iInnerSouth1 = 3 + Map.Rand(iCellHeight - 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0683}}<syntaxhighlight lang="lua">local iInnerWest2 = 4 + Map.Rand(iCellWidth + 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0687}}<syntaxhighlight lang="lua">local die_2 = Map.Rand(7, "Diceroll - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0093}}<syntaxhighlight lang="lua">local shiftRoll = Map.Rand(2, "North or South climate shift - Highlands LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0127}}<syntaxhighlight lang="lua">userInputLakes = 1 + Map.Rand(3, "Highlands Random Lake Size - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|IslandMaker.lua}}
:<code>Gameplay/Lua/IslandMaker.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0136}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(5, "Island Making - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0202}}<syntaxhighlight lang="lua">local randomX = westX + Map.Rand(iInnerWidth, "Random X coord for Dot - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0259}}<syntaxhighlight lang="lua">local randomY = iInnerSouth2 + Map.Rand(iInnerHeight2, "Random Y coord for Dot - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MapGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MapGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0207}}<syntaxhighlight lang="lua">if(plot:IsAdjacentToShallowWater() and Map.Rand(iExpansionDiceroll, "add shallows") == 0) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MapmakerUtilities.lua}}
:<code>Gameplay/Lua/MapmakerUtilities.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0563}}<syntaxhighlight lang="lua">local random_index = 1 + Map.Rand(left_to_do, "Shuffling table entry - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0866}}<syntaxhighlight lang="lua">local scRoll = Map.Rand((regiononeWidth - scLargeWidth), "Large Subcontinent Placement - Map_Script_Name LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Ring.lua}}
:<code>Maps/Ring.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">dominant_terrain = 1 + Map.Rand(4, "Random Type of Dominant Terrain - Ring LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0140}}<syntaxhighlight lang="lua">bridge_width = 2 + Map.Rand(3, "Random Bridge Width - Ring LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Shuffle.lua (G&K)}}
:<code>DLC/Expansion/Maps/Shuffle.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0076}}<syntaxhighlight lang="lua">local world_age = 1 + Map.Rand(3, "Random World Age - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0581}}<syntaxhighlight lang="lua">userInputLandmass = 1 + Map.Rand(4, "Random Landmass Type - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0668}}<syntaxhighlight lang="lua">local rain = 1 + Map.Rand(3, "Random Rainfall - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0355}}<syntaxhighlight lang="lua">local random_factor = Map.Rand(3, "River direction random factor - Skirmish LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Terra.lua}}
:<code>Maps/Terra.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0083}}<syntaxhighlight lang="lua">local roll1 = Map.Rand(2, "Eurasian Hemisphere N/S - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0329}}<syntaxhighlight lang="lua">local nwcRoll = Map.Rand(2, "Central America and Carribean Placement - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0432}}<syntaxhighlight lang="lua">local scsRoll = Map.Rand((eurasiaWidth - scSmallWidth), "Small Subcontinent Placement - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0477}}<syntaxhighlight lang="lua">local extras = 2 + Map.Rand(3, "Number of Minor Regions - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0483}}<syntaxhighlight lang="lua">local twRoll = Map.Rand((eurasiaWidth - twWidth), "Minor Region Placement - Terra Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldBuilderRandomItems.lua}}
:<code>Gameplay/Lua/WorldBuilderRandomItems.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0018}}<syntaxhighlight lang="lua">local rand1 = Map.Rand(resource.RandApp1, "MapGenerator CalculateNumResourcesToAdd-1");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0021}}<syntaxhighlight lang="lua">local rand4 = Map.Rand(resource.RandApp4, "MapGenerator CalculateNumResourcesToAdd-4");</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Rand]]

Player.InitUnit (Civ5 API)

2014-02-03T21:25:14Z

Slserpent: initial research

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Player}}. 
This is an instance method, invoke it with a colon. 
Creates a new unit for the calling player.
}}

=Usage=
<code>{{Type5|Unit}} Player:InitUnit({{Type5|UnitType}} unit, '''int''' x, '''int''' y, {{Type5|UnitAIType}} unitAI = NO_UNITAI, {{Type5|DirectionType}} facingDirection = NO_DIRECTION)</code>

Note: Using this function in a map script may crash Civilization 5.

'''Returned Value'''
:Returns a reference to the created unit.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|unit:
|valign="top"| ''The {{Type5|UnitType}} ID of the unit to be created.''
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The X coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''The Y coordinate on the map where the unit is to be created.''
|-
|valign="top" style="padding-right:6px;"|unitAI:
|valign="top"| ''Optional. The AI tactics for the unit to use upon being created.''
|-
|valign="top" style="padding-right:6px;"|facingDirection:
|valign="top"| ''The direction for the newly created unit to be facing.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 350 are listed.''

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">unit = pLoopPlayer:InitUnit (iUnitID, pLoopPlayer:GetStartingPlot():GetX(), pLoopPlayer:GetStartingPlot():GetY());</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0413}}<syntaxhighlight lang="lua">pPlayer:InitUnit (iUnitID, adjacentPlot:GetX(), adjacentPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_04 DLC}}
:<code>DLC/DLC_04/Scenarios/1066Scenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, playerStartPlot:GetX(), playerStartPlot:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0545}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 36, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0549}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 37, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0553}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 38, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0561}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 40, 6, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0599}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 21, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0607}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 19, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0615}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 52, 19, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0623}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 53, 21, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0653}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 31, 34, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0665}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 29, 33, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0669}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 30, 34, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 50, 11, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0701}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 13, UNITAI_DEFENSE, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0713}}<syntaxhighlight lang="lua">unit = player:InitUnit (iUnitID, 51, 11, UNITAI_RANGED, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/SteampunkScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0850}}<syntaxhighlight lang="lua">local pUnit = pPlayer:InitUnit(eUnitType, pPlot:GetX(), pPlot:GetY());</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/FallOfRomeScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0378}}<syntaxhighlight lang="lua">unit = newPlayer:InitUnit(iUnitID, iX, iY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1309}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 20, 47); -- Legion @ Lutetia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1323}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_BALLISTA"], 26, 49); -- Ballista @ Trier</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1330}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 22, 42); -- Horseman @ Lugundium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1344}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 49, 34); -- Archer @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1346}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 75, 26); -- Archer @ Melitene</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1352}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 76, 21); -- Catapult @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1358}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_ROMAN_LEGION"], 76, 21); -- Legion @ Edessa</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1369}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 49, 34); -- Cataphract @ Naissus</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1371}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_BYZANTINE_CATAPHRACT"], 71, 30); -- Cataphract @ Amasia</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1388}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 81, 33); -- Swordsman @ Anium</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1413}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_SWORDSMAN"], 79, 24); -- Swordsman @ Amida</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1432}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HORSEMAN"], 84, 58); -- Horseman @ Attila's Court -- extra to encourage an attack</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1442}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_HORSE_ARCHER"], 84, 58); -- Horse archer @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1448}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_HUN_BATTERING_RAM"], 84, 58); -- battering ram! @ Attila's Court</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1476}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 17, 57); -- Bowman @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1480}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 17, 57); -- Catapult @ mid-country</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1528}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 32, 54); -- Bowman @ Tongres</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1556}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_GOTH_GADRAUHT"], 50, 37); -- Gadrauht @ ERE border</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1586}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], 4, 19); -- Bowman @ Caput Vada -- added to get army up to city-attacking size</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1592}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CARTHAGINIAN_QUINQUEREME"], 4, 19); -- Tri @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1594}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_VANDAL_AXEMAN"], 4, 19); -- Axeman @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1600}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], 4, 19); -- Catapult @ Caput Vada</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1816}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CATAPULT"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1819}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_COMPOSITE_BOWMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2018}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_CELT_PICTISH_WARRIOR"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|2108}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit(GameInfoTypes["UNIT_FRANK_SEAXMAN"], iSpawnX, iSpawnY);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1064}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_DEFENSE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1276}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_WORKER, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1300}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_GENERAL, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1612}}<syntaxhighlight lang="lua">unit = pPlayer:InitUnit (iUnitID, capital:GetX(), capital:GetY(), UNITAI_SETTLE, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldView.lua}}
:<code>UI/InGame/WorldView/WorldView.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0264}}<syntaxhighlight lang="lua">pActivePlayer:InitUnit(iUnitID, plotX, plotY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|InitUnit]]
[[Category:Civ5 Units API|InitUnit]]

Plot.SetResourceType (Civ5 API)

2014-01-30T22:19:45Z

Slserpent: parameter fix

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Plot}}. 
This is an instance method, invoke it with a colon. 
Puts a resource on this plot.
}}

=Usage=
<code>'''void''' Plot:SetResourceType({{Type5|ResourceType}} resourceID, '''int''' numResource)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|resourceID:
|valign="top"| ''The integer ID of the resource to place.''
|-
|valign="top" style="padding-right:6px;"|numResource:
|valign="top"| ''For strategic resources, this is the amount of that resource to place.''
|}

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1421}}<syntaxhighlight lang="lua">res_plot:SetResourceType(selected_ID, selected_quantity);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|AssignStartingPlots.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/AssignStartingPlots.lua</code>
:{{CodeBegin5}}
{{CodeLine5|3492}}<syntaxhighlight lang="lua">plot:SetResourceType(self.banana_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3497}}<syntaxhighlight lang="lua">plot:SetResourceType(self.deer_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3502}}<syntaxhighlight lang="lua">plot:SetResourceType(self.sheep_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3509}}<syntaxhighlight lang="lua">plot:SetResourceType(self.cow_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3514}}<syntaxhighlight lang="lua">plot:SetResourceType(self.wheat_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3541}}<syntaxhighlight lang="lua">plot:SetResourceType(self.fish_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3610}}<syntaxhighlight lang="lua">plot:SetResourceType(choice, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3613}}<syntaxhighlight lang="lua">plot:SetResourceType(self.iron_ID, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|3789}}<syntaxhighlight lang="lua">plot:SetResourceType(self.stone_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|7506}}<syntaxhighlight lang="lua">res_plot:SetResourceType(res_ID[use_this_res_index], res_quantity[use_this_res_index]);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|7663}}<syntaxhighlight lang="lua">res_plot:SetResourceType(resource_ID, quantity);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|8930}}<syntaxhighlight lang="lua">res_plot:SetResourceType(self.marble_ID, 1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|9146}}<syntaxhighlight lang="lua">res_plot:SetResourceType(self.fish_ID, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldBuilderRandomItems.lua}}
:<code>Gameplay/Lua/WorldBuilderRandomItems.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0173}}<syntaxhighlight lang="lua">plot:SetResourceType(resourceID, resourceNum);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0188}}<syntaxhighlight lang="lua">otherPlot:SetResourceType(resourceID, resourceNum);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldView.lua}}
:<code>UI/InGame/WorldView/WorldView.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0190}}<syntaxhighlight lang="lua">plot:SetResourceType(g_ResourcePlopper.ResourceType, g_ResourcePlopper.ResourceAmount);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0196}}<syntaxhighlight lang="lua">plot:SetResourceType(-1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0280}}<syntaxhighlight lang="lua">plot:SetResourceType(iResourceID, 5);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|SetResourceType]]
[[Category:Civ5 Resources API|SetResourceType]]

Plot.SetNEOfRiver (Civ5 API)

2014-01-28T23:39:21Z

Slserpent: /* Usage */

Plot.SetNEOfRiver (Civ5 API)

2014-01-27T01:10:24Z

Slserpent: initial research

Fractal.BuildRidges (Civ5 API)

2014-01-26T00:06:47Z

Slserpent: fixes and such

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is an instance method, invoke it with a colon. 
Modifies a fractal to have randomized ridges.
}}

=Usage=
<code>'''void''' Fractal:BuildRidges('''int''' numPlates, '''table''' flags, '''int''' xExponent, '''int''' yExponent)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|numPlates:
|valign="top"| ''The number of tectonic plates to use in generating the ridges. Where plates come into contact with each other, ridges are formed there.''
|-
|valign="top" style="padding-right:6px;"|flags:
|valign="top"| ''A table that holds certain additional options used in creating the fractal. See Fractal.Create().''
|-
|valign="top" style="padding-right:6px;"|xExponent:
|valign="top"| ''Amount of blurring to apply along X axis. 0 is no blur. 7 is high blur. Negative values sharpen?''
|-
|valign="top" style="padding-right:6px;"|yExponent:
|valign="top"| ''Amount of blurring to apply along Y axis. 0 is no blur. 7 is high blur. Negative values sharpen?''
|}

'''Example''' 
This example will create a fractal and use it to build ridges based on the size of the map. It then loops through each value in the 2D fractal array and creates mountains if the value is greater than the highest 3% of all the values.
<syntaxhighlight lang="lua" class="civ5-example">
local iW, iH = Map.GetGridSize()
local mountains = Fractal.Create(iW, iH, 3, {FRAC_WRAP_X = true}, -1, -1)
mountains:BuildRidges((iW * iH) / 200, {}, 1, 1)
local mountainThreshold = mountains:GetHeight(97);
for y = 0, iH - 1 do
for x = 0, iW - 1 do
local height = mountains:GetHeight(x, y)
--print (x .. ", " .. y .. ": " .. height)
if height >= mountainThreshold then
local plot = Map.GetPlot(x, y)
plot:SetPlotType(PlotTypes.PLOT_MOUNTAIN, false, false)
end
end
end
</syntaxhighlight>

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0129}}<syntaxhighlight lang="lua">hillsFrac:BuildRidges(numPlates, iFlags, 1, 2);</syntaxhighlight>
{{CodeLine5|0130}}<syntaxhighlight lang="lua">mountainsFrac:BuildRidges((numPlates * 0.75), iFlags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">self.hillsFrac:BuildRidges(numPlates, {FRAC_WRAP_X = true}, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0104}}<syntaxhighlight lang="lua">self.mountainsFrac:BuildRidges((numPlates * 2) / 3, {}, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0090}}<syntaxhighlight lang="lua">self.continentsFrac:BuildRidges(numPlates, ridge_flags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0674}}<syntaxhighlight lang="lua">self.hillsFrac:BuildRidges(numPlates, hills_ridge_flags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0676}}<syntaxhighlight lang="lua">self.mountainsFrac:BuildRidges((numPlates * 2) / 3, peaks_ridge_flags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0174}}<syntaxhighlight lang="lua">mountain_passFrac:BuildRidges(numPlates, iFlags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0176}}<syntaxhighlight lang="lua">terrainFrac:BuildRidges(numPlates, iFlags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|BuildRidges]]
[[Category:Civ5 Improvements API|BuildRidges]]

Fractal (Civ5 Type)

2014-01-26T00:03:37Z

Slserpent: /* Instance Methods */

Fractal.BuildRidges (Civ5 API)

2014-01-25T23:44:30Z

Slserpent: initial research

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is an instance method, invoke it with a colon. 
Modifies a fractal to have randomized ridges.
}}

=Usage=
<code>'''void''' Fractal:BuildRidges('''int''' numPlates, '''table''' flags, '''int''' arg2, '''int''' arg3)</code>

'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|numPlates:
|valign="top"| ''The number of tectonic plates to use in generating the ridges. Where plates come into contact with each other, ridges are formed there.''
|-
|valign="top" style="padding-right:6px;"|flags:
|valign="top"| ''A table that holds certain additional options used in creating the fractal. See Fractal.Create().''
|-
|valign="top" style="padding-right:6px;"|arg2:
|valign="top"| ''No description available.''
|-
|valign="top" style="padding-right:6px;"|arg3:
|valign="top"| ''No description available.''
|}

'''Example'''
This example will create a fractal and use it to build ridges based on the size of the map. It then loops through each value in the 2D fractal array and creates mountains if the value is greater than the highest 3% of all the values.
<syntaxhighlight lang="lua" class="civ5-example">
local iW, iH = Map.GetGridSize()
local mountains = Fractal.Create(iW, iH, 3, {FRAC_WRAP_X = true}, -1, -1)
mountains:BuildRidges((iW * iH) / 200, {}, 1, 1)
local mountainThreshold = mountains:GetHeight(97);
for y = 0, iH - 1 do
for x = 0, iW - 1 do
local height = mountains:GetHeight(x, y)
--print (x .. ", " .. y .. ": " .. height)
if height >= mountainThreshold then
local plot = Map.GetPlot(x, y)
plot:SetPlotType(PlotTypes.PLOT_MOUNTAIN, false, false)
end
end
end
</syntaxhighlight>

=Source code samples=
''Redundant occurences have been removed.''

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0129}}<syntaxhighlight lang="lua">hillsFrac:BuildRidges(numPlates, iFlags, 1, 2);</syntaxhighlight>
{{CodeLine5|0130}}<syntaxhighlight lang="lua">mountainsFrac:BuildRidges((numPlates * 0.75), iFlags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">self.hillsFrac:BuildRidges(numPlates, {FRAC_WRAP_X = true}, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0104}}<syntaxhighlight lang="lua">self.mountainsFrac:BuildRidges((numPlates * 2) / 3, {}, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0090}}<syntaxhighlight lang="lua">self.continentsFrac:BuildRidges(numPlates, ridge_flags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0674}}<syntaxhighlight lang="lua">self.hillsFrac:BuildRidges(numPlates, hills_ridge_flags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0676}}<syntaxhighlight lang="lua">self.mountainsFrac:BuildRidges((numPlates * 2) / 3, peaks_ridge_flags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0174}}<syntaxhighlight lang="lua">mountain_passFrac:BuildRidges(numPlates, iFlags, 1, 2);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0176}}<syntaxhighlight lang="lua">terrainFrac:BuildRidges(numPlates, iFlags, 6, 1);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|BuildRidges]]
[[Category:Civ5 Improvements API|BuildRidges]]

Fractal.Create (Civ5 API)

2014-01-25T22:52:08Z

Slserpent: /* Usage */

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is a static method, invoke it with a dot. 
Used to create a 2D-array of random values using [Fractal] (insert wikipedia link here) math.
}}

=Usage=
<code>{{Type5|Fractal}} Fractal.Create('''int''' width, '''int''' height, '''int''' grain, '''table''' fractalFlags, '''int''' xExponent, '''int''' yExponent)</code>

'''Returned Value'''
:Returns an instance of Fractal.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|width:
|valign="top"| ''The width of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|height:
|valign="top"| ''The height of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|grain:
|valign="top"| ''Amount of grain to add to fractal. 0 is no grain (smooth), 7 is lots of grain (jagged).''
|-
|valign="top" style="padding-right:6px;"|fractalFlags:
|valign="top"| ''A table that holds certain additional options used in creating the fractal. See below.''
|-
|valign="top" style="padding-right:6px;"|xExponent:
|valign="top"| ''Amount of blurring to apply along X axis. 0 is no blur. 7 is high blur. Negative values sharpen?''
|-
|valign="top" style="padding-right:6px;"|yExponent:
|valign="top"| ''Amount of blurring to apply along Y axis. 0 is no blur. 7 is high blur. Negative values sharpen?''
|}

'''Fractal Flags'''

:{|
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_WRAP_X:
|valign="top"| ''Whether or not the fractal should wrap around the X axis.''
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_POLAR:
|valign="top"| ''???''
|}

=Source code samples=
''Too many occurences. Only 50 out of 130 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0269}}<syntaxhighlight lang="lua">local grass_check = Fractal.Create(iW, iH, 5, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0270}}<syntaxhighlight lang="lua">local desert_check = Fractal.Create(iW, iH, 4, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0366}}<syntaxhighlight lang="lua">local marshes = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0367}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0126}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, 2, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0127}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0128}}<syntaxhighlight lang="lua">local mountainsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local snowFrac = Fractal.Create(iW, iH, 3, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local snowFrac2 = Fractal.Create(iW, 1 + math.floor(iH * 0.4), 2, iFlags, 7, 6);</syntaxhighlight>
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsFrac = Fractal.Create(iW, iH, 4, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0102}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, 4, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0440}}<syntaxhighlight lang="lua">local snow_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0441}}<syntaxhighlight lang="lua">local tundra_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0442}}<syntaxhighlight lang="lua">local grass_frac = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0128}}<syntaxhighlight lang="lua">self.jungles = Fractal.Create(width, height, self.jungle_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0129}}<syntaxhighlight lang="lua">self.forests = Fractal.Create(width, height, self.forest_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0130}}<syntaxhighlight lang="lua">self.forestclumps = Fractal.Create(width, height, self.clump_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0059}}<syntaxhighlight lang="lua">self.riftsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, rift_grain, {}, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0062}}<syntaxhighlight lang="lua">self.continentsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, continent_grain, fracFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0662}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0663}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0070}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0071}}<syntaxhighlight lang="lua">local regionsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0361}}<syntaxhighlight lang="lua">local rocky = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0362}}<syntaxhighlight lang="lua">local plains = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0363}}<syntaxhighlight lang="lua">local east = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0364}}<syntaxhighlight lang="lua">local variation = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0492}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, iFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1490}}<syntaxhighlight lang="lua">local herds = Fractal.Create(iW, iH, 7, {}, -1, -1)</syntaxhighlight>
{{CodeLine5|1491}}<syntaxhighlight lang="lua">local iHerdsClumps = herds:GetHeight(3)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0820}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iW, iH, 5, {}, 7, 7);</syntaxhighlight>
{{CodeLine5|0821}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iW, iH, 6, {}, 7, 7);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0169}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0170}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0171}}<syntaxhighlight lang="lua">local mountain_passFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InlandSea.lua}}
:<code>Maps/InlandSea.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local seaFrac = Fractal.Create(iWidth, iHeight, grain, fracFlags, -1, -1)</syntaxhighlight>
{{CodeLine5|0074}}<syntaxhighlight lang="lua">local seaThreshold = seaFrac:GetHeight(47);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Lakes.lua}}
:<code>Maps/Lakes.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">local riftsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRiftGrain, {}, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0341}}<syntaxhighlight lang="lua">regionContinentsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionGrain, iRegionPlotFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0350}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeLine5|0351}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain + 1, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0708}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeLine5|0709}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|North_vs_South.lua}}
:<code>Maps/North_vs_South.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0090}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Oval.lua}}
:<code>Maps/Oval.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local baysFrac = Fractal.Create(iW, iH, 3, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0146}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0151}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0108}}<syntaxhighlight lang="lua">self.deserts = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0109}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0110}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0115}}<syntaxhighlight lang="lua">self.plains = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0116}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0117}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Create]]
[[Category:Civ5 City Production API|Create]]

Map.PlotDirection (Civ5 API)

2014-01-25T06:34:08Z

Slserpent: filling out basics

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Map}}. 
This is a static method, invoke it with a dot. 
Gets a plot adjacent to the map coordinates given.
}}

=Usage=
<code>{{Type5|Plot}} Map.PlotDirection('''int''' x, '''int''' y, '''int''' direction)</code>

'''Returned Value'''
:An adjacent {{Type5|Plot}} based on the coordinates and direction given.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''The x coordinate of the plot of which to get the adjacent plot.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''The y coordinate of the plot of which to get the adjacent plot.''
|-
|valign="top" style="padding-right:6px;"|direction:
|valign="top"| ''An integer specifying the direction of the adjacent plot relative to the coordinates given. Enumerated in {{Type5|DirectionType}}.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 283 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0457}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(riverPlot:GetX(), riverPlot:GetY(), DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0463}}<syntaxhighlight lang="lua">riverPlot = Map.PlotDirection(riverPlot:GetX(), riverPlot:GetY(), DirectionTypes.DIRECTION_NORTHEAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0466}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(riverPlot:GetX(), riverPlot:GetY(), DirectionTypes.DIRECTION_SOUTHEAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0474}}<syntaxhighlight lang="lua">riverPlot = Map.PlotDirection(startPlot:GetX(), startPlot:GetY(), DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0478}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(riverPlot:GetX(), riverPlot:GetY(), DirectionTypes.DIRECTION_SOUTHWEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0486}}<syntaxhighlight lang="lua">riverPlot = Map.PlotDirection(startPlot:GetX(), startPlot:GetY(), DirectionTypes.DIRECTION_SOUTHWEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0544}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(plot:GetX(), plot:GetY(), direction);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0655}}<syntaxhighlight lang="lua">riverPlot = Map.PlotDirection(riverPlot:GetX(), riverPlot:GetY(), DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0674}}<syntaxhighlight lang="lua">return Map.PlotDirection(riverPlotX, riverPlotY, DirectionTypes.DIRECTION_NORTHWEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0678}}<syntaxhighlight lang="lua">return Map.PlotDirection(riverPlotX, riverPlotY, DirectionTypes.DIRECTION_NORTHEAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0682}}<syntaxhighlight lang="lua">return Map.PlotDirection(riverPlotX, riverPlotY, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0686}}<syntaxhighlight lang="lua">return Map.PlotDirection(riverPlotX, riverPlotY, DirectionTypes.DIRECTION_SOUTHWEST);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0690}}<syntaxhighlight lang="lua">return Map.PlotDirection(riverPlotX, riverPlotY, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|AssignStartingPlots.lua}}
:<code>Gameplay/Lua/AssignStartingPlots.lua</code>
:{{CodeBegin5}}
{{CodeLine5|5000}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5001}}<syntaxhighlight lang="lua">if adjPlot:IsLake() then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|AssignStartingPlots.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/AssignStartingPlots.lua</code>
:{{CodeBegin5}}
{{CodeLine5|5194}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5195}}<syntaxhighlight lang="lua">if adjPlot == nil then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|5343}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5344}}<syntaxhighlight lang="lua">local plotType = adjPlot:GetPlotType();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|5421}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5422}}<syntaxhighlight lang="lua">local terrainType = adjPlot:GetTerrainType();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|5516}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5517}}<syntaxhighlight lang="lua">local featureType = adjPlot:GetFeatureType();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|5964}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|5965}}<syntaxhighlight lang="lua">if adjPlot:GetTerrainType() ~= TerrainTypes.TERRAIN_COAST then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0367}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|0368}}<syntaxhighlight lang="lua">if adjPlot ~= nil then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0329}}<syntaxhighlight lang="lua">local nextPlot = Map.PlotDirection(currentX, currentY, currentDirection);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1051}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|1052}}<syntaxhighlight lang="lua">plotType = adjPlot:GetPlotType();</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InGame.lua}}
:<code>UI/InGame/InGame.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0485}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(unitX, unitY, thisDirection);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MapmakerUtilities.lua}}
:<code>Gameplay/Lua/MapmakerUtilities.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0319}}<syntaxhighlight lang="lua">local testPlot = Map.PlotDirection(x, y, current_direction);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0372}}<syntaxhighlight lang="lua">local NEPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_NORTHEAST);</syntaxhighlight>
{{CodeLine5|0373}}<syntaxhighlight lang="lua">local EPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_EAST);</syntaxhighlight>
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local SEPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_SOUTHEAST);</syntaxhighlight>
{{CodeLine5|0375}}<syntaxhighlight lang="lua">local SWPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_SOUTHWEST);</syntaxhighlight>
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local WPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_WEST);</syntaxhighlight>
{{CodeLine5|0377}}<syntaxhighlight lang="lua">local NWPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_NORTHWEST);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|NaturalWondersCustomMethods.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/NaturalWondersCustomMethods.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0038}}<syntaxhighlight lang="lua">local SEPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_SOUTHEAST)</syntaxhighlight>
{{CodeLine5|0039}}<syntaxhighlight lang="lua">local southeastX = SEPlot:GetX();</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0042}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(southeastX, southeastY, direction)</syntaxhighlight>
{{CodeLine5|0043}}<syntaxhighlight lang="lua">if adjPlot == nil then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0066}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|0067}}<syntaxhighlight lang="lua">if adjPlot:IsWater() == false then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0154}}<syntaxhighlight lang="lua">local SEPlot = Map.PlotDirection(x, y, DirectionTypes.DIRECTION_SOUTHEAST)</syntaxhighlight>
{{CodeLine5|0155}}<syntaxhighlight lang="lua">if not SEPlot:IsWater() then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0167}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(southeastX, southeastY, direction)</syntaxhighlight>
{{CodeLine5|0168}}<syntaxhighlight lang="lua">if adjPlot:GetTerrainType() ~= TerrainTypes.TERRAIN_COAST then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0212}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(x, y, direction)</syntaxhighlight>
{{CodeLine5|0213}}<syntaxhighlight lang="lua">if adjPlot:GetPlotType() == PlotTypes.PLOT_OCEAN then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua - DLC_02 DLC}}
:<code>DLC/DLC_02/Scenarios/NewWorldScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0401}}<syntaxhighlight lang="lua">local adjacentPlot = Map.PlotDirection(pPlot:GetX(), pPlot:GetY(), direction);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TurnsRemaining.lua (G&K)}}
:<code>DLC/Expansion/Scenarios/MedievalScenario/TurnsRemaining.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1042}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(pPlot:GetX(), pPlot:GetY(), direction);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1398}}<syntaxhighlight lang="lua">local adjPlot = Map.PlotDirection(iX, iY, direction);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldBuilderRandomItems.lua}}
:<code>Gameplay/Lua/WorldBuilderRandomItems.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0060}}<syntaxhighlight lang="lua">local otherPlot = Map.PlotDirection(plotX, plotY, direction);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|PlotDirection]]

Map (Civ5 Type)

2014-01-25T04:45:58Z

Slserpent: /* R */

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

=Static Methods=
Methods are functions that belong to an object. Static methods are invoked through a '''dot''', as in <code>Map.SomeMethod(<args>)</code>. When a dot is used the caller object is not implicitly provided as the first argument.
==A==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>iterator({{Type5|AreaID}}, {{Type5|Area}})</code>
|width="100%" |<code>{{FuncLabel5|Map|Areas}}()</code>
|}

==C==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Map|CalculateAreas}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Map|ChangeAIMapHint}}('''int''' oneForNavalExpansion)</code>
|}

==D==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Map|DefaultContinentStamper}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|DoPlaceNaturalWonders}}</code>
|}

==F==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Area}}</code>
|width="100%" |<code>{{FuncLabel5|Map|FindBiggestArea}}('''bool''' ocean)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Map|FindWater}}({{Type5|Plot}} plot, '''int''' range, '''bool''' isFreshWater)</code>
|}

==G==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetAIMapHint}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Area}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetArea}}({{Type5|AreaID}} areaID)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ClimateType}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetClimate}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetCustomOption}}('''int''' optionIndex)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetFractalFlags}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int''', '''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetGridSize}}()</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetIndexAfterLastArea}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetLandPlots}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetNumAreas}}</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetNumLandAreas}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetNumPlots}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetNumResources}}({{Type5|ResourceType}} resource)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetNumResourcesOnLand}}({{Type5|ResourceType}} resource)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetPlot}}('''int''' x, '''int''' y = nil)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetPlotByIndex}}({{Type5|PlotID}} index)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetPlotXY}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|ResourceType}}</code>
|width="100%" |<code>{{FuncLabel5|Map|GetRandomResourceQuantity}}({{Type5|ResourceType}} resource)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Map|GetSeaLevel}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|GetWorldSize}}()</code>
|}

==I==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|IsPlot}}</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|IsWrapX}}()</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''bool'''</code>
|width="100%" |<code>{{FuncLabel5|Map|IsWrapY}}()</code>
|}

==M==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|MaxPlotDistance}}</code>
|}

==P==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Map|PlotDirection}}('''int''' x, '''int''' y)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|PlotDistance}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>{{Type5|Plot}}</code>
|width="100%" |<code>{{FuncLabel5|Map|PlotXYWithRangeCheck}}('''int''' x, '''int''' y, '''int''' xOffset, '''int''' yOffset, '''int''' maxRange)</code>
|}

==R==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code>'''int'''</code>
|width="100%" |<code>{{FuncLabel5|Map|Rand}}('''int''' maxValues, '''string''' logEntry)</code>

|-
{{FuncInfos5|yes |yes |no |}}
|align="right" |<code></code>
|width="100%" |<code>{{FuncLabel5|Map|RecalculateAreas}}()</code>
|}

==U==
{|cellspacing="4" cellpadding="0" width="100%"
|-
| [[File:Civ5-16.png|Base game]] || [[File:GK.png|Gods & Kings]] || || || <code style="visibility:hidden;">___________________________</code>

|-
{{FuncInfos5|yesNeverUsed|yesNeverUsed|no |}}
|align="right" |<code>{{UnknownSignature5}}</code>
|width="100%" |<code>{{FuncLabel5|Map|UpdateDeferredFog}}</code>
|}

{{Civ5 API Footer}}
[[Category:Civ5 Types|Map]]

Map.Rand (Civ5 API)

2014-01-25T04:44:21Z

Slserpent: not your typical rand function

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Map}}. 
This is a static method, invoke it with a dot. 
Generates a random number.
}}

=Usage=
<code>'''int''' Map.Rand('''int''' maxValues, '''string''' logEntry)</code>

'''Returned Value'''
:A random number between 0 and maxValues - 1.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|maxValues:
|valign="top"| ''The number of possible random values to make.''
|-
|valign="top" style="padding-right:6px;"|logEntry:
|valign="top"| ''Not optional, but in what log does this appear?''
|}

=Source code samples=
''Too many occurences. Only 50 out of 668 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|1134}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(10000, "Choose resource type - Assign Luxury To Region - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1390}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(3, "Resource selection - Place Small Quantities LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1417}}<syntaxhighlight lang="lua">local strat_radius = Map.Rand(4, "Resource Radius - Place Small Quantities LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Arborea.lua (G&K)}}
:<code>DLC/Expansion/Maps/Arborea.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0115}}<syntaxhighlight lang="lua">sea_level = 1 + Map.Rand(3, "Random Sea Level - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0529}}<syntaxhighlight lang="lua">local grain_dice = Map.Rand(7, "Continental Grain roll - LUA Continents");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0535}}<syntaxhighlight lang="lua">local rift_dice = Map.Rand(3, "Rift Grain roll - LUA Continents");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0679}}<syntaxhighlight lang="lua">age = 1 + Map.Rand(3, "Random World Age - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0721}}<syntaxhighlight lang="lua">temp = 1 + Map.Rand(3, "Random Temperature - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|AssignStartingPlots.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/AssignStartingPlots.lua</code>
:{{CodeBegin5}}
{{CodeLine5|4291}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(iNumConversionCandidates, "Choosing plot to convert to Grass near food-poor Plains start - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|4971}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(table.maxn(candidate_regions), "Choosing from among Candidate Regions for start bias - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|7671}}<syntaxhighlight lang="lua">res_addition = Map.Rand(1 + (max_radius - min_radius), "Resource Radius - Place Resource LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0532}}<syntaxhighlight lang="lua">x_target = math.floor(iW / 5 + Map.Rand((iW * 0.6), "River Target - Lua"));</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0074}}<syntaxhighlight lang="lua">west_edge[y] = math.ceil(iW * 0.08) - 1 + Map.Rand(4, "Roughen coastline - Mediterranean LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0340}}<syntaxhighlight lang="lua">local atoll_number = atoll_target + Map.Rand(atoll_target, "Number of Atolls to place - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0435}}<syntaxhighlight lang="lua">local diceroll = 1 + Map.Rand(100, "Atoll Placement Type - LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0341}}<syntaxhighlight lang="lua">local segmentLength = Map.Rand(primaryMaxLength + 1, "FractalWorld Center Rift Segment Length - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0346}}<syntaxhighlight lang="lua">local dice = Map.Rand(2, "FractalWorld Center Rift Direction - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0179}}<syntaxhighlight lang="lua">rightSeed = Map.Rand(5, "Ozarks Shape - Great Plains Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0517}}<syntaxhighlight lang="lua">if Map.Rand(100, "Add Oasis Lua") <= 5 then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0172}}<syntaxhighlight lang="lua">island_setting = 1 + Map.Rand(4, "Random Temperature - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0389}}<syntaxhighlight lang="lua">local x_shrinkage = Map.Rand(8, "Cell Width adjustment - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0435}}<syntaxhighlight lang="lua">local die_1 = Map.Rand(4, "Diceroll - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0547}}<syntaxhighlight lang="lua">local y_shrinkage = Map.Rand(9, "Cell Height adjustment - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0561}}<syntaxhighlight lang="lua">fTilt = 70 + Map.Rand(41, "Angle for island chain axis - LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0580}}<syntaxhighlight lang="lua">local iInnerSouth2 = iCellHeight + 2 + Map.Rand(iCellHeight - 3, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0615}}<syntaxhighlight lang="lua">local iInnerWest1 = 3 + Map.Rand(iCellWidth - 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeLine5|0616}}<syntaxhighlight lang="lua">local iInnerSouth1 = 3 + Map.Rand(iCellHeight - 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0683}}<syntaxhighlight lang="lua">local iInnerWest2 = 4 + Map.Rand(iCellWidth + 2, "Shift for sub island group - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0687}}<syntaxhighlight lang="lua">local die_2 = Map.Rand(7, "Diceroll - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0093}}<syntaxhighlight lang="lua">local shiftRoll = Map.Rand(2, "North or South climate shift - Highlands LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0127}}<syntaxhighlight lang="lua">userInputLakes = 1 + Map.Rand(3, "Highlands Random Lake Size - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|IslandMaker.lua}}
:<code>Gameplay/Lua/IslandMaker.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0136}}<syntaxhighlight lang="lua">local diceroll = Map.Rand(5, "Island Making - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0202}}<syntaxhighlight lang="lua">local randomX = westX + Map.Rand(iInnerWidth, "Random X coord for Dot - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0259}}<syntaxhighlight lang="lua">local randomY = iInnerSouth2 + Map.Rand(iInnerHeight2, "Random Y coord for Dot - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MapGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MapGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0207}}<syntaxhighlight lang="lua">if(plot:IsAdjacentToShallowWater() and Map.Rand(iExpansionDiceroll, "add shallows") == 0) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MapmakerUtilities.lua}}
:<code>Gameplay/Lua/MapmakerUtilities.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0563}}<syntaxhighlight lang="lua">local random_index = 1 + Map.Rand(left_to_do, "Shuffling table entry - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0866}}<syntaxhighlight lang="lua">local scRoll = Map.Rand((regiononeWidth - scLargeWidth), "Large Subcontinent Placement - Map_Script_Name LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Ring.lua}}
:<code>Maps/Ring.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">dominant_terrain = 1 + Map.Rand(4, "Random Type of Dominant Terrain - Ring LUA");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0140}}<syntaxhighlight lang="lua">bridge_width = 2 + Map.Rand(3, "Random Bridge Width - Ring LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Shuffle.lua (G&K)}}
:<code>DLC/Expansion/Maps/Shuffle.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0076}}<syntaxhighlight lang="lua">local world_age = 1 + Map.Rand(3, "Random World Age - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0581}}<syntaxhighlight lang="lua">userInputLandmass = 1 + Map.Rand(4, "Random Landmass Type - Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0668}}<syntaxhighlight lang="lua">local rain = 1 + Map.Rand(3, "Random Rainfall - Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0355}}<syntaxhighlight lang="lua">local random_factor = Map.Rand(3, "River direction random factor - Skirmish LUA");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Terra.lua}}
:<code>Maps/Terra.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0083}}<syntaxhighlight lang="lua">local roll1 = Map.Rand(2, "Eurasian Hemisphere N/S - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0329}}<syntaxhighlight lang="lua">local nwcRoll = Map.Rand(2, "Central America and Carribean Placement - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0432}}<syntaxhighlight lang="lua">local scsRoll = Map.Rand((eurasiaWidth - scSmallWidth), "Small Subcontinent Placement - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0477}}<syntaxhighlight lang="lua">local extras = 2 + Map.Rand(3, "Number of Minor Regions - Terra Lua");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0483}}<syntaxhighlight lang="lua">local twRoll = Map.Rand((eurasiaWidth - twWidth), "Minor Region Placement - Terra Lua");</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|WorldBuilderRandomItems.lua}}
:<code>Gameplay/Lua/WorldBuilderRandomItems.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0018}}<syntaxhighlight lang="lua">local rand1 = Map.Rand(resource.RandApp1, "MapGenerator CalculateNumResourcesToAdd-1");</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0021}}<syntaxhighlight lang="lua">local rand4 = Map.Rand(resource.RandApp4, "MapGenerator CalculateNumResourcesToAdd-4");</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Rand]]

Fractal.GetHeight (Civ5 API)

2014-01-24T23:36:43Z

Slserpent: further research on the alternate usage

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is an instance method, invoke it with a colon. 
Used to get the value of the 2D fractal array or the value of a certain percentage of the array.
}}

=Usage=
<code>'''int''' Fractal:GetHeight('''int''' percentage)</code>

'''Returned Value'''
:Returns the threshold value of a percentage of the fractal array. For example, if you pass in 70, this function will return a number close to 178, give or take some depending on the breakdown of the values in the array. Seems to have trouble with smaller arrays (<10x10).
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''X coordinate of the value to retrieve.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''Y coordinate of the value to retrieve.''
|}

<code>'''int''' Fractal:GetHeight('''int''' x, '''int''' y)</code>

'''Returned Value'''
:Returns the value of the fractal array at coordinates X, Y. The value is between 0 and 255.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''X coordinate of the value to retrieve.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''Y coordinate of the value to retrieve.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 603 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0075}}<syntaxhighlight lang="lua">local iHillsTop2 = hillsFrac:GetHeight(80);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0080}}<syntaxhighlight lang="lua">local iPeakAndes = peaksFrac:GetHeight(63);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0271}}<syntaxhighlight lang="lua">local iAndesGrass = grass_check:GetHeight(65)</syntaxhighlight>
{{CodeLine5|0272}}<syntaxhighlight lang="lua">local iAndesDesert = desert_check:GetHeight(75)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0312}}<syntaxhighlight lang="lua">local desertVal = desert_check:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iOpenLevel = open_lands:GetHeight(100 - iOpenPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local featureForest = FeatureTypes.FEATURE_FOREST;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0397}}<syntaxhighlight lang="lua">if plot:CanHaveFeature(featureForest) and forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0418}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0423}}<syntaxhighlight lang="lua">if marshes:GetHeight(x, y) >= iRiverMarshLevel then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">local iLakesThreshold = lakesFrac:GetHeight(94);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0138}}<syntaxhighlight lang="lua">local iHillsNearMountains = mountainsFrac:GetHeight(hillsNearMountains);</syntaxhighlight>
{{CodeLine5|0139}}<syntaxhighlight lang="lua">local iMountainThreshold = mountainsFrac:GetHeight(mountains);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0148}}<syntaxhighlight lang="lua">local lakeVal = lakesFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0153}}<syntaxhighlight lang="lua">local hillVal = hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0184}}<syntaxhighlight lang="lua">local iSnowThreshold = snowFrac:GetHeight(65);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">local iHillsTop2 = self.hillsFrac:GetHeight(75);</syntaxhighlight>
{{CodeLine5|0114}}<syntaxhighlight lang="lua">local iHillsClumps = self.mountainsFrac:GetHeight(4);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0447}}<syntaxhighlight lang="lua">local iGrassTop = grass_frac:GetHeight(iGrassPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0520}}<syntaxhighlight lang="lua">local val = snow_frac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0257}}<syntaxhighlight lang="lua">local marsh_height = self.marsh:GetHeight(iX, iY)</syntaxhighlight>
{{CodeLine5|0258}}<syntaxhighlight lang="lua">if(marsh_height >= self.iMarshLevel) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0276}}<syntaxhighlight lang="lua">if (self.forests:GetHeight(iX, iY) >= self.iForestLevel) or (self.forestclumps:GetHeight(iX, iY) >= self.iClumpLevel) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0680}}<syntaxhighlight lang="lua">local iHillsBottom1 = self.hillsFrac:GetHeight(hillsBottom1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">local iMountain95 = self.mountainsFrac:GetHeight(95);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0717}}<syntaxhighlight lang="lua">local hillVal = self.hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local iPlainsThreshold = hillsFrac:GetHeight(8);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">lat = lat + (128 - regionsFrac:GetHeight(x, y))/(255.0 * 5.0);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iTexDesertBottom = plains:GetHeight(iTexDesertBottomPercent)</syntaxhighlight>
{{CodeLine5|0375}}<syntaxhighlight lang="lua">local iGrassTop = plains:GetHeight(iGrassTopPercent)</syntaxhighlight>
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local iGrassBottom = plains:GetHeight(iGrassBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0379}}<syntaxhighlight lang="lua">local iEastDTop = east:GetHeight(iEastDTopPercent)</syntaxhighlight>
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local iEastDBottom = east:GetHeight(iEastDBottomPercent)</syntaxhighlight>
{{CodeLine5|0381}}<syntaxhighlight lang="lua">local iEastPTop = east:GetHeight(iEastPTopPercent)</syntaxhighlight>
{{CodeLine5|0382}}<syntaxhighlight lang="lua">local iEastPBottom = east:GetHeight(iEastPBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0425}}<syntaxhighlight lang="lua">local val = east:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0497}}<syntaxhighlight lang="lua">local iRockyForestLevel = forests:GetHeight(iRockyForestPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0499}}<syntaxhighlight lang="lua">local featureFloodPlains = FeatureTypes.FEATURE_FLOOD_PLAINS;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0541}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) <= iEastForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1493}}<syntaxhighlight lang="lua">local iHerdsTop1 = herds:GetHeight(27)</syntaxhighlight>
{{CodeLine5|1494}}<syntaxhighlight lang="lua">local iHerdsBottom2 = herds:GetHeight(73)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0822}}<syntaxhighlight lang="lua">local iHillsBottom1 = regionHillsFrac:GetHeight(20);</syntaxhighlight>
{{CodeLine5|0823}}<syntaxhighlight lang="lua">local iHillsTop1 = regionHillsFrac:GetHeight(35);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0180}}<syntaxhighlight lang="lua">local iHillsThreshold = terrainFrac:GetHeight(hills);</syntaxhighlight>
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local iPeaksThreshold = terrainFrac:GetHeight(peaks);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local iPassThreshold = mountain_passFrac:GetHeight(85);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">local passVal = mountain_passFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0369}}<syntaxhighlight lang="lua">local iWaterThreshold = regionContinentsFrac:GetHeight(iWaterPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0372}}<syntaxhighlight lang="lua">local iHillsBottom2 = regionHillsFrac:GetHeight(75 - adjustment);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local val = regionContinentsFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Ring.lua}}
:<code>Maps/Ring.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0511}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(80) -- 20% forest coverage</syntaxhighlight>
{{CodeLine5|0512}}<syntaxhighlight lang="lua">self.iClumpLevel = self.forestclumps:GetHeight(94) -- 6% forest clumps</syntaxhighlight>
{{CodeLine5|0513}}<syntaxhighlight lang="lua">self.iMarshLevel = self.marsh:GetHeight(100 - self.fMarshPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">if dominant_terrain == 3 then -- Forest</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0517}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(55) -- 45% forest coverage of what isn't covered by clumps.</syntaxhighlight>
{{CodeLine5|0518}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0307}}<syntaxhighlight lang="lua">elseif desertVal >= self.deserts:GetHeight(94) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">self.iDesertBottom = self.deserts:GetHeight(self.iDesertBottomPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0119}}<syntaxhighlight lang="lua">self.iPlainsTop = self.plains:GetHeight(self.iPlainsTopPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsVal = self.plains:GetHeight(iX, iY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GetHeight]]

Fractal.GetHeight (Civ5 API)

2014-01-24T21:39:43Z

Slserpent: initial research

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is an instance method, invoke it with a colon. 
Used to get the value of the 2D fractal array.
}}

=Usage=
<code>'''int''' Fractal:GetHeight('''int''' percent?)</code>

<code>'''int''' Fractal:GetHeight('''int''' x, '''int''' y)</code>

'''Returned Value'''
:Returns the value of the fractal array at coordinates X, Y.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|x:
|valign="top"| ''X coordinate of the value to retrieve.''
|-
|valign="top" style="padding-right:6px;"|y:
|valign="top"| ''Y coordinate of the value to retrieve.''
|}

=Source code samples=
''Too many occurences. Only 50 out of 603 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0075}}<syntaxhighlight lang="lua">local iHillsTop2 = hillsFrac:GetHeight(80);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0080}}<syntaxhighlight lang="lua">local iPeakAndes = peaksFrac:GetHeight(63);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0271}}<syntaxhighlight lang="lua">local iAndesGrass = grass_check:GetHeight(65)</syntaxhighlight>
{{CodeLine5|0272}}<syntaxhighlight lang="lua">local iAndesDesert = desert_check:GetHeight(75)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0312}}<syntaxhighlight lang="lua">local desertVal = desert_check:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iOpenLevel = open_lands:GetHeight(100 - iOpenPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local featureForest = FeatureTypes.FEATURE_FOREST;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0397}}<syntaxhighlight lang="lua">if plot:CanHaveFeature(featureForest) and forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0418}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) >= iForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0423}}<syntaxhighlight lang="lua">if marshes:GetHeight(x, y) >= iRiverMarshLevel then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0132}}<syntaxhighlight lang="lua">local iLakesThreshold = lakesFrac:GetHeight(94);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0138}}<syntaxhighlight lang="lua">local iHillsNearMountains = mountainsFrac:GetHeight(hillsNearMountains);</syntaxhighlight>
{{CodeLine5|0139}}<syntaxhighlight lang="lua">local iMountainThreshold = mountainsFrac:GetHeight(mountains);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0148}}<syntaxhighlight lang="lua">local lakeVal = lakesFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0153}}<syntaxhighlight lang="lua">local hillVal = hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0184}}<syntaxhighlight lang="lua">local iSnowThreshold = snowFrac:GetHeight(65);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">local iHillsTop2 = self.hillsFrac:GetHeight(75);</syntaxhighlight>
{{CodeLine5|0114}}<syntaxhighlight lang="lua">local iHillsClumps = self.mountainsFrac:GetHeight(4);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0447}}<syntaxhighlight lang="lua">local iGrassTop = grass_frac:GetHeight(iGrassPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0520}}<syntaxhighlight lang="lua">local val = snow_frac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0257}}<syntaxhighlight lang="lua">local marsh_height = self.marsh:GetHeight(iX, iY)</syntaxhighlight>
{{CodeLine5|0258}}<syntaxhighlight lang="lua">if(marsh_height >= self.iMarshLevel) then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0276}}<syntaxhighlight lang="lua">if (self.forests:GetHeight(iX, iY) >= self.iForestLevel) or (self.forestclumps:GetHeight(iX, iY) >= self.iClumpLevel) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0680}}<syntaxhighlight lang="lua">local iHillsBottom1 = self.hillsFrac:GetHeight(hillsBottom1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0693}}<syntaxhighlight lang="lua">local iMountain95 = self.mountainsFrac:GetHeight(95);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0717}}<syntaxhighlight lang="lua">local hillVal = self.hillsFrac:GetHeight(x, y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local iPlainsThreshold = hillsFrac:GetHeight(8);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">lat = lat + (128 - regionsFrac:GetHeight(x, y))/(255.0 * 5.0);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0374}}<syntaxhighlight lang="lua">local iTexDesertBottom = plains:GetHeight(iTexDesertBottomPercent)</syntaxhighlight>
{{CodeLine5|0375}}<syntaxhighlight lang="lua">local iGrassTop = plains:GetHeight(iGrassTopPercent)</syntaxhighlight>
{{CodeLine5|0376}}<syntaxhighlight lang="lua">local iGrassBottom = plains:GetHeight(iGrassBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0379}}<syntaxhighlight lang="lua">local iEastDTop = east:GetHeight(iEastDTopPercent)</syntaxhighlight>
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local iEastDBottom = east:GetHeight(iEastDBottomPercent)</syntaxhighlight>
{{CodeLine5|0381}}<syntaxhighlight lang="lua">local iEastPTop = east:GetHeight(iEastPTopPercent)</syntaxhighlight>
{{CodeLine5|0382}}<syntaxhighlight lang="lua">local iEastPBottom = east:GetHeight(iEastPBottomPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0425}}<syntaxhighlight lang="lua">local val = east:GetHeight(x, y);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0497}}<syntaxhighlight lang="lua">local iRockyForestLevel = forests:GetHeight(iRockyForestPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0499}}<syntaxhighlight lang="lua">local featureFloodPlains = FeatureTypes.FEATURE_FLOOD_PLAINS;</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0541}}<syntaxhighlight lang="lua">if forests:GetHeight(x, y) <= iEastForestLevel then</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1493}}<syntaxhighlight lang="lua">local iHerdsTop1 = herds:GetHeight(27)</syntaxhighlight>
{{CodeLine5|1494}}<syntaxhighlight lang="lua">local iHerdsBottom2 = herds:GetHeight(73)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0822}}<syntaxhighlight lang="lua">local iHillsBottom1 = regionHillsFrac:GetHeight(20);</syntaxhighlight>
{{CodeLine5|0823}}<syntaxhighlight lang="lua">local iHillsTop1 = regionHillsFrac:GetHeight(35);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0180}}<syntaxhighlight lang="lua">local iHillsThreshold = terrainFrac:GetHeight(hills);</syntaxhighlight>
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local iPeaksThreshold = terrainFrac:GetHeight(peaks);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local iPassThreshold = mountain_passFrac:GetHeight(85);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0194}}<syntaxhighlight lang="lua">local passVal = mountain_passFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0369}}<syntaxhighlight lang="lua">local iWaterThreshold = regionContinentsFrac:GetHeight(iWaterPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0372}}<syntaxhighlight lang="lua">local iHillsBottom2 = regionHillsFrac:GetHeight(75 - adjustment);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0380}}<syntaxhighlight lang="lua">local val = regionContinentsFrac:GetHeight(x,y);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Ring.lua}}
:<code>Maps/Ring.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0511}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(80) -- 20% forest coverage</syntaxhighlight>
{{CodeLine5|0512}}<syntaxhighlight lang="lua">self.iClumpLevel = self.forestclumps:GetHeight(94) -- 6% forest clumps</syntaxhighlight>
{{CodeLine5|0513}}<syntaxhighlight lang="lua">self.iMarshLevel = self.marsh:GetHeight(100 - self.fMarshPercent)</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0515}}<syntaxhighlight lang="lua">if dominant_terrain == 3 then -- Forest</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0517}}<syntaxhighlight lang="lua">self.iForestLevel = self.forests:GetHeight(55) -- 45% forest coverage of what isn't covered by clumps.</syntaxhighlight>
{{CodeLine5|0518}}<syntaxhighlight lang="lua">end</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0307}}<syntaxhighlight lang="lua">elseif desertVal >= self.deserts:GetHeight(94) then</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0113}}<syntaxhighlight lang="lua">self.iDesertBottom = self.deserts:GetHeight(self.iDesertBottomPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0119}}<syntaxhighlight lang="lua">self.iPlainsTop = self.plains:GetHeight(self.iPlainsTopPercent);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsVal = self.plains:GetHeight(iX, iY);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|GetHeight]]

Fractal.Create (Civ5 API)

2014-01-24T20:48:01Z

Slserpent: demystifying

{{Civ5 API Beta Banner}}
''This page is a part of the [[Lua and UI Reference (Civ5)]].'' 

{{TypeInfos5|Function.png|This function is a member of {{Type5|Fractal}}. 
This is a static method, invoke it with a dot. 
Used to create a 2D-array of random values using [Fractal] (insert wikipedia link here) math.
}}

=Usage=
<code>{{Type5|Fractal}} Fractal.Create('''int''' width, '''int''' height, '''int''' grain, '''table''' fractalFlags, '''int''' xExponent, '''int''' yExponent)</code>

'''Returned Value'''
:Returns an instance of Fractal.
'''Parameters'''
:{|
|-
|valign="top" style="padding-right:6px;"|width:
|valign="top"| ''The width of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|height:
|valign="top"| ''The height of the 2D array to create.''
|-
|valign="top" style="padding-right:6px;"|grain:
|valign="top"| ''Amount of grain to add to fractal. 0 is no grain (smooth), 7 is lots of grain (jagged).''
|-
|valign="top" style="padding-right:6px;"|fractalFlags:
|valign="top"| ''A table that holds certain additional options used in creating the fractal. See below.''
|-
|valign="top" style="padding-right:6px;"|xExponent:
|valign="top"| ''Amount of blurring to apply along X axis. 0 is no blur. 7 is high blur.''
|-
|valign="top" style="padding-right:6px;"|yExponent:
|valign="top"| ''Amount of blurring to apply along Y axis. 0 is no blur. 7 is high blur.''
|}

'''Fractal Flags'''

:{|
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_WRAP_X:
|valign="top"| ''Whether or not the fractal should wrap around the X axis.''
|-
|valign="top" style="padding-right:6px;"|'''boolean''' FRAC_POLAR:
|valign="top"| ''???''
|}

=Source code samples=
''Too many occurences. Only 50 out of 130 are listed.''

{{PseudoH4|Amazon_XP.lua (G&K)}}
:<code>DLC/Expansion/Maps/Amazon_XP.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0269}}<syntaxhighlight lang="lua">local grass_check = Fractal.Create(iW, iH, 5, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0270}}<syntaxhighlight lang="lua">local desert_check = Fractal.Create(iW, iH, 4, {}, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0366}}<syntaxhighlight lang="lua">local marshes = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeLine5|0367}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, {}, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Boreal.lua (G&K)}}
:<code>DLC/Expansion/Maps/Boreal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0126}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, 2, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0127}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0128}}<syntaxhighlight lang="lua">local mountainsFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0181}}<syntaxhighlight lang="lua">local snowFrac = Fractal.Create(iW, iH, 3, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0182}}<syntaxhighlight lang="lua">local snowFrac2 = Fractal.Create(iW, 1 + math.floor(iH * 0.4), 2, iFlags, 7, 6);</syntaxhighlight>
{{CodeLine5|0183}}<syntaxhighlight lang="lua">local plainsFrac = Fractal.Create(iW, iH, 4, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|ContinentsWorld.lua}}
:<code>Gameplay/Lua/ContinentsWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0102}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, 4, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Europe.lua (G&K)}}
:<code>DLC/Expansion/Maps/Europe.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0440}}<syntaxhighlight lang="lua">local snow_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0441}}<syntaxhighlight lang="lua">local tundra_frac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0442}}<syntaxhighlight lang="lua">local grass_frac = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FeatureGenerator.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/FeatureGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0128}}<syntaxhighlight lang="lua">self.jungles = Fractal.Create(width, height, self.jungle_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0129}}<syntaxhighlight lang="lua">self.forests = Fractal.Create(width, height, self.forest_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0130}}<syntaxhighlight lang="lua">self.forestclumps = Fractal.Create(width, height, self.clump_grain, self.fractalFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|FractalWorld.lua}}
:<code>Gameplay/Lua/FractalWorld.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0059}}<syntaxhighlight lang="lua">self.riftsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, rift_grain, {}, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0062}}<syntaxhighlight lang="lua">self.continentsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, continent_grain, fracFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0662}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeLine5|0663}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iNumPlotsX, self.iNumPlotsY, grain, self.iFlags, self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Great_Plains.lua}}
:<code>Maps/Great_Plains.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0069}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0070}}<syntaxhighlight lang="lua">local peaksFrac = Fractal.Create(iW, iH, grain_amount + 1, iFlags, 6, 6);</syntaxhighlight>
{{CodeLine5|0071}}<syntaxhighlight lang="lua">local regionsFrac = Fractal.Create(iW, iH, grain_amount, iFlags, 6, 6);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0361}}<syntaxhighlight lang="lua">local rocky = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0362}}<syntaxhighlight lang="lua">local plains = Fractal.Create(iW, iH, grain_amount + 1, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0363}}<syntaxhighlight lang="lua">local east = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0364}}<syntaxhighlight lang="lua">local variation = Fractal.Create(iW, iH, grain_amount, iFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0492}}<syntaxhighlight lang="lua">local forests = Fractal.Create(iW, iH, forest_grain, iFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|1490}}<syntaxhighlight lang="lua">local herds = Fractal.Create(iW, iH, 7, {}, -1, -1)</syntaxhighlight>
{{CodeLine5|1491}}<syntaxhighlight lang="lua">local iHerdsClumps = herds:GetHeight(3)</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Hemispheres.lua (G&K)}}
:<code>DLC/Expansion/Maps/Hemispheres.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0820}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iW, iH, 5, {}, 7, 7);</syntaxhighlight>
{{CodeLine5|0821}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iW, iH, 6, {}, 7, 7);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Highlands.lua}}
:<code>Maps/Highlands.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0169}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0170}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeLine5|0171}}<syntaxhighlight lang="lua">local mountain_passFrac = Fractal.Create(iW, iH, grain, iFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|InlandSea.lua}}
:<code>Maps/InlandSea.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0073}}<syntaxhighlight lang="lua">local seaFrac = Fractal.Create(iWidth, iHeight, grain, fracFlags, -1, -1)</syntaxhighlight>
{{CodeLine5|0074}}<syntaxhighlight lang="lua">local seaThreshold = seaFrac:GetHeight(47);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Lakes.lua}}
:<code>Maps/Lakes.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|MultilayeredFractal.lua (G&K)}}
:<code>DLC/Expansion/Gameplay/Lua/MultilayeredFractal.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0338}}<syntaxhighlight lang="lua">local riftsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRiftGrain, {}, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0341}}<syntaxhighlight lang="lua">regionContinentsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionGrain, iRegionPlotFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0350}}<syntaxhighlight lang="lua">local regionHillsFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeLine5|0351}}<syntaxhighlight lang="lua">local regionPeaksFrac = Fractal.Create(iRegionWidth, iRegionHeight, iRegionHillsGrain + 1, iRegionTerrainFlags, iRegionFracXExp, iRegionFracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0708}}<syntaxhighlight lang="lua">self.hillsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeLine5|0709}}<syntaxhighlight lang="lua">self.mountainsFrac = Fractal.Create(self.iW, self.iH, grain_amount, self.iTerrainFlags, fracXExp, fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|North_vs_South.lua}}
:<code>Maps/North_vs_South.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0090}}<syntaxhighlight lang="lua">local lakesFrac = Fractal.Create(iW, iH, lake_grain, fracFlags, 6, 6);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Oval.lua}}
:<code>Maps/Oval.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0100}}<syntaxhighlight lang="lua">local baysFrac = Fractal.Create(iW, iH, 3, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|Skirmish.lua}}
:<code>Maps/Skirmish.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0146}}<syntaxhighlight lang="lua">local terrainFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0151}}<syntaxhighlight lang="lua">local hillsFrac = Fractal.Create(iW, iH, grain, fracFlags, -1, -1);</syntaxhighlight>
{{CodeEnd5}}

{{PseudoH4|TerrainGenerator.lua}}
:<code>Gameplay/Lua/TerrainGenerator.lua</code>
:{{CodeBegin5}}
{{CodeLine5|0108}}<syntaxhighlight lang="lua">self.deserts = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0109}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0110}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeBreak5}}
{{CodeLine5|0115}}<syntaxhighlight lang="lua">self.plains = Fractal.Create( self.iWidth, self.iHeight,</syntaxhighlight>
{{CodeLine5|0116}}<syntaxhighlight lang="lua">self.grain_amount, self.fractalFlags,</syntaxhighlight>
{{CodeLine5|0117}}<syntaxhighlight lang="lua">self.fracXExp, self.fracYExp);</syntaxhighlight>
{{CodeEnd5}}

{{Civ5 API Footer}}
[[Category:Civ5 Methods and Functions|Create]]
[[Category:Civ5 City Production API|Create]]