LuaGameplay: Clarify controls input functions
authorWuzzy
Wed, 17 Apr 2019 14:54:22 +0100
changeset 1796 8b10d405a1a0
parent 1795 12e1aa6294d7
child 1797 e8c8ffe6e22b
LuaGameplay: Clarify controls input functions
LuaGameplay.wiki
--- a/LuaGameplay.wiki	Wed Apr 17 14:49:53 2019 +0100
+++ b/LuaGameplay.wiki	Wed Apr 17 14:54:22 2019 +0100
@@ -304,10 +304,10 @@
 This function makes the current hedgehog switch to the next weapon in list of available weapons. It can be used for example in trainings to pre-select a weapon.
 
 === <tt>!SetInputMask(mask)</tt> ===
-Masks specified player input. This means that Hedgewars ignores certain player inputs, such as walking or jumping.
+Masks specified player input. `mask` is a gear message bitmask (see [GearMessages]). This means that Hedgewars ignores certain player inputs, such as walking or jumping. However, the controls [LuaEvents event functions] such as `onAttack` or `onLeft` will still be called, even when masked.
 
 Example: 
-<code language="lua">    -- masks the long and high jump commands
+<code language="lua">    -- masks the long and high jump commands, making it impossible to jump
 SetInputMask(band(0xFFFFFFFF, bnot(gmLJump + gmHJump))) 
     -- clears input mask, allowing player to take actions
     SetInputMask(0xFFFFFFFF)