LuaAPI: Add EndLuaTest
authorWuzzy
Wed, 04 Oct 2017 11:48:28 +0100
changeset 1054 0de5837d0fc5
parent 1053 bb4cfa5b41a0
child 1055 754e0a7bdd44
LuaAPI: Add EndLuaTest
LuaAPI.wiki
--- a/LuaAPI.wiki	Fri Sep 29 21:54:32 2017 +0100
+++ b/LuaAPI.wiki	Wed Oct 04 11:48:28 2017 +0100
@@ -1366,4 +1366,11 @@
 * `"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]
 
-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
+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.
+
+=== <tt>!EndLuaTest(success)</tt> ===
+This function is used by the Hedgewars developers in testing scripts in order to test the game engine. The testing scripts can be found in the Hedgewars source code under `tests/lua`. This function is useless for anything else.
+
+Calling this function ends an engine test and reports a test result.
+
+`success` is either one of `TEST_SUCCESSFUL` to report a successful test or `TEST_FAILED` for a failed test.
\ No newline at end of file