XRF X-Ray 16 SDK

Appearance

Class: MockAlifeItem ​

Mock alife item server object.

Extends ​

Extended by ​

Implements ​

  • cse_alife_item

Accessors ​

__name ​

Get Signature ​

ts
get __name(): string;
Returns ​

string

Implementation of ​

ts
cse_alife_item.__name

Inherited from ​

MockAlifeDynamicObjectVisual.__name

__name ​

Get Signature ​

ts
get static __name(): string;
Returns ​

string

Inherited from ​

MockAlifeDynamicObjectVisual.__name

Constructors ​

Constructor ​

ts
new MockAlifeItem(config?: 
  | string
  | IMockAlifeObjectConfig): MockAlifeItem;

Parameters ​

ParameterType
config| string | IMockAlifeObjectConfig

Returns ​

MockAlifeItem

Inherited from ​

MockAlifeDynamicObjectVisual.constructor

Methods ​

add_upgrade() ​

ts
add_upgrade(section: string): void;

Add an upgrade section to the item.

Parameters ​

ParameterTypeDescription
sectionstringUpgrade section id.

Returns ​

void

Remarks ​

Adding the same upgrade twice is a fatal engine error.

Implementation of ​

ts
cse_alife_item.add_upgrade

bfUseful() ​

ts
bfUseful(): boolean;

Returns ​

boolean

Whether the ALife item is useful to AI.

Implementation of ​

ts
cse_alife_item.bfUseful

can_save() ​

ts
can_save(): boolean;

Returns ​

boolean

Whether this object should be saved.

Implementation of ​

ts
cse_alife_item.can_save

Inherited from ​

MockAlifeDynamicObjectVisual.can_save

can_switch_offline() ​

Call Signature ​

ts
can_switch_offline(): boolean;
Returns ​

boolean

Whether this object may switch offline.

Implementation of ​
ts
cse_alife_item.can_switch_offline
Inherited from ​

MockAlifeDynamicObjectVisual.can_switch_offline

Call Signature ​

ts
can_switch_offline(value: boolean): void;

Allow or block switching offline.

Parameters ​
ParameterTypeDescription
valuebooleanWhether offline switching is allowed.
Returns ​

void

Remarks ​

Sets the object's switch-offline flag; it does not switch the object immediately.

Implementation of ​
ts
cse_alife_item.can_switch_offline
Inherited from ​

MockAlifeDynamicObjectVisual.can_switch_offline

can_switch_online() ​

Call Signature ​

ts
can_switch_online(): boolean;
Returns ​

boolean

Whether this object may switch online.

Implementation of ​
ts
cse_alife_item.can_switch_online
Inherited from ​

MockAlifeDynamicObjectVisual.can_switch_online

Call Signature ​

ts
can_switch_online(value: boolean): void;

Allow or block switching online.

Parameters ​
ParameterTypeDescription
valuebooleanWhether online switching is allowed.
Returns ​

void

Remarks ​

Sets the object's switch-online flag; it does not switch the object immediately.

Implementation of ​
ts
cse_alife_item.can_switch_online
Inherited from ​

MockAlifeDynamicObjectVisual.can_switch_online

clsid() ​

ts
clsid(): TXR_class_id;

Returns ​

TXR_class_id

Engine class id.

Implementation of ​

ts
cse_alife_item.clsid

Inherited from ​

MockAlifeDynamicObjectVisual.clsid

FillProps() ​

ts
FillProps(_pref: string, _items: prop_item_vec): void;

Fill editor property rows for this object.

Parameters ​

ParameterType
_prefstring
_itemsprop_item_vec

Returns ​

void

Implementation of ​

ts
cse_alife_item.FillProps

Inherited from ​

MockAlifeDynamicObjectVisual.FillProps

has_upgrade() ​

ts
has_upgrade(section: string): boolean;

Check whether the item already has an upgrade section.

Parameters ​

ParameterTypeDescription
sectionstringUpgrade section id.

Returns ​

boolean

Whether the upgrade is installed.

Implementation of ​

ts
cse_alife_item.has_upgrade

init() ​

ts
init(): cse_alife_object;

Initialize the ALife object and return its abstract base.

Returns ​

cse_alife_object

Initialized abstract entity.

Implementation of ​

ts
cse_alife_item.init

Inherited from ​

MockAlifeDynamicObjectVisual.init

interactive() ​

ts
interactive(): boolean;

Returns ​

boolean

Whether the object is interactive.

Implementation of ​

ts
cse_alife_item.interactive

Inherited from ​

MockAlifeDynamicObjectVisual.interactive

keep_saved_data_anyway() ​

ts
keep_saved_data_anyway(): boolean;

Returns ​

boolean

Implementation of ​

ts
cse_alife_item.keep_saved_data_anyway

Inherited from ​

MockAlifeDynamicObjectVisual.keep_saved_data_anyway

move_offline() ​

Call Signature ​

ts
move_offline(): boolean;
Returns ​

boolean

Whether the object should move while offline.

Implementation of ​
ts
cse_alife_item.move_offline
Inherited from ​

MockAlifeDynamicObjectVisual.move_offline

Call Signature ​

ts
move_offline(value: boolean): void;

Set whether the object should move while offline.

Parameters ​
ParameterTypeDescription
valuebooleanWhether offline movement is enabled.
Returns ​

void

Implementation of ​
ts
cse_alife_item.move_offline
Inherited from ​

MockAlifeDynamicObjectVisual.move_offline

name() ​

ts
name<T>(): T;

Type Parameters ​

Type Parameter
T extends string

Returns ​

T

Runtime object name.

Implementation of ​

ts
cse_alife_item.name

Inherited from ​

MockAlifeDynamicObjectVisual.name

on_before_register() ​

ts
on_before_register(): void;

Returns ​

void

Implementation of ​

ts
cse_alife_item.on_before_register

Inherited from ​

MockAlifeDynamicObjectVisual.on_before_register

on_register() ​

ts
on_register(): void;

Returns ​

void

Implementation of ​

ts
cse_alife_item.on_register

Inherited from ​

MockAlifeDynamicObjectVisual.on_register

on_spawn() ​

ts
on_spawn(): void;

Returns ​

void

Implementation of ​

ts
cse_alife_item.on_spawn

Inherited from ​

MockAlifeDynamicObjectVisual.on_spawn

on_unregister() ​

ts
on_unregister(): void;

Returns ​

void

Implementation of ​

ts
cse_alife_item.on_unregister

Inherited from ​

MockAlifeDynamicObjectVisual.on_unregister

section_name() ​

ts
section_name<T>(): T;

Type Parameters ​

Type Parameter
T extends string

Returns ​

T

Spawn section name.

Implementation of ​

ts
cse_alife_item.section_name

Inherited from ​

MockAlifeDynamicObjectVisual.section_name

set_yaw() ​

ts
set_yaw(yaw: number): void;

Set object yaw.

Parameters ​

ParameterTypeDescription
yawnumberYaw angle.

Returns ​

void

Implementation of ​

ts
cse_alife_item.set_yaw

Inherited from ​

MockAlifeDynamicObjectVisual.set_yaw

STATE_Read() ​

ts
STATE_Read(packet: net_packet, size: number): void;

Read a state packet into this object.

Parameters ​

ParameterTypeDescription
packetnet_packetSource network packet.
sizenumberSerialized state size.

Returns ​

void

Remarks ​

Use only with packets written for the same server object class and state format.

Implementation of ​

ts
cse_alife_item.STATE_Read

Inherited from ​

MockAlifeDynamicObjectVisual.STATE_Read

STATE_Write() ​

ts
STATE_Write(packet: net_packet): void;

Write a state packet from this object.

Parameters ​

ParameterTypeDescription
packetnet_packetTarget network packet.

Returns ​

void

Implementation of ​

ts
cse_alife_item.STATE_Write

Inherited from ​

MockAlifeDynamicObjectVisual.STATE_Write

switch_offline() ​

ts
switch_offline(): void;

Mark the server object offline.

Returns ​

void

Source ​

src/xrGame/alife_dynamic_object.cpp, CSE_ALifeDynamicObject::switch_offline.

Remarks ​

Requires the object to be online. The base implementation marks it offline, removes it from the online ALife set, and clears client data unless keep_saved_data_anyway() returns true.

Implementation of ​

ts
cse_alife_item.switch_offline

Inherited from ​

MockAlifeDynamicObjectVisual.switch_offline

switch_online() ​

ts
switch_online(): void;

Mark the server object online.

Returns ​

void

Source ​

src/xrGame/alife_dynamic_object.cpp, CSE_ALifeDynamicObject::switch_online.

Remarks ​

Requires the object to be offline. The base implementation marks it online and adds it to the online ALife set. Use the simulator switch manager for normal distance-based switching.

Implementation of ​

ts
cse_alife_item.switch_online

Inherited from ​

MockAlifeDynamicObjectVisual.switch_online

update() ​

ts
update(): void;

Declared on the prototype rather than as an own jest.fn() field.

Returns ​

void

Remarks ​

Server objects override update and call super.update(). An own instance field is installed by this constructor before the subclass body runs, so it would shadow the subclass override entirely and leave super.update undefined. Spy on it with jest.spyOn(object, "update") when call assertions are needed.

Implementation of ​

ts
cse_alife_item.update

Inherited from ​

MockAlifeDynamicObjectVisual.update

UPDATE_Read() ​

ts
UPDATE_Read(packet: net_packet): void;

Read an update packet into this object.

Parameters ​

ParameterTypeDescription
packetnet_packetSource network packet.

Returns ​

void

Remarks ​

Use only with packets written for the same server object class and update format.

Implementation of ​

ts
cse_alife_item.UPDATE_Read

Inherited from ​

MockAlifeDynamicObjectVisual.UPDATE_Read

UPDATE_Write() ​

ts
UPDATE_Write(packet: net_packet): void;

Write an update packet from this object.

Parameters ​

ParameterTypeDescription
packetnet_packetTarget network packet.

Returns ​

void

Implementation of ​

ts
cse_alife_item.UPDATE_Write

Inherited from ​

MockAlifeDynamicObjectVisual.UPDATE_Write

use_ai_locations() ​

ts
use_ai_locations(value: boolean): void;

Enable or disable AI location graph use.

Parameters ​

ParameterTypeDescription
valuebooleanWhether AI locations should be used.

Returns ​

void

Implementation of ​

ts
cse_alife_item.use_ai_locations

Inherited from ​

MockAlifeDynamicObjectVisual.use_ai_locations

used_ai_locations() ​

ts
used_ai_locations(): boolean;

Returns ​

boolean

Whether the object uses AI location graph data.

Implementation of ​

ts
cse_alife_item.used_ai_locations

Inherited from ​

MockAlifeDynamicObjectVisual.used_ai_locations

visible_for_map() ​

Call Signature ​

ts
visible_for_map(): boolean;
Returns ​

boolean

Whether the object is visible on the map.

Implementation of ​
ts
cse_alife_item.visible_for_map
Inherited from ​

MockAlifeDynamicObjectVisual.visible_for_map

Call Signature ​

ts
visible_for_map(value: boolean): void;

Set whether the object is visible on the map.

Parameters ​
ParameterTypeDescription
valuebooleanWhether the object should be shown on the map.
Returns ​

void

Implementation of ​
ts
cse_alife_item.visible_for_map
Inherited from ​

MockAlifeDynamicObjectVisual.visible_for_map

create() ​

ts
static create(config?: IMockAlifeObjectConfig): MockAlifeItem;

Parameters ​

ParameterType
configIMockAlifeObjectConfig

Returns ​

MockAlifeItem

Overrides ​

MockAlifeDynamicObjectVisual.create

mock() ​

ts
static mock(config?: IMockAlifeObjectConfig): cse_alife_item;

Parameters ​

ParameterType
configIMockAlifeObjectConfig

Returns ​

cse_alife_item

Overrides ​

MockAlifeDynamicObjectVisual.mock

mockWithClassId() ​

ts
static mockWithClassId(classId: number): cse_alife_object;

Parameters ​

ParameterType
classIdnumber

Returns ​

cse_alife_object

Inherited from ​

MockAlifeDynamicObjectVisual.mockWithClassId

toMock() ​

ts
static toMock(object: cse_alife_object): MockAlifeObject;

Parameters ​

ParameterType
objectcse_alife_object

Returns ​

MockAlifeObject

Inherited from ​

MockAlifeDynamicObjectVisual.toMock

Properties ​

alive ​

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

Inherited from ​

MockAlifeDynamicObjectVisual.alive

angle ​

ts
angle: vector;

Server-side orientation angles.

Implementation of ​

ts
cse_alife_item.angle

Inherited from ​

MockAlifeDynamicObjectVisual.angle

canSave ​

ts
canSave: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.canSave

canSwitchOffline ​

ts
canSwitchOffline: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.canSwitchOffline

canSwitchOnline ​

ts
canSwitchOnline: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.canSwitchOnline

classId ​

ts
classId: TXR_class_id;

Inherited from ​

MockAlifeDynamicObjectVisual.classId

clear_smart_terrain ​

ts
clear_smart_terrain: Mock<UnknownFunction>;

Inherited from ​

MockAlifeDynamicObjectVisual.clear_smart_terrain

community ​

ts
community: <T>() => T;

Type Parameters ​

Type ParameterDefault type
T extends stringstring

Returns ​

T

Inherited from ​

MockAlifeDynamicObjectVisual.community

id ​

ts
id: number;

Server object id.

Implementation of ​

ts
cse_alife_item.id

Inherited from ​

MockAlifeDynamicObjectVisual.id

isInteractive ​

ts
isInteractive: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.isInteractive

isUsefulForNpc ​

ts
isUsefulForNpc: boolean = false;

isVisibleForMap ​

ts
isVisibleForMap: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.isVisibleForMap

m_game_vertex_id ​

ts
m_game_vertex_id: number;

Game graph vertex used by ALife simulation.

Implementation of ​

ts
cse_alife_item.m_game_vertex_id

Inherited from ​

MockAlifeDynamicObjectVisual.m_game_vertex_id

m_level_vertex_id ​

ts
m_level_vertex_id: number;

Level graph vertex used by ALife simulation.

Implementation of ​

ts
cse_alife_item.m_level_vertex_id

Inherited from ​

MockAlifeDynamicObjectVisual.m_level_vertex_id

m_story_id ​

ts
m_story_id: number;

Always numeric value. Returns maximal u32 (4294967295) value if object has no story id.

Implementation of ​

ts
cse_alife_item.m_story_id

Inherited from ​

MockAlifeDynamicObjectVisual.m_story_id

objectAlive ​

ts
objectAlive: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.objectAlive

objectCommunity ​

ts
objectCommunity: string;

Inherited from ​

MockAlifeDynamicObjectVisual.objectCommunity

objectName ​

ts
objectName: string;

Inherited from ​

MockAlifeDynamicObjectVisual.objectName

objectUpgrades ​

ts
objectUpgrades: Set<string>;

online ​

ts
online: boolean;

Whether server object has client representation and is in online mode.

Implementation of ​

ts
cse_alife_item.online

Inherited from ​

MockAlifeDynamicObjectVisual.online

parent_id ​

ts
parent_id: number;

Parent server object id, or 65535 when there is no parent.

Implementation of ​

ts
cse_alife_item.parent_id

Inherited from ​

MockAlifeDynamicObjectVisual.parent_id

position ​

ts
position: vector;

Server-side world position.

Implementation of ​

ts
cse_alife_item.position

Inherited from ​

MockAlifeDynamicObjectVisual.position

script_version ​

ts
script_version: number;

Script data version stored with this object.

Implementation of ​

ts
cse_alife_item.script_version

Inherited from ​

MockAlifeDynamicObjectVisual.script_version

section ​

ts
section: string;

Inherited from ​

MockAlifeDynamicObjectVisual.section

shouldMoveOffline ​

ts
shouldMoveOffline: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.shouldMoveOffline

spawn_ini ​

ts
spawn_ini: Mock<() => ini_file | null>;

Returns ​

Spawn ini attached to this object, if any.

Implementation of ​

ts
cse_alife_item.spawn_ini

Inherited from ​

MockAlifeDynamicObjectVisual.spawn_ini

spawnIni ​

ts
spawnIni: ini_file | null;

Inherited from ​

MockAlifeDynamicObjectVisual.spawnIni

usesAiLocations ​

ts
usesAiLocations: boolean;

Inherited from ​

MockAlifeDynamicObjectVisual.usesAiLocations