Map.PlotXYWithRangeCheck (Civ5 API)

From Civilization Modding Wiki
Jump to: navigation, search

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


Function.png This function is a member of Map.

This is a static method, invoke it with a dot.


Usage

Plot Map.PlotXYWithRangeCheck(int x, int y, int xOffset, int yOffset, int maxRange)


Returned Value

No description available.

Parameters

x: No description available.
y: No description available.
xOffset: No description available.
yOffset: No description available.
maxRange: No description available.


Source code samples

Redundant occurences have been removed.

InGame.lua

UI/InGame/InGame.lua
0456
local evalPlot = Map.PlotXYWithRangeCheck(unitX, unitY, iX, iY, iRange);


InGame.lua (G&K)

DLC/Expansion/UI/InGame/InGame.lua
0683
local pPlot = Map.PlotXYWithRangeCheck(iCityStateX, iCityStateY, iX, iY, iRange);


MapGenerator.lua (G&K)

DLC/Expansion/Gameplay/Lua/MapGenerator.lua
0639
local otherPlot = Map.PlotXYWithRangeCheck(plotX, plotY, dx, dy, uniqueRange);
0649
local otherPlot = Map.PlotXYWithRangeCheck(plotX, plotY, dx, dy, 4);


WorldBuilderRandomItems.lua

Gameplay/Lua/WorldBuilderRandomItems.lua
0180
local otherPlot   = Map.PlotXYWithRangeCheck(plot:GetX(), plot:GetY(), dx, dy, groupRange);



The initial version of this page was created by the Civ5 API Bot, see the Civ5 API Reference FAQ. Some of the texts come from the 2kgames' wiki and most of code samples are copyrighted to Firaxis.
Functions' signatures were either copied from the 2kgames' wiki, or infered from the Lua source files and the binaries. Errors are possible.
Contributors may find help in the Contributors guide to the Civ5 API.