LuaLibraries.wiki
changeset 939 39ed0b23ef49
parent 938 aa5d58152f50
child 1053 bb4cfa5b41a0
equal deleted inserted replaced
938:aa5d58152f50 939:39ed0b23ef49
   219 <code language="lua">AddFunction({func = AfterCinem, args = {2}})</code>
   219 <code language="lua">AddFunction({func = AfterCinem, args = {2}})</code>
   220 
   220 
   221 ==== `RemoveFunction()` ====
   221 ==== `RemoveFunction()` ====
   222 Removes the first function from the aforementioned list.
   222 Removes the first function from the aforementioned list.
   223 
   223 
   224 ==== `AnimInit()` ====
   224 ==== `AnimInit([startAnimating])` ====
   225 Initializes variables used by the other functions. Needs to be called in `onGameInit`.
   225 Initializes variables used by the other functions. Needs to be called in `onGameInit`.
       
   226 
       
   227 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.
   226 
   228 
   227 ==== !AnimUnWait() ====
   229 ==== !AnimUnWait() ====
   228 Decreases the wait time used by cinematics. It is best called in `onGameTick`.
   230 Decreases the wait time used by cinematics. It is best called in `onGameTick`.
   229 
   231 
   230 === Cinematic functions ===
   232 === Cinematic functions ===