Skip to content

Class: MockEntityAction ​

Mock of the X-Ray engine entity_action class.

Implements ​

  • entity_action

Constructors ​

Constructor ​

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

Parameters ​

ParameterType
...argsunknown[]

Returns ​

MockEntityAction

Methods ​

create() ​

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

Parameters ​

ParameterType
...argsunknown[]

Returns ​

MockEntityAction


mock() ​

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

Parameters ​

ParameterType
...argsunknown[]

Returns ​

entity_action

Properties ​

__name ​

ts
__name: string = "entity_action";

LuaBind instance constructor name.

Implementation of ​

ts
entity_action.__name

all ​

ts
all: Mock<() => boolean>;

Check whether all action parts are complete.

Returns ​

Whether the action is complete.

Implementation of ​

ts
entity_action.all

anim ​

ts
anim: Mock<() => boolean>;

Check whether the animation part is complete.

Returns ​

Whether animation is complete.

Implementation of ​

ts
entity_action.anim

args ​

ts
args: unknown[];

completed ​

ts
completed: Mock<() => boolean>;

Check whether the whole action is complete.

Returns ​

Whether all required parts are complete.

Implementation of ​

ts
entity_action.completed

look ​

ts
look: Mock<() => boolean>;

Check whether the look part is complete.

Returns ​

Whether look handling is complete.

Implementation of ​

ts
entity_action.look

move ​

ts
move: Mock<() => boolean>;

Check whether the movement part is complete.

Returns ​

Whether movement is complete.

Implementation of ​

ts
entity_action.move

object ​

ts
object: Mock<() => boolean>;

Check whether the object interaction part is complete.

Returns ​

Whether object interaction is complete.

Implementation of ​

ts
entity_action.object

particle ​

ts
particle: Mock<() => boolean>;

Check whether the particle part is complete.

Returns ​

Whether particle playback is complete.

Implementation of ​

ts
entity_action.particle

set_action ​

ts
set_action: Mock<{
  (move: move): void;
  (look: look): void;
  (anim: anim): void;
  (sound: sound): void;
  (particle: particle): void;
  (objectAction: XR_object): void;
  (cond: cond): void;
  (act: act): void;
}>;

Set the movement part of this action.

Param ​

move

Movement action.

Implementation of ​

ts
entity_action.set_action

sound ​

ts
sound: Mock<() => boolean>;

Check whether the sound part is complete.

Returns ​

Whether sound playback is complete.

Implementation of ​

ts
entity_action.sound

time ​

ts
time: Mock<() => boolean>;

Check whether the action time condition has elapsed.

Returns ​

Whether the time condition is complete.

Implementation of ​

ts
entity_action.time