LuaAPI: clarify HogLevel stuff
authorWuzzy
Sat, 24 Feb 2018 11:24:06 +0000
changeset 1243 770aa6d54ae2
parent 1242 c307fe8fb975
child 1244 fb89844d7b78
LuaAPI: clarify HogLevel stuff
LuaAPI.wiki
--- a/LuaAPI.wiki	Sat Feb 24 11:17:16 2018 +0000
+++ b/LuaAPI.wiki	Sat Feb 24 11:24:06 2018 +0000
@@ -597,7 +597,7 @@
 Returns the health of the gear. Depending on the gear type, the gear's “health” can also refer to other things, see [GearTypes] for a full list.
 
 === <tt>!GetHogLevel(gearUid)</tt> ===
-Returns the bot level ranging from `0` to `5`. `1` is the strongest bot level and `5` is the weakest one. `0` is for human player.
+Returns the bot level ranging from `0` to `5`. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` is for human player.
 
 === <tt>!GetGearPos(gearUid)</tt> ===
 Get the `Pos` value of the specified gear. `Pos` is just another arbitrary value to hold the state of the gear, such as `Tag` and `Health`, the meaning depends on the gear type. See [GearTypes] for the conrete meaning of a gear's `Pos` value. 
@@ -944,7 +944,7 @@
 Sets the timer of the specified gear. Also see `GetTimer`.
 
 === <tt>!SetHogLevel(gearUid, level)</tt> ===
-Sets the bot level from 0 to 5. `0` means human player.
+Sets the bot level from 0 to 5. `1` is the strongest bot level and `5` is the weakest one (this is the reverse of what players see). `0` means human player.
 
 === `SetGearAIHints(gearUid, aiHint)` ===
 Set some behaviour hints for computer-controlled hedgehogs for any given gear with `gearUid`.