LuaGlobals: Add template number 6 draft
authorWuzzy
Mon, 20 May 2019 20:54:42 +0100
changeset 1900 ac4940b3e5e8
parent 1899 79a144a97a48
child 1901 7af015e221ee
LuaGlobals: Add template number 6
LuaGlobals.wiki
--- a/LuaGlobals.wiki	Mon May 20 20:47:43 2019 +0100
+++ b/LuaGlobals.wiki	Mon May 20 20:54:42 2019 +0100
@@ -76,7 +76,7 @@
 || `Seed` || `0` || Seed of the random number generator ||
 || `LandDigest` || _N/A_ || Digest for the current map. Only meant for internal use by Hedgewars ||
 || `MapGen` || `mgRandom` || Type of map generator. One of `mgRandom`, `mgMaze`, `mgPerlin`, `mgDrawn`. ||
-|| `TemplateNumber` || `0` || This is the number of the land template for random map generators like `mgRandom`. A land template is a rule set for random maps. Maps generated with the same template look similar. You can see the land template number in console when you generate a new random map in the frontend. ||
+|| `TemplateNumber` || `0` || Set the number of the land template for random map generators like `mgRandom`. A land template is a rule set for random maps. Maps generated with the same template look similar. You can see the land template number in console when you generate a new random map in the frontend. This field is write-only, you cannot use it to read the template number that Hedgewars chose. To be able to set the `TemplateNumber`, you must also set `TemplateFilter` to `6`. ||
 || `TemplateFilter` || `0` || Used for the random map generator (`mgRandom`). This is the number of the template filter to be used. A template filter is a grouping of multiple land templates. This corresponds directly to the map size / map style selection in the frontend (e.g. Small/Medium/Large/Cavern/Wacky). ||
 || `MapFeatureSize` || `50` (`12` in 1.0.0) || Used by random maps to determine its “curvyness” or complexity. This value can be set by the user with the slider under the random map preview in the game setup screen. The user-set value ranges from 1 (leftmost position) to 25 (rightmost position). A good starting value is `12`. ||
 || `GameFlags` || `0` || All `GameFlags` combined as a bitmask. Setting `GameFlags` directly is discouraged, use the [LuaGameplay#GameFlags_functions GameFlags functions] instead ||
@@ -115,6 +115,7 @@
 || `3` || Large || Small islands || Small islands ||
 || `4` || Cavern || Medium islands || Medium islands ||
 || `5` || Wacky || Large islands || Large islands ||
+|| `6` || Use template number in `TemplateNumber` || *N/A* || *N/A* ||
 
 == <tt>!WorldEdge</tt> ==
 The value of `WorldEdge` can have the following values: