LuaLibraryAnimate: Add AnimGearWait
authorWuzzy
Wed, 21 Jun 2023 13:04:30 +0000
changeset 2243 e58371e25834
parent 2242 031a5b86e533
child 2244 e8e1c0dd32e5
LuaLibraryAnimate: Add AnimGearWait
LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki	Wed Jun 21 12:50:32 2023 +0000
+++ b/LuaLibraryAnimate.wiki	Wed Jun 21 13:04:30 2023 +0000
@@ -168,10 +168,10 @@
 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.
+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.
 
 ==== `AnimSwitchHog(gear)` ====
-Switches to `gear` and follows it.
+Switches the `CurrentHedgehog` to `gear` and follows it.
 
 ==== `AnimGiveState(gear, state)` ====
 Sets the [States gear state] of `gear` to `state` (full bitmask).
@@ -180,7 +180,10 @@
 Removes the [States gear state] `state` from `gear`.
 
 ==== `AnimWait(gear, time)` ====
-Increases the wait time by `time`. `gear` is just for compatibility with `ShowAnimation`.
+Increases the wait time by `time` (in milliseconds) without changing the `CurrentHedgehog`. The `gear` argument is ignored (it exists for compability with `ShowAnimation).
+
+==== `AnimGearWait(gear, time)` ====
+Increases the wait time by `time` (in milliseconds) and changes the `CurrentHedgehog` to `gear`.
 
 ==== `AnimSay(gear, text, manner, time)` ====
 Calls `HogSay` with the first three arguments and increases the wait time by `time`.