LuaAPI: Add WorldEdge
authorWuzzy
Mon, 14 Nov 2016 23:53:09 +0000
changeset 917 c05279ae1ac2
parent 916 a01743eb08f1
child 918 87e1d0a11e99
LuaAPI: Add WorldEdge
LuaAPI.wiki
--- a/LuaAPI.wiki	Mon Nov 14 23:48:26 2016 +0000
+++ b/LuaAPI.wiki	Mon Nov 14 23:53:09 2016 +0000
@@ -171,6 +171,7 @@
 || `WaterRise` || `47` || Height of water rise in pixels for each Sudden Death turn ||
 || `HealthDecrease` || `5` || Amount of health decreased on each turn in Sudden Death ||
 || `Goals` || `""` || Use this to add additional text to the goal text popup shown at the beginning and when using the quit or pause keys. The text is added to the default text which usually explains the game modifiers and does not replace it. Use `|` for line breaks. Also, all text before and including a `:` in a line will be highlighted. See also `ShowMission`. ||
+|| `WorldEdge` || `weNone` || Type edges being used at the left and right sides of the terrain (see below). Available since 0.9.23. ||
 || `ScreenWidth` || _N/A_ || Width of the Hedgewars window or screen ||
 || `ScreenHeight` || _N/A_ || Height of the Hedgewars window or screen ||
 
@@ -178,6 +179,15 @@
 
 If you want to add teams or hogs manually, you have to do it here. If you want to draw your own map using `AddPoint` and `FlushPoints`, you have to do this within this function as well.
 
+==== `WorldEdge` ====
+The value of `WorldEdge` can have the following values:
+
+|| *Identifier* || *Meaning* ||
+|| `weNone` || No world edges ||
+|| `weBounce` || Bouncy world edges ||
+|| `weWrap` || World wraps around at the edges ||
+|| `weSea` || Ocean world edges ||
+
 === <tt>onGameStart()</tt> ===
 This function is called when the first round starts.