Map and terrain (Civ5) - Revision history

DonQuich at 12:11, 25 September 2012

2012-09-25T12:11:41Z

← Older revision		Revision as of 12:11, 25 September 2012
Line 1:		Line 1:
	''This page is a part of the [[Lua and UI Reference (Civ5)\|Lua and UI Reference]].''		''This page is a part of the [[Lua and UI Reference (Civ5)\|Lua and UI Reference]].''

	== Layout ==		= Layout =

	=== Coordinates systems ===		=== Coordinates systems ===
Line 91:		Line 91:


	== Terrain ==		= Terrain =
	=== Nature ===		=== Nature ===
	The nature, aspect and value of a {{Type5\|Plot}} in civ5 are defined by the following data:		The nature, aspect and value of a {{Type5\|Plot}} in civ5 are defined by the following data:
Line 112:		Line 112:


	== Rivers ==		= Rivers =
	=== Methods ===		=== Methods ===
	[[File:RiverSides.png\|frame\|You can only query or modify three edges per plot: E, SE, SW]]		[[File:RiverSides.png\|frame\|You can only query or modify three edges per plot: E, SE, SW]]

DonQuich at 11:07, 24 September 2012

2012-09-24T11:07:23Z

← Older revision		Revision as of 11:07, 24 September 2012
Line 164:		Line 164:

	[[Category:Civ5 API]]		[[Category:Civ5 API]]
			[[Category:Civ5 Tutorials]]

DonQuich at 10:50, 24 September 2012

2012-09-24T10:50:05Z

← Older revision		Revision as of 10:50, 24 September 2012
Line 48:		Line 48:
	=== Plots indexing ===		=== Plots indexing ===
	The function Map.{{Func5\|Map\|GetPlotByIndex}}(int index) takes an index and returns a plot. This index can be computed as follow:		The function Map.{{Func5\|Map\|GetPlotByIndex}}(int index) takes an index and returns a plot. This index can be computed as follow:
	<~~syntaxhighlight lang="lua"~~ class="civ5-example">		<div class="civ5-example"><syntaxhighlight lang="lua">
	local w = Map.GetGridSize()		local w = Map.GetGridSize()
	local index = gridX + gridY * w		local index = gridX + gridY * w
	</syntaxhighlight>		</syntaxhighlight></div>


	=== Enumerating neighbor plots ===		=== Enumerating neighbor plots ===
	The best way is to use <code>Map.{{Func5\|Map\|PlotDirection}}('''int''' x, '''int''' y, {{Type5\|DirectionType}} direction)</code>.		The best way is to use <code>Map.{{Func5\|Map\|PlotDirection}}('''int''' x, '''int''' y, {{Type5\|DirectionType}} direction)</code>.
	<~~syntaxhighlight lang="lua"~~ class="civ5-example">		<div class="civ5-example"><syntaxhighlight lang="lua">
	local x, y = ... -- Initialize those		local x, y = ... -- Initialize those
	for i = 0, 5 do		for i = 0, 5 do
Line 62:		Line 62:
	-- Do something with plot		-- Do something with plot
	end		end
	</syntaxhighlight>		</syntaxhighlight></div>


Line 69:		Line 69:

	Otherwise, Map.{{Func5\|Map\|PlotXYWithRangeCheck}} offers a simple way to scan all plots within a certain range.		Otherwise, Map.{{Func5\|Map\|PlotXYWithRangeCheck}} offers a simple way to scan all plots within a certain range.
	<~~syntaxhighlight lang="lua"~~ class="civ5-example">		<div class="civ5-example"><syntaxhighlight lang="lua">
	local x, y = ... -- Initialize those		local x, y = ... -- Initialize those
	local range = 5		local range = 5
Line 80:		Line 80:
	end		end
	end		end
	</syntaxhighlight>		</syntaxhighlight></div>


Line 136:		Line 136:
	=== Generalized functions ===		=== Generalized functions ===
	The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation. Note that the HasRiver function is redundant with the {{Func5\|Plot\|IsRiverCrossing}} and {{Func5\|Plot\|IsRiverCrossingToPlot}} methods.		The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation. Note that the HasRiver function is redundant with the {{Func5\|Plot\|IsRiverCrossing}} and {{Func5\|Plot\|IsRiverCrossingToPlot}} methods.
	<~~syntaxhighlight lang="lua"~~ class="civ5-example">		<div class="civ5-example" style="clear:none;"><syntaxhighlight lang="lua">
	function HasRiver(plot, direction)		function HasRiver(plot, direction)
	if direction == 1 then return plot:IsWOfRiver() end		if direction == 1 then return plot:IsWOfRiver() end
Line 160:		Line 160:
	return SetRiver(neighbor, direction - 3, hasRiver, flowDirection)		return SetRiver(neighbor, direction - 3, hasRiver, flowDirection)
	end		end
	</syntaxhighlight>		</syntaxhighlight></div>


	[[Category:Civ5 API]]		[[Category:Civ5 API]]

DonQuich at 20:50, 21 September 2012

2012-09-21T20:50:37Z

DonQuich at 17:21, 21 September 2012

2012-09-21T17:21:38Z

← Older revision		Revision as of 17:21, 21 September 2012
Line 84:		Line 84:

	=== The world is not flat ===		=== The world is not flat ===
	Maps can be wrapped ~~around~~ X or Y. You can get those values through Map.{{Func5\|Map\|IsWrapX}}() and Map.{{Func5\|Map\|IsWrapY}}().		Maps can be wrapped along X or Y. You can get those values through Map.{{Func5\|Map\|IsWrapX}}() and Map.{{Func5\|Map\|IsWrapY}}().
	* When wrapped ~~around~~ X, reaching the west side of the map brings you to the east side.		* When wrapped along X, reaching the west side of the map brings you to the east side.
	* When wrapped ~~around~~ Y, reaching the north side brings you to the south side.		* When wrapped along Y, reaching the north side brings you to the south side.
	* A map can neither be wrapped ~~around~~ X, neither around Y. For example a map that only covers a part of the world.		* A map can neither be wrapped along X, neither around Y. For example a map that only covers a part of the world.
	* A map cannot be both wrapped ~~around~~ X and Y.		* A map cannot be both wrapped along X and Y.

DonQuich at 17:11, 21 September 2012

2012-09-21T17:11:46Z

← Older revision		Revision as of 17:11, 21 September 2012
Line 129:		Line 129:
	** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	* Two generalized getters that return true if the specified ~~plot~~ (or ~~the neighbor in~~ the specified ~~direction~~) ~~has a river~~:		* Two generalized getters that return true if there is a river in the specified direction (or towards the specified plot):
	** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>
	** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>

DonQuich at 17:10, 21 September 2012

2012-09-21T17:10:56Z

← Older revision		Revision as of 17:10, 21 September 2012
Line 130:		Line 130:
	** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	* Two generalized getters that return true if the specified plot (or the neighbor in the specified direction) has a river:		* Two generalized getters that return true if the specified plot (or the neighbor in the specified direction) has a river:
	* <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>
	* <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>

DonQuich at 17:10, 21 September 2012

2012-09-21T17:10:42Z

← Older revision		Revision as of 17:10, 21 September 2012
Line 129:		Line 129:
	** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
			* Two generalized getters that return true if the specified plot (or the neighbor in the specified direction) has a river:
			* <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>
			* <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>


	=== Generalized functions ===		=== Generalized functions ===
	The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation.		The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation. Note that the HasRiver function is redundant with the {{Func5\|Plot\|IsRiverCrossing}} and {{Func5\|Plot\|IsRiverCrossingToPlot}} methods.
	<syntaxhighlight lang="lua" class="civ5-example">		<syntaxhighlight lang="lua" class="civ5-example">
	function HasRiver(plot, direction)		function HasRiver(plot, direction)

DonQuich at 16:56, 21 September 2012

2012-09-21T16:56:17Z

← Older revision		Revision as of 16:56, 21 September 2012
Line 113:		Line 113:

	== Rivers ==		== Rivers ==
			=== Methods ===
	[[File:RiverSides.png\|frame\|You can only query or modify three edges per plot: E, SE, SW]]		[[File:RiverSides.png\|frame\|You can only query or modify three edges per plot: E, SE, SW]]
	[[File:RiverFlow.png\|frame\|Illustration of the {{Type5\|FlowDirectionType}} on every edge.]]		[[File:RiverFlow.png\|frame\|Illustration of the {{Type5\|FlowDirectionType}} on every edge.]]
Line 130:		Line 131:


			=== Generalized functions ===
	The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation.		The fact that you can only query three edges is troublesome. Here are simple functions to circumvent this limitation.
	<syntaxhighlight lang="lua" class="civ5-example">		<syntaxhighlight lang="lua" class="civ5-example">

DonQuich at 16:54, 21 September 2012

2012-09-21T16:54:05Z

@@ Line 54: / Line 54: @@
-=== Enumerating plots ===
+=== Enumerating neighbor plots ===
 If you need to enumerate plots in specific orders, you should look at [http://forums.civfanatics.com/showthread.php?t=474634 Border and plots iterator], a great library from Whoward69 who provides nice iterators for different scan orders.<br/>
@@ Line 63: / Line 74: @@
 for dx = -range, range do
      for dy = -range, range do
-       local plot = Map.PlotXYWithRangeCheck(x, y, dx, dy, range)
+        local plot = Map.PlotXYWithRangeCheck(x, y, dx, dy, range)
-       if plot then
+        if plot then
              -- Do whatever you want with this plot
-       end
+        end
      end
 end
@@ Line 102: / Line 113: @@
 == Rivers ==
-Come back later!
+[[File:RiverSides.png|frame|You can only query or modify three edges per plot: E, SE, SW]]
 [[Category:Civ5 API]]

← Older revision		Revision as of 17:11, 21 September 2012
Line 129:		Line 129:
	** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNWOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.		** <code>Plot:SetNEOfRiver('''bool''' hasRiver, {{Type5\|FlowDirectionType}} flow = -1)</code>.
	* Two generalized getters that return true if the specified ~~plot~~ (or ~~the neighbor in~~ the specified ~~direction~~) ~~has a river~~:		* Two generalized getters that return true if there is a river in the specified direction (or towards the specified plot):
	** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossing}}({{Type5\|DirectionType}} direction)</code>
	** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>		** <code>'''bool''' Plot:{{Func5\|Plot\|IsRiverCrossingToPlot}}({{Type5\|Plot}} toPlot)</code>

← Older revision		Revision as of 20:50, 21 September 2012
Line 55:		Line 55:

	=== Enumerating neighbor plots ===		=== Enumerating neighbor plots ===
	The ~~bast~~ way is to use <code>Map.{{Func5\|Map\|PlotDirection}}('''int''' x, '''int''' y, {{Type5\|DirectionType}} direction)</code>.		The best way is to use <code>Map.{{Func5\|Map\|PlotDirection}}('''int''' x, '''int''' y, {{Type5\|DirectionType}} direction)</code>.
	<syntaxhighlight lang="lua" class="civ5-example">		<syntaxhighlight lang="lua" class="civ5-example">
	local x, y = ... -- Initialize those		local x, y = ... -- Initialize those
Line 98:		Line 98:
	* {{Type5\|FeatureType}}. It can be none, forest, jungle, floodplains, marsh, oasis, ice, fallout or any natural wonder.		* {{Type5\|FeatureType}}. It can be none, forest, jungle, floodplains, marsh, oasis, ice, fallout or any natural wonder.
	* {{Type5\|ResourceType}} and a quantity value. It can be any resource: gold, gems, horses, fish, etc.		* {{Type5\|ResourceType}} and a quantity value. It can be any resource: gold, gems, horses, fish, etc.
	* {{Type5\|ImprovementType}} and a "pillaged" boolean flag. It can be any improvement: mines, farm, etc.		* {{Type5\|ImprovementType}} and a "pillaged" boolean flag. It can be any improvement: mines, farm, etc. Goodies, city ruins and barbarian camps are also improvements.
	* {{Type5\|RouteType}}. It can be none, road or railroad.		* {{Type5\|RouteType}}. It can be none, road or railroad.
	* {{Type5\|ArtStyleType}}. It can be South America, Asian, European, Middle-East, Polynesian Greco-Roman or Barbarian. It decides which graphics will be used to render the plot.		* {{Type5\|ArtStyleType}}. It can be South America, Asian, European, Middle-East, Polynesian Greco-Roman or Barbarian. It decides which graphics will be used to render the plot.
Line 118:		Line 118:
	Every plot has:		Every plot has:
	* Three status getters:		* Three status getters:
	** <code>'''bool''' Plot:IsWOfRiver()</code>.		** <code>'''bool''' Plot:IsWOfRiver()</code>. Checks the east edge (IsWOfRiver stands for "is at the west of a river")
	** <code>'''bool''' Plot:IsNWOfRiver()</code>.		** <code>'''bool''' Plot:IsNWOfRiver()</code>. SE edge.
	** <code>'''bool''' Plot:IsNEOfRiver()</code>.		** <code>'''bool''' Plot:IsNEOfRiver()</code>. SW edge.
	* Three direction getters:		* Three direction getters:
	** <code>{{Type5\|FlowDirectionType}} Plot:GetRiverEFlowDirection()</code>.		** <code>{{Type5\|FlowDirectionType}} Plot:GetRiverEFlowDirection()</code>.