# HG changeset patch # User Wuzzy # Date 1506618083 -3600 # Node ID 1e19a1a5a450254fe012a22358122576725329c9 # Parent 54979ae0e5ac1fd3affcec9709aa7d04e70d7657 LuaAPI: Update ParseCommand info diff -r 54979ae0e5ac -r 1e19a1a5a450 LuaAPI.wiki --- a/LuaAPI.wiki Thu Sep 28 17:56:47 2017 +0100 +++ b/LuaAPI.wiki Thu Sep 28 18:01:23 2017 +0100 @@ -1353,18 +1353,17 @@ Converts the whole numbers `x` and `y` to strings and writes them to `Logs/game0.log`, one line each. === !ParseCommand(string) === -Makes the game client parse the specified internal game engine command. +Makes the game client parse and execute the specified internal game engine command. + +The available commands depend on the current engine protocol version. The *engine protocol can (and will) change* between releases. -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. +**Important**: 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]. -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: +With your report we can fix the shortcoming in future releases. We will try to remove the reliance on `ParseCommand` as good as possible. This will allow scripts to use the previously missing feature in a way that won’t break! + +There are many available commands, but only a few of them are useful for scripting. These are commands used in official scripts in 0.9.22: * `"skip"`: Current hedgehog skips its turn * `"draw "`: Draws a hand-drawn map. `MapGen` must be `mgDrawn` for this to work. `` 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! - - +Moreover, the control action names as listed [ConfigurationFiles#[Binds] here] can be used. Note we will eventually try to remove all `ParseCommand`s in the official scripts. \ No newline at end of file