LuaLibraryAnimate.wiki
changeset 2244 e8e1c0dd32e5
parent 2243 e58371e25834
child 2245 3e97c75aaddc
--- a/LuaLibraryAnimate.wiki	Wed Jun 21 13:04:30 2023 +0000
+++ b/LuaLibraryAnimate.wiki	Wed Jun 21 13:08:24 2023 +0000
@@ -40,7 +40,7 @@
 
  * `func` is the function to be executed. It can be any function that returns false when it needs to be called again in following game ticks (e.g. `AnimMove`). It could theoretically be any function, but usually you want to use one of the cinematic functions here.
  * `args` is a list containing the arguments that need to be passed to the function given, in the same order
- * `swh` is an optional boolean value that defaults to `true` and denotes whether the current hedgehog should be switched to the hog given as argument 1 in `args`. You *must* set this to `false` if argument 1 is not a hog or the argument list is empty.
+ * `swh` is an optional boolean value that defaults to `true` and denotes whether the current hedgehog should be switched to the hog given as argument 1 in `args`. You *must* set this to `false` if argument 1 is not a hedgehog.
 
 Example 1:
 <code language="lua">
@@ -168,11 +168,14 @@
 If you call `SetInputMask` directly, note that it might get quickly overwritten by the Animate library!
 
 === Cinematic functions ===
-These are the functions you can specify in animation steps. In all functions except `AnimWait`, the `gear` argument switches the `CurrentHedgehog` to `gear` and follows it.
+These are the functions you can specify in animation steps. In all functions except `AnimWait`, the `gear` argument switches the `CurrentHedgehog` to `gear` and follows it. Hedgehog switching can be disabled with `swh=false` (see definition of animation steps above).
 
 ==== `AnimSwitchHog(gear)` ====
 Switches the `CurrentHedgehog` to `gear` and follows it.
 
+==== `AnimFollowGear(gear)` ====
+Follows `gear`.
+
 ==== `AnimGiveState(gear, state)` ====
 Sets the [States gear state] of `gear` to `state` (full bitmask).