Add AddPoint and FlushPoints.
authoralmikes@aol.com
Wed, 03 Dec 2014 04:34:46 +0000
changeset 412 d2f4b5b9b77c
parent 411 dbb7937903a4
child 413 6d90d6994e95
Add AddPoint and FlushPoints.
LuaAPI.wiki
--- a/LuaAPI.wiki	Wed Dec 03 04:11:08 2014 +0000
+++ b/LuaAPI.wiki	Wed Dec 03 04:34:46 2014 +0000
@@ -84,11 +84,11 @@
  * <tt>Map = "Bamboo"</tt> - the map being played
  * <tt>Theme = "Bamboo"</tt> - the theme to be used
  * <tt>Ready = 5000</tt> - the ready timer at the start of the round
- * <tt>!MapGen</tt>
+ * <tt>!MapGen</tt> - type of map generator. One of `mgRandom`, `mgMaze`, `mgPerlin`, `mgDrawn`.
  * <tt>!TemplateFilter</tt>
  * <tt>Goals = "Jumping is disabled"</tt> - if you want to add info to the game mode dialog, use "|" to separate lines
 
-If you want to add teams or hogs manually you have to do it here.
+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.
 
 === <tt>onGameStart()</tt> ===
 
@@ -761,6 +761,17 @@
   * 7: long, increasing right
 </blockquote>
 
+
+==== <tt>!AddPoint(x, y [, width [, erase] ])</tt> (0.9.21) ====
+This function is used to draw your own maps using Lua. The maps drawn with this are of type “hand-drawn”.
+
+The function takes a `x`,`y` location, a `width` (means start of a new line) and `erase` (if `false`, this function will draw normally, if `true`, this function will erase drawn stuff).
+
+This function must be called within `onGameInit`, where `MapGen` has been set to `mgDrawn`. You also should call `FlushPoints` when you are finished with drawing.
+
+==== <tt>!FlushPoints()</tt> (0.9.21) ====
+Makes sure that all the points/lines specified using `AddPoint` are actually applied to the map. This function must be called within `onGameInit`.
+
 === Current hedgehog ===
 
 ==== <tt>!GetCurAmmoType()</tt> (0.9.16) ====