LuaLibraryAnimate.wiki
changeset 2235 19ffaf4bf91a
parent 2103 612f6f103787
child 2236 47493b26d4ee
equal deleted inserted replaced
2234:cc4c3628ae0e 2235:19ffaf4bf91a
   110 Decreases the wait time used by cinematics. It is best called in `onGameTick`.
   110 Decreases the wait time used by cinematics. It is best called in `onGameTick`.
   111 
   111 
   112 === `AnimSetInputMask(inputMask)` ===
   112 === `AnimSetInputMask(inputMask)` ===
   113 Call this function instead of `SetInputMask` if you want to set the input mask in a way that does not conflict with the Animate library.
   113 Call this function instead of `SetInputMask` if you want to set the input mask in a way that does not conflict with the Animate library.
   114 
   114 
   115 Internally, the input mask you provide is simply AND-ed with the input mask used by the Animate library. Otherwise, this function works lik `SetInputMask`.
   115 Internally, the input mask you provide is simply AND-ed with the input mask used by the Animate library. Otherwise, this function works like `SetInputMask`.
   116 
   116 
   117 If you call `SetInputMask` directly, note that it might get quickly overwritten by the Animatel library!
   117 If you call `SetInputMask` directly, note that it might get quickly overwritten by the Animate library!
   118 
   118 
   119 == Cinematic functions ==
   119 == Cinematic functions ==
   120 
   120 
   121 === `AnimSwitchHog(gear)` ===
   121 === `AnimSwitchHog(gear)` ===
   122 Switches to `gear` and follows it.
   122 Switches to `gear` and follows it.
   129 
   129 
   130 === `AnimWait(gear, time)` ===
   130 === `AnimWait(gear, time)` ===
   131 Increases the wait time by `time`. `gear` is just for compatibility with `ShowAnimation`.
   131 Increases the wait time by `time`. `gear` is just for compatibility with `ShowAnimation`.
   132 
   132 
   133 === `AnimSay(gear, text, manner, time)` ===
   133 === `AnimSay(gear, text, manner, time)` ===
   134 Calls `HogSay` with the first three arguments and increses the wait time by `time`.
   134 Calls `HogSay` with the first three arguments and increases the wait time by `time`.
   135 
   135 
   136 Example:
   136 Example:
   137 <code language="lua">cinem = {
   137 <code language="lua">cinem = {
   138     {func = AnimSay, args = {gear1, "You're so defensive!", SAY_SAY, 2500}},
   138     {func = AnimSay, args = {gear1, "You're so defensive!", SAY_SAY, 2500}},
   139     {func = AnimSay, args = {gear2, "No, I'm not!", SAY_SAY, 2000}}
   139     {func = AnimSay, args = {gear2, "No, I'm not!", SAY_SAY, 2000}}
   144 
   144 
   145 === `AnimTurn(hog, dir)` ===
   145 === `AnimTurn(hog, dir)` ===
   146 Makes `hog` face in direction `dir`, where `dir` equals either `"Right"` or `"Left"`.
   146 Makes `hog` face in direction `dir`, where `dir` equals either `"Right"` or `"Left"`.
   147 
   147 
   148 === `AnimMove(hog, dir, x, y)` ===
   148 === `AnimMove(hog, dir, x, y)` ===
   149 Makes `hog` move in direction `dir` until either his horizontal coordinate is `x` or his vertical coordinate is `y`.
   149 Makes `hog` move in direction `dir` until either its horizontal coordinate is `x` or its vertical coordinate is `y`.
   150 
   150 
   151 === `AnimJump(hog, jumpType)` ===
   151 === `AnimJump(hog, jumpType)` ===
   152 Makes `hog` perform a jump of type `jumpType`, where `jumpType` equals either `"long"`, `"high"` or `"back"`.
   152 Makes `hog` perform a jump of type `jumpType`, where `jumpType` equals either `"long"`, `"high"` or `"back"`.
   153 
   153 
   154 === `AnimSetGearPosition(gear, x, y, fall)` ===
   154 === `AnimSetGearPosition(gear, x, y, fall)` ===