Skip to content

Class: MockAnim ​

Mock of the X-Ray engine anim action enumeration.

Implements ​

  • anim

Constructors ​

Constructor ​

ts
new MockAnim(...args: unknown[]): MockAnim;

Parameters ​

ParameterType
...argsunknown[]

Returns ​

MockAnim

Methods ​

anim() ​

ts
anim(value: string): void;

Set animation name.

Parameters ​

ParameterTypeDescription
valuestringAnimation name.

Returns ​

void

Implementation of ​

ts
anim.anim

completed() ​

ts
completed(): boolean;

Returns ​

boolean

Whether the animation action is complete.

Implementation of ​

ts
anim.completed

type() ​

ts
type(state: TXR_mental_state): void;

Set mental state.

Parameters ​

ParameterTypeDescription
stateTXR_mental_stateMental state id.

Returns ​

void

Implementation of ​

ts
anim.type

create() ​

ts
static create(...args: unknown[]): MockAnim;

Parameters ​

ParameterType
...argsunknown[]

Returns ​

MockAnim


mock() ​

ts
static mock(...args: unknown[]): anim;

Parameters ​

ParameterType
...argsunknown[]

Returns ​

anim

Properties ​

__name ​

ts
__name: string = "anim";

LuaBind instance constructor name.

Implementation of ​

ts
anim.__name

animation ​

ts
animation: string | null = null;

args ​

ts
args: unknown[];

isCompleted ​

ts
isCompleted: boolean = false;

mentalState ​

ts
mentalState: TXR_mental_state | null = null;

attack ​

ts
readonly static attack: 7;

Engine enum value for anim.attack.


capture_prepare ​

ts
readonly static capture_prepare: 1;

Engine enum value for anim.capture_prepare.


danger ​

ts
readonly static danger: 0;

Engine enum value for anim.danger.


eat ​

ts
readonly static eat: 4;

Engine enum value for anim.eat.


free ​

ts
readonly static free: 1;

Engine enum value for anim.free.


lie_idle ​

ts
readonly static lie_idle: 3;

Engine enum value for anim.lie_idle.


look_around ​

ts
readonly static look_around: 8;

Engine enum value for anim.look_around.


panic ​

ts
readonly static panic: 2;

Engine enum value for anim.panic.


rest ​

ts
readonly static rest: 6;

Engine enum value for anim.rest.


sit_idle ​

ts
readonly static sit_idle: 2;

Engine enum value for anim.sit_idle.


sleep ​

ts
readonly static sleep: 5;

Engine enum value for anim.sleep.


stand_idle ​

ts
readonly static stand_idle: 0;

Engine enum value for anim.stand_idle.


turn ​

ts
readonly static turn: 9;

Engine enum value for anim.turn.