LuaAPI: Update ParseCommand help
authorWuzzy
Thu, 28 Sep 2017 17:51:03 +0100
changeset 1044 bc4dca5e6124
parent 1043 ad936934f97b
child 1045 54979ae0e5ac
LuaAPI: Update ParseCommand help
LuaAPI.wiki
--- a/LuaAPI.wiki	Tue Sep 26 15:22:31 2017 +0100
+++ b/LuaAPI.wiki	Thu Sep 28 17:51:03 2017 +0100
@@ -1353,11 +1353,16 @@
 Converts the whole numbers `x` and `y` to strings and writes them to `Logs/game0.log`, one line each.
 
 === <tt>!ParseCommand(string)</tt> ===
-Makes the game client parse the specified custom command.
+Makes the game client parse the specified internal game engine command.
+
+The available commands depend on the engine protocol. *Note*: Please be aware that the *engine protocol can (and will) change* between releases. It is not recommended to use this function in custom scripts.
 
-*Note*: Please be aware that the *engine protocol can (and will) change* between releases.
+There are many available commands, but only a few of them are useful for scripting. This is a list of useful commands in version 0.9.22:
 
-If you use `ParseCommand` to overcome a shortcoming in our Lua API (e.g. a missing function), please make sure to [https://code.google.com/p/hedgewars/issues/entry report the issue].
+* `"skip"`: Current hedgehog skips its turn
+* `"draw <map>"`: Draws a hand-drawn map. `MapGen` must be `mgDrawn` for this to work. `<map>` is a string which must follow the format specified in [DrawnMapFormat]
+
+If you use `ParseCommand` to overcome a shortcoming in our Lua API (e.g. a missing function), please make sure to [https://issues.hedgewars.org/enter_bug.cgi report the issue]. We will try to remove the reliance on `ParseCommand` as good as possible.
 
 With your report we can fix the shortcoming in future releases.
 This will allow scripts to use the previously missing feature in a way that won’t break!