LuaLibraryAnimate: Add TOC
authorWuzzy
Thu, 03 May 2018 00:25:56 +0100
changeset 1383 75735c1890c7
parent 1382 8d6310a05033
child 1384 1edf2e41b626
LuaLibraryAnimate: Add TOC
LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki	Thu May 03 00:18:54 2018 +0100
+++ b/LuaLibraryAnimate.wiki	Thu May 03 00:25:56 2018 +0100
@@ -1,7 +1,7 @@
 #summary Lua library documentation of Animate; for cinematics, cut-scenes and other nice animations
 #labels !LuaLibrary
 = Lua library: `Animate` =
-
+<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`.
@@ -25,8 +25,8 @@
 === `ShowAnimation()` ===
 Performs the current action in the cinematic and returns `true` if finished, otherwise `false`. It needs to be used in `onGameTick`. Cut-scenes need to be added with `AddAnim(steps)`.
 
-=== `Animate()` ===
-*UNDOCUMENTED!*
+=== `Animate(steps)` ===
+*THIS FUNCTION IS UNDOCUMENTED!*
 
 === `AddAnim(steps)` ===
 Adds `steps` to the array of animations, where `steps` is a table with numbers as keys and elements of the following form. Each step is a table having the following keys: `func`, `args`, `swh`.