LuaLibraries.wiki
changeset 939 39ed0b23ef49
parent 938 aa5d58152f50
child 1053 bb4cfa5b41a0
--- a/LuaLibraries.wiki	Sat Nov 26 22:11:14 2016 +0000
+++ b/LuaLibraries.wiki	Sun Nov 27 00:35:54 2016 +0000
@@ -221,9 +221,11 @@
 ==== `RemoveFunction()` ====
 Removes the first function from the aforementioned list.
 
-==== `AnimInit()` ====
+==== `AnimInit([startAnimating])` ====
 Initializes variables used by the other functions. Needs to be called in `onGameInit`.
 
+Since 0.9.23, an optional convenience parameter `startAnimating` is available; if set to `true`, the game will start in “animation” mode which enables cinematic mode and disables all controls except precise for skipping. This is useful if you want to indicate that an animation will be played right at the start and the player must not be allowed to use any controls before the animation is over. If you set this parameter to `true`, you also *must* play at least one animation after this, otherwise the game will be stuck.
+
 ==== !AnimUnWait() ====
 Decreases the wait time used by cinematics. It is best called in `onGameTick`.