FloodWML - Revision history

Jamiescott: /* Ranking terrain codes */

2013-04-11T03:15:33Z

‎Ranking terrain codes

Jamiescott: /* When to do it? */

2013-04-11T03:13:55Z

‎When to do it?

Jamiescott: /* Usage */

2013-04-11T03:11:13Z

‎Usage

Jamiescott: /* Avoiding obstacles */

2013-04-11T03:01:07Z

‎Avoiding obstacles

Jamiescott: /* Two-wave flood */

2013-04-11T02:58:15Z

‎Two-wave flood

Jamiescott: /* Switching terrain table */

2013-04-11T02:56:25Z

‎Switching terrain table

Lipk at 13:07, 18 September 2011

2011-09-18T13:07:35Z

Lipk: /* Source Code */

2011-08-29T09:54:11Z

‎Source Code

Lipk: /* Source Code */

2011-08-28T17:20:22Z

‎Source Code

Show changes

Lipk: /* Source Code */

2011-08-21T17:23:00Z

‎Source Code

@@ Line 38: / Line 38: @@
 === Ranking terrain codes ===
-When searching for the matching terrain code for a specific hex, the algorithm will iterate through the terrain table's elements in the order you gave them, and quits the iteration when the appropriate string is found. If you put the more often terrains to the front, you can achieve radical performance improvements.
+When searching for the matching terrain code for a specific hex, the algorithm will iterate through the terrain table's elements in the order you give them, and quit the iteration when the appropriate string is found. If you put the more abundant terrains to the front, you can achieve radical performance improvements.
 === Switching terrain table ===

@@ Line 35: / Line 35: @@
 === When to do it? ===
-The part consuming up most of the macro's run time is choosing the appropriate terrain type to convert the original to. If you have a wide-spreading flood, this will have to be done for many hexes. Conclusively, if you have a big flood with a big terrain table, it's likely that you'll have to optimize it.
+The part consuming most of the macro's run time is choosing the appropriate terrain type to convert. If you have a wide-spreading flood, this will have to be done for many hexes. Consequently, if you have a big flood with a big terrain table, it's likely that you'll have to optimize it.
 === Ranking terrain codes ===

@@ Line 2: / Line 2: @@
 == Usage ==
-You can find sources at the bottom of the page. It's too long to include it here.
+You can find sources at the bottom of the page. It's too long to include here.
-'''NOTE: these macros are performing lots of complex calculations thus they are quite slow. They can make your scenario lag and so make a serious blow on user experience, especially on older machines. To make sure you've minimized the negative effects, please read the Optimization section below.'''
+'''NOTE: these macros are performing lots of complex calculations thus they are quite slow. They can make your scenario lag and thus create an unwelcome user experience, especially on older machines. To make sure you've minimized the negative effects, please read the Optimization section below.'''
 === Create flood ===
   {CREATE_FLOOD "1,1;2,3" "ne,n" "Gg>Ww;Gs>Wwt" awesome_flood}
-Where "1,1;2,3" is a semicolon separated list of coordinate pairs where the flood starts from, "ne,n" is a comma separated list of directions in which the flood will spread, "Gg>Ww;Gs>Wwt" is a semicolon separated list of transformations where a>b means that the hexes with the terrain code a will be converted to b, and finally awesome_flood is the variable to store the current state of the flood in (but you might better think about it as the flood's id).
+Where "1,1;2,3" is a semicolon separated list of coordinate pairs from which the flood starts, "ne,n" is a comma separated list of directions in which the flood will spread, "Gg>Ww;Gs>Wwt" is a semicolon separated list of transformations where a>b means that the hexes with the terrain code a will be converted to b, and finally awesome_flood is the variable that stores the current state of the flood (you might better think about it as the flood's id).
 === Spread flood ===
   {SPREAD_FLOOD awesome_flood}
-Where awesome_flood is the flood's id :). This will spread the flood by on hex. If a hex with a unit is flooded, an event named 'submerged' will be fired. Example
+Where awesome_flood is the flood's id :). This will spread the flood by one hex. If a hex with a unit is flooded, an event named 'submerged' will be fired. Example
-  #kill all sunken spearmans
+  #kill all sunken spearmen
   [event]
     name=submerged
@@ Line 30: / Line 30: @@
   {SET_FLOOD_TERRAIN_TABLE "Gg>Wwg;Gs>Ww" awesome_flood}
   {SET_FLOOD_SOURCE "3,3;5,4;6,6" awesome_flood}
-One note: all of these macros replace current data in awesome_flood, so old information is lost. This is especially important for SET_FLOOD_SOURCE because that alters the list of hexes which are currently form the first wave of the flood. So if you call it, the original flood will stop and a new one will start from "3,3;5,4;6,6" or whatever you specify.
+Note: all of these macros replace current data in awesome_flood, so old information is lost. This is especially important for SET_FLOOD_SOURCE because it alters the list of current hexes from the first wave of the flood. When you call it, the original flood will stop and a new one will start from "3,3;5,4;6,6" or whatever you specify.
 == Optimization ==

@@ Line 49: / Line 49: @@
 === Avoiding obstacles ===
-Imagine that you have a little stream which spreads straight to south and can transform green grass to shallow water. So what does happen if it accidentally meets a mountain? It stops. Well, we don't want that - but neither to convert the mountain to anything else. So we can add this to the terrain table:
+Imagine you have a little stream which spreads straight south and can transform green grass to shallow water. So what happens if it accidentally meets a mountain? It stops. Well, we don't want that - but neither do we want to convert the mountain to anything else. So we can add to the terrain table:
   Mm>Mm
-This won't change the mountains type (more precisely, it will be changed from Mm to Mm), but the flood won't regard it as an obstacle anymore. Our example stream will continue on the other side of the mountain hex.
+This won't change the mountain's type (more precisely, it will be changed from Mm to Mm), and the flood won't regard it as an obstacle anymore. Our stream will continue flowing on the other side of the mountain hex.
 == Source Code ==

@@ Line 46: / Line 46: @@
 === Two-wave flood ===
-It's not unimaginable that you want to make your flood heterogeneous - for example, shallow water on the edges and deep water in the middle. You can't do this with one flood - but you can with two! You set up the first one just as normal, and the second one in a way that that it converts shallow water to deep (in this example). You start to spread the second with a delay so that the first wave will be ahead.
+It's not unimaginable that you want to make your flood heterogeneous - for example, shallow water on the edges and deep water in the middle. You can't do this with one flood - but you can with two! You set up the first one just as normal, and the second one in a way that it converts shallow water to deep (in this example). You start to spread the second with a delay so the first wave will remain ahead.
 === Avoiding obstacles ===

@@ Line 41: / Line 41: @@
 === Switching terrain table ===
-Sometimes it's hard decide which code to put first because different ones are common in the different stages of the flood. For example, an avalanche starts at a mountain, where there are mostly hills, but it reaches the plains where it founds more of flat terrain. In this case, it's the best to completely replace the terrain table with the SET_FLOOD_TERRAIN_TABLE macro, so you can give higher rankings to the new common terrains.
+Sometimes it's hard to decide which code to put first because different ones are common in different stages of the flood. For example, an avalanche starts at a mountain, where there are mostly hills, but it reaches the plains where it finds more flat terrain. In this case, it's best to completely replace the terrain table with the SET_FLOOD_TERRAIN_TABLE macro, so you can give higher rankings to the new common terrains.
 == Tips & Tricks ==

@@ Line 46: / Line 46: @@
      #a macro to change directions to their opposites (n->s, sw->ne, etc)
      #DIRECTIONS is a comma-separated list of directions
-     #OUT_VAR is the variable to write the output in. Output is an array
+     #OUT_VAR is the variable to write the output in.
   [set_variables]
@@ Line 80: / Line 80: @@
   #define STORE_FLOODABLE_LOCATIONS SOURCE DIRECTIONS TERRAINS OUT_VAR
-     #stores hexes of type TERRAINS whose neighbour in one of DIRECTIONS directions is one of SOURCE_X ; SOURCE_Y
+     #stores hexes of type TERRAINS whose neighbour in one of DIRECTIONS directions can be found in SOURCE
-     #SOURCE_X & SOURCE_Y comma-separated list of coordinates
+     #SOURCE an array of locations
      #DIRECTIONS is a list of directions
      #TERRAINS comma-separated list of terrain codes
      #OUT_VAR the variable to write the output in
+     #
-     #NOTE: this macro is in fact used to store the hexes of type TERRAINS which are neighbours of SOURCE_X ; SOURCE_Y in
+     #NOTE: this macro is in fact used to store the hexes of type TERRAINS which are neighbours of SOURCE in
      #certain directions, but we achieve that by inverting those directions outside of this macro. See INVERT_DIRECTIONS.

@@ Line 59: / Line 59: @@
   	[/split]
   [/set_variables]
-−
   {FOREACH {OUT_VAR} TMP_ID_i}
- 	[if]
+        [set_variable]
- 		[variable]
+                name={OUT_VAR}[$TMP_ID_i].direction
- 			name={OUT_VAR}[$TMP_ID_i].direction
+                value="-" + ${OUT_VAR}[$TMP_ID_i].direction
- 			equals="n"
+        [/set_variable]
   {NEXT TMP_ID_i}