Class: MockMove

Mock move actions class.

Implements

• move

Constructors

Constructor

new MockMove(...args: unknown[]): MockMove;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockMove

Methods

body()

body(bodyState: TXR_body_state): void;

Set body state.

Parameters

Parameter	Type	Description
bodyState	TXR_body_state	Body state id.

Returns

void

Implementation of

move.body

---

completed()

completed(): boolean;

Returns

boolean

Whether the movement action is complete.

Implementation of

move.completed

---

input()

input(inputKey: number): void;

Set input key action.

Parameters

Parameter	Type	Description
inputKey	number	Input key id.

Returns

void

Implementation of

move.input

---

move()

move(movementType: TXR_movement_type): void;

Set movement type.

Parameters

Parameter	Type	Description
movementType	TXR_movement_type	Movement type id.

Returns

void

Implementation of

move.move

---

object()

object(gameObject: game_object): void;

Set target object.

Parameters

Parameter	Type
gameObject	game_object

Returns

void

Implementation of

move.object

---

path()

path(pathType: TXR_detail_path_type): void;

Set detail path type.

Parameters

Parameter	Type	Description
pathType	TXR_detail_path_type	Detail path type id.

Returns

void

Implementation of

move.path

---

patrol()

patrol(patrolPath: CPatrolPath, pathName: string): void;

Set patrol path from a native patrol path pointer.

Parameters

Parameter	Type	Description
patrolPath	CPatrolPath	Internal native patrol path handle.
pathName	string	-

Returns

void

Source

src/xrGame/script_movement_action_script.cpp, move.patrol binding.

Remarks

This low-level binding expects an internal CPatrolPath*, not the public patrol parameter object. Prefer the movement action constructors that accept patrol unless native code passes a raw patrol path pointer.

Implementation of

move.patrol

---

position()

position(vector: vector): void;

Set target position.

Parameters

Parameter	Type	Description
vector	vector	Target position.

Returns

void

Implementation of

move.position

---

create()

static create(...args: unknown[]): MockMove;

Parameters

Parameter	Type
...args	unknown[]

Returns

MockMove

---

mock()

static mock(...args: unknown[]): move;

Parameters

Parameter	Type
...args	unknown[]

Returns

move

Properties

__name

__name: string = "move";

LuaBind instance constructor name.

Implementation of

move.__name

---

args

args: unknown[];

---

bodyState

bodyState: TXR_body_state | null = null;

---

inputKey

inputKey: number | null = null;

---

isCompleted

isCompleted: boolean = false;

---

movementType

movementType: TXR_movement_type | null = null;

---

pathType

pathType: TXR_detail_path_type | null = null;

---

patrolName

patrolName: string | null = null;

---

patrolPath

patrolPath: CPatrolPath | null = null;

---

targetObject

targetObject: game_object | null = null;

---

targetPosition

targetPosition: vector | null = null;

---

back

readonly static back: 4;

Engine enum value for move.back.

---

criteria

readonly static criteria: 2;

Engine enum value for move.criteria.

---

crouch

readonly static crouch: 0;

Engine enum value for move.crouch.

---

curve

readonly static curve: 0;

Engine enum value for move.curve.

---

curve_criteria

readonly static curve_criteria: 2;

Engine enum value for move.curve_criteria.

---

default

readonly static default: 0;

Engine enum value for move.default.

---

dodge

readonly static dodge: 1;

Engine enum value for move.dodge.

---

down

readonly static down: 64;

Engine enum value for move.down.

---

drag

readonly static drag: 3;

Engine enum value for move.drag.

---

force

readonly static force: 1;

Engine enum value for move.force.

---

fwd

readonly static fwd: 2;

Engine enum value for move.fwd.

---

handbrake

readonly static handbrake: 128;

Engine enum value for move.handbrake.

---

jump

readonly static jump: 4;

Engine enum value for move.jump.

---

left

readonly static left: 8;

Engine enum value for move.left.

---

line

readonly static line: 0;

Engine enum value for move.line.

---

none

readonly static none: 1;

Engine enum value for move.none.

---

off

readonly static off: 512;

Engine enum value for move.off.

---

on

readonly static on: 256;

Engine enum value for move.on.

---

right

readonly static right: 16;

Engine enum value for move.right.

---

run

readonly static run: 1;

Fast run movement type, not sprint but generic fast movement.

---

run_fwd

readonly static run_fwd: 2;

Engine enum value for move.run_fwd.

---

run_with_leader

readonly static run_with_leader: 7;

Engine enum value for move.run_with_leader.

---

stand

readonly static stand: 2;

Engine enum value for move.stand.

---

standing

readonly static standing: 1;

Engine enum value for move.standing.

---

steal

readonly static steal: 5;

Engine enum value for move.steal.

---

up

readonly static up: 32;

Engine enum value for move.up.

---

walk

readonly static walk: 0;

Normal walk movement type, generic movement type used in most cases.

---

walk_bkwd

readonly static walk_bkwd: 1;

Engine enum value for move.walk_bkwd.

---

walk_fwd

readonly static walk_fwd: 0;

Engine enum value for move.walk_fwd.

---

walk_with_leader

readonly static walk_with_leader: 6;

Engine enum value for move.walk_with_leader.