LuaLibraries: AnimSetInputMask
authorWuzzy
Fri, 29 Sep 2017 21:54:32 +0100
changeset 1053 bb4cfa5b41a0
parent 1052 1c45c17f118a
child 1054 0de5837d0fc5
LuaLibraries: AnimSetInputMask
LuaLibraries.wiki
--- a/LuaLibraries.wiki	Thu Sep 28 23:14:36 2017 +0100
+++ b/LuaLibraries.wiki	Fri Sep 29 21:54:32 2017 +0100
@@ -162,7 +162,7 @@
 Also, `AnimInit()` needs to be called in `onGameInit()`.
 Each of these functions will be explained below.
 
-Note: The Animate library will direclty overwrite the input mask with `SetInputMask`. If you already use this function in your script, it might lead to conflicts.
+Note: The Animate library will direclty overwrite the input mask with `SetInputMask`. If you already use this function in your script, it might lead to conflicts. Use `AnimSetInputMask` to set the input mask in a manner that is compatible with the Animate library.
 
 === Cinematic handling ===
 
@@ -351,6 +351,12 @@
 ==== `CheckEvents` ====
 Verifies all the condition functions in the events list and calls the respective ‘action’ functions if the conditions are met. If the `evType` of a completed event equals `0` then it is removed from the list. This function is best placed in `onGameTick`.
 
+==== `AnimSetInputMask(inputMask)` (0.9.23) ====
+Call this function instead of `SetInputMask` if you want to set the input mask in a way that does not conflict with the Animate library.
+
+Internally, the input mask you provide is simply AND-ed with the input mask used by the Animate library. Otherwise, this function works lik `SetInputMask`.
+
+If you call `SetInputMask` directly, note that it might get quickly overwritten by the Animatel library!
 
 == Params ==
 The Params library is a small library introduced in 0.9.21. It provides a function to parse the parameter string `ScriptParam` and it is intended to simplify using this string.