Animations

const Animations: object

Defined in: server/api.d.ts:7543

Every animation the game plays on a human body, and the props it gives one to hold. player.playAnimation and npc.playAnimation play them.

Type Declaration

list()

list(search?): AnimationInfo[]

Lists the animations the game plays on people – over six thousand, from waves and bows to chopping wood, drinking and every tavern pose. These are the game’s own combinations, so each one is known to play; playAnimation also takes fragments and tags this does not list, and plays whatever the body’s animation database makes of them.

Parameters

search?

string

Only rows whose fragment or tags contain this, ignoring case. Everything when left out.

Returns

AnimationInfo[]

One row per fragment and tag combination, sorted by fragment.

props()

props(): AnimationPropInfo[]

Lists the tools and carried objects the game puts in people’s hands, by item name. Pick one whose hand matches the animation’s rightHand or leftHand and it sits in the hand the way the animation was made for.

Returns

AnimationPropInfo[]

Every prop, sorted by name.