getId
getId: (Animation) -> numberThe animation's id, numbered as Actor:getAnimation() and AnimationID number them.
client:loadAnimation(…)| Method | Returns | Description |
|---|---|---|
getId() | number | The animation's id, numbered as Actor:getAnimation() and AnimationID number them. |
isMayaAnim() | boolean | Whether it is a skeletal ("maya") animation, whose frame is a count of client ticks, not a keyframe. |
getNumFrames() | number | How many frames it has: a skeletal animation's length in client ticks, else how many keyframes (not its length in ticks: sum `getFrameLengt… |
getDuration() | number | How many frames it lasts: a skeletal animation's length in client ticks, else how many frame lengths it has (1 for one with none). |
getFrameStep() | number | How many frames it goes back when it loops; -1 for one that does not loop. |
getRestartMode() | number | What starting the animation again while it plays does: 1 starts it over, 2 (the value of an animation that sets none) only starts its loop… |
getLeftHandItem() | number | The item (ItemID) the animation puts in the left hand while it plays; -1 when it puts none there (it leaves the hand alone, or empties it… |
getRightHandItem() | number | The item (ItemID) the animation puts in the right hand while it plays; -1 when it puts none there. |
getFrameLengths() | {number}? | How many client ticks each keyframe lasts, in frame order (a copy); nil for a skeletal animation. |
| Method | Returns | Description |
|---|---|---|
Client.loadAnimation | Animation? | Sequence id, for ClientObject:setAnimation; nil for one with no frames that is not skeletal. |
DynamicObject.getAnimation | Animation? | The animation it plays now, read when asked; nil when it plays none, or once its loc is gone. getAnimation():getId() is the id `GameObj… |
Projectile.getAnimation | Animation? | The animation it plays (its spot animation's), nil when it plays none. |
getIdgetId: (Animation) -> numberThe animation's id, numbered as Actor:getAnimation() and AnimationID number them.
isMayaAnimisMayaAnim: (Animation) -> booleanWhether it is a skeletal ("maya") animation, whose frame is a count of client ticks, not a keyframe.
getNumFramesgetNumFrames: (Animation) -> numberHow many frames it has: a skeletal animation's length in client ticks, else how many keyframes (not its length in ticks: sum getFrameLengths() for that).
getDurationgetDuration: (Animation) -> numberHow many frames it lasts: a skeletal animation's length in client ticks, else how many frame lengths it has (1 for one with none).
getFrameStepgetFrameStep: (Animation) -> numberHow many frames it goes back when it loops; -1 for one that does not loop.
getRestartModegetRestartMode: (Animation) -> numberWhat starting the animation again while it plays does: 1 starts it over, 2 (the value of an animation that sets none) only starts its loop count over (Actor:getAnimationLoopCount()), anything else changes nothing.
getLeftHandItemgetLeftHandItem: (Animation) -> numberThe item (ItemID) the animation puts in the left hand while it plays; -1 when it puts none there (it leaves the hand alone, or empties it).
getRightHandItemgetRightHandItem: (Animation) -> numberThe item (ItemID) the animation puts in the right hand while it plays; -1 when it puts none there.
getFrameLengthsgetFrameLengths: (Animation) -> {number}?How many client ticks each keyframe lasts, in frame order (a copy); nil for a skeletal animation.