LuaAPI.wiki
changeset 77 588f5dc682e2
parent 76 0cdebc52edad
child 78 2edf207a905a
--- a/LuaAPI.wiki	Thu Dec 30 23:08:54 2010 +0000
+++ b/LuaAPI.wiki	Thu Dec 30 23:22:23 2010 +0000
@@ -381,6 +381,16 @@
 <blockquote>Plays the specified sound for the chosen hedgehog's team.
 </blockquote>
 
+=== <tt>!SetInputMask(mask)</tt> (0.9.15) ===
+
+<blockquote>Masks specified player input.
+</blockquote>
+Example: 
+<code lang="lua">    SetInputMask(band(0xFFFFFFFF, bnot(gmAnimate+gmAttack+gmDown+gmHJump+gmLeft+gmLJump+gmPrecise+gmRight+gmSlot+gmSwitch+gmTimer+gmUp+gmWeapon))) -- masks just about anything the player might want to do
+    SetInputMask(0xFFFFFFFF) -- clears input mask, allowing player to take actions
+		</code>
+Note: Using the input mask is an effective way to script uninterrupted cinematics, or create modes such as No Jumping. 
+
 === <tt>!SetZoom(zoomLevel)</tt> (0.9.14) ===
 
 <blockquote>Sets the zoom level. The value for maximum zoom is currently 1.0 and for minimum 3.0 The default zoom level is 2.0