LuaLibraryAnimate: "Getting started" section
authorWuzzy
Wed, 21 Jun 2023 07:51:30 +0000
changeset 2236 47493b26d4ee
parent 2235 19ffaf4bf91a
child 2237 dd92ebc28957
LuaLibraryAnimate: "Getting started" section
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 @@
 <wiki:toc max_depth="2" />
 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`:
 
 <code language="lua">function onGameTick()
     AnimUnWait()
@@ -16,10 +18,15 @@
     CheckEvents()
 end</code>
 
-Also, `AnimInit()` needs to be called in `onGameInit()`.
+Also, `AnimInit()` needs to be called in `onGameInit()`:
+
+<code language="lua">function onGameInit()
+    AnimInit()
+end</code>
+
 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 ==