# HG changeset patch
# User Wuzzy
# Date 1687333890 0
# Node ID 47493b26d4ee48100e5030e78d40f26a46f03bb6
# Parent 19ffaf4bf91aa8b24a9e222ceb48938a45bea147
LuaLibraryAnimate: "Getting started" section
diff -r 19ffaf4bf91a -r 47493b26d4ee LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki Sat Jun 17 22:14:23 2023 +0000
+++ b/LuaLibraryAnimate.wiki Wed Jun 21 07:51:30 2023 +0000
@@ -5,7 +5,9 @@
This library provides functions that aid cinematic/cut-scene creation and functions for handling events.
-In order to use its full potential, the following lines need to be at the beginning of `onGameTick`.
+== Getting started ==
+
+In order to use its full potential, the following lines need to be at the beginning of `onGameTick`:
function onGameTick()
AnimUnWait()
@@ -16,10 +18,15 @@
CheckEvents()
end
-Also, `AnimInit()` needs to be called in `onGameInit()`.
+Also, `AnimInit()` needs to be called in `onGameInit()`:
+
+function onGameInit()
+ AnimInit()
+end
+
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. Use `AnimSetInputMask` to set the input mask in a manner that is compatible with the Animate library.
+Note: The Animate library will directly 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 ==