LuaLibraryAnimate: Clarify AnimMove
authorWuzzy
Wed, 21 Jun 2023 12:34:58 +0000
changeset 2240 c387af3810c6
parent 2239 fdf6721339eb
child 2241 20ed85eb3d29
LuaLibraryAnimate: Clarify AnimMove
LuaLibraryAnimate.wiki
--- a/LuaLibraryAnimate.wiki	Wed Jun 21 09:31:59 2023 +0000
+++ b/LuaLibraryAnimate.wiki	Wed Jun 21 12:34:58 2023 +0000
@@ -196,10 +196,14 @@
 Makes `hog` face in direction `dir`, where `dir` equals either `"Right"` or `"Left"`.
 
 ==== `AnimMove(hog, dir, x, y)` ====
-Makes `hog` move in direction `dir` until either its horizontal coordinate is `x` or its vertical coordinate is `y`.
+Makes `hog` walk in direction `dir` (`"Right"` or `"Left"`) until either its horizontal coordinate equals `x` or its vertical coordinate equals `y`.
 
 ==== `AnimJump(hog, jumpType)` ====
-Makes `hog` perform a jump of type `jumpType`, where `jumpType` equals either `"long"`, `"high"` or `"back"`.
+Makes `hog` perform a jump of type `jumpType`, where `jumpType` is one of:
+
+ * `"long"`: Long jump
+ * `"high"`: High jump
+ * `"back"`: Backjump
 
 ==== `AnimSetGearPosition(gear, x, y, fall)` ====
 Sets the position of `gear` to (`x`, `y`). If the optional argument `fall` does not equal `false` then the gear is given a small falling velocity in order to get around exact positioning.