Skip to content
On this page

AthenaClient.systems.animations

Functions

loadAnimation

Usage

AthenaClient.systems.animations.loadAnimation(dict, count?): Promise<boolean>

Attempts to load an animation dictionary multiple times before returning false.

Parameters

NameTypeDefault valueDescription
dictstringundefinedThe name of the animation dictionary.
count?number0Do not modify this. Leave it as zero.

Returns

Promise<boolean>

Defined in

client/systems/animations.ts:16


playAnimation

Usage

AthenaClient.systems.animations.playAnimation(dict, name, flags?, duration?): Promise<void>

Play an animation for the local player.

Parameters

NameTypeDefault valueDescription
dictstringundefinedThe dictionary of the animation.
namestringundefinedThe name of the animation.
flags?ANIMATION_FLAGSANIMATION_FLAGS.CANCELABLEA combination of flags. ie. (ANIMATION_FLAGS.CANCELABLE | ANIMATION_FLAGS.UPPERBODY_ONLY)
durationnumber-1-

Returns

Promise<void>

Defined in

client/systems/animations.ts:51


playPedAnimation

Usage

AthenaClient.systems.animations.playPedAnimation(scriptID, dict, name, flags?, duration?): Promise<void>

Play an animation on a Pedestrian

Parameters

NameTypeDefault value
scriptIDnumberundefined
dictstringundefined
namestringundefined
flags?ANIMATION_FLAGSANIMATION_FLAGS.CANCELABLE
duration?number-1

Returns

Promise<void>

Defined in

client/systems/animations.ts:87

Created by Stuyk | Est. 2020