Class: MockWorldState

Mock of the X-Ray engine logics world state.

Extends

• MockLuabindClass

Implements

• world_state

Accessors

__name

Get Signature

get __name(): string;

Returns

string

Implementation of

world_state.__name

Inherited from

MockLuabindClass.__name

---

__name

Get Signature

get static __name(): string;

Returns

string

Inherited from

MockLuabindClass.__name

Constructors

Constructor

new MockWorldState(state?: world_state): MockWorldState;

Parameters

Parameter	Type
state?	world_state

Returns

MockWorldState

Overrides

MockLuabindClass.constructor

Methods

add_property()

add_property(property: world_property): void;

Set property for world state.

Parameters

Parameter	Type	Description
property	world_property	Target property to add in world state.

Returns

void

Implementation of

world_state.add_property

---

clear()

clear(): void;

Clear all properties in the state.

Returns

void

Implementation of

world_state.clear

---

includes()

includes(state: world_state): boolean;

Check if provided state is subset of current one.

Parameters

Parameter	Type	Description
state	world_state	Target state to check.

Returns

boolean

Whether current world state includes provided state.

Implementation of

world_state.includes

---

property()

property(id: number): world_property;

Get world property by id.

Parameters

Parameter	Type	Description
id	number	Numeric if of the required property.

Returns

world_property

Property id/state based on provided id.

Implementation of

world_state.property

---

remove_property()

remove_property(id: number): void;

Remove world property from current world state.

Parameters

Parameter	Type	Description
id	number	Identifier of the property to remove.

Returns

void

Implementation of

world_state.remove_property

---

create()

static create(state?: world_state): MockWorldState;

Parameters

Parameter	Type
state?	world_state

Returns

MockWorldState

Overrides

MockLuabindClass.create

---

mock()

static mock(state?: world_state): world_state;

Parameters

Parameter	Type
state?	world_state

Returns

world_state

Overrides

MockLuabindClass.mock

Properties

properties

properties: world_property[] = [];