Class: MockZoneVisual

Mock visual zone server object.

Extends

MockAnomalousZone

Implements

cse_zone_visual

Accessors

__name

Get Signature

get __name(): string;

Returns

string

Implementation of

cse_zone_visual.__name

Inherited from

MockAnomalousZone.__name

__name

Get Signature

get static __name(): string;

Returns

string

Inherited from

MockAnomalousZone.__name

Constructors

Constructor

new MockZoneVisual(config?: 
  | string
  | IMockAlifeObjectConfig): MockZoneVisual;

Parameters

Parameter	Type
`config`	\| `string` \| `IMockAlifeObjectConfig`

Returns

MockZoneVisual

Inherited from

MockAnomalousZone.constructor

Methods

can_save()

can_save(): boolean;

Returns

boolean

Whether this object should be saved.

Implementation of

cse_zone_visual.can_save

Inherited from

MockAnomalousZone.can_save

can_switch_offline()

Call Signature

can_switch_offline(): boolean;

Returns

boolean

Whether this object may switch offline.

Implementation of

cse_zone_visual.can_switch_offline

Inherited from

MockAnomalousZone.can_switch_offline

Call Signature

can_switch_offline(value: boolean): void;

Allow or block switching offline.

Parameters

Parameter	Type	Description
`value`	`boolean`	Whether offline switching is allowed.

Returns

void

Remarks

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

Implementation of

cse_zone_visual.can_switch_offline

Inherited from

MockAnomalousZone.can_switch_offline

can_switch_online()

Call Signature

can_switch_online(): boolean;

Returns

boolean

Whether this object may switch online.

Implementation of

cse_zone_visual.can_switch_online

Inherited from

MockAnomalousZone.can_switch_online

Call Signature

can_switch_online(value: boolean): void;

Allow or block switching online.

Parameters

Parameter	Type	Description
`value`	`boolean`	Whether online switching is allowed.

Returns

void

Remarks

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

Implementation of

cse_zone_visual.can_switch_online

Inherited from

MockAnomalousZone.can_switch_online

clsid()

clsid(): TXR_class_id;

Returns

TXR_class_id

Engine class id.

Implementation of

cse_zone_visual.clsid

Inherited from

MockAnomalousZone.clsid

FillProps()

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

Fill editor property rows for this object.

Parameters

Parameter	Type
`_pref`	`string`
`_items`	`prop_item_vec`

Returns

void

Implementation of

cse_zone_visual.FillProps

Inherited from

MockAnomalousZone.FillProps

init()

init(): cse_alife_object;

Initialize the ALife object and return its abstract base.

Returns

cse_alife_object

Initialized abstract entity.

Implementation of

cse_zone_visual.init

Inherited from

MockAnomalousZone.init

interactive()

interactive(): boolean;

Returns

boolean

Whether the object is interactive.

Implementation of

cse_zone_visual.interactive

Inherited from

MockAnomalousZone.interactive

keep_saved_data_anyway()

keep_saved_data_anyway(): boolean;

Returns

boolean

Implementation of

cse_zone_visual.keep_saved_data_anyway

Inherited from

MockAnomalousZone.keep_saved_data_anyway

move_offline()

Call Signature

move_offline(): boolean;

Returns

boolean

Whether the object should move while offline.

Implementation of

cse_zone_visual.move_offline

Inherited from

MockAnomalousZone.move_offline

Call Signature

move_offline(value: boolean): void;

Set whether the object should move while offline.

Parameters

Parameter	Type	Description
`value`	`boolean`	Whether offline movement is enabled.

Returns

void

Implementation of

cse_zone_visual.move_offline

Inherited from

MockAnomalousZone.move_offline

name()

name<T>(): T;

Type Parameters

Type Parameter
`T` extends `string`

Returns

T

Runtime object name.

Implementation of

cse_zone_visual.name

Inherited from

MockAnomalousZone.name

on_before_register()

on_before_register(): void;

Returns

void

Implementation of

cse_zone_visual.on_before_register

Inherited from

MockAnomalousZone.on_before_register

on_register()

on_register(): void;

Returns

void

Implementation of

cse_zone_visual.on_register

Inherited from

MockAnomalousZone.on_register

on_spawn()

on_spawn(): void;

Returns

void

Implementation of

cse_zone_visual.on_spawn

Inherited from

MockAnomalousZone.on_spawn

on_unregister()

on_unregister(): void;

Returns

void

Implementation of

cse_zone_visual.on_unregister

Inherited from

MockAnomalousZone.on_unregister

section_name()

section_name<T>(): T;

Type Parameters

Type Parameter
`T` extends `string`

Returns

T

Spawn section name.

Implementation of

cse_zone_visual.section_name

Inherited from

MockAnomalousZone.section_name

STATE_Read()

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

Read a state packet into this object.

Parameters

Parameter	Type	Description
`packet`	`net_packet`	Source network packet.
`size`	`number`	Serialized state size.

Returns

void

Remarks

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

Implementation of

cse_zone_visual.STATE_Read

Inherited from

MockAnomalousZone.STATE_Read

STATE_Write()

STATE_Write(packet: net_packet): void;

Write a state packet from this object.

Parameters

Parameter	Type	Description
`packet`	`net_packet`	Target network packet.

Returns

void

Implementation of

cse_zone_visual.STATE_Write

Inherited from

MockAnomalousZone.STATE_Write

switch_offline()

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

cse_zone_visual.switch_offline

Inherited from

MockAnomalousZone.switch_offline

switch_online()

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

cse_zone_visual.switch_online

Inherited from

MockAnomalousZone.switch_online

update()

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

cse_zone_visual.update

Inherited from

MockAnomalousZone.update

UPDATE_Read()

UPDATE_Read(packet: net_packet): void;

Read an update packet into this object.

Parameters

Parameter	Type	Description
`packet`	`net_packet`	Source network packet.

Returns

void

Remarks

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

Implementation of

cse_zone_visual.UPDATE_Read

Inherited from

MockAnomalousZone.UPDATE_Read

UPDATE_Write()

UPDATE_Write(packet: net_packet): void;

Write an update packet from this object.

Parameters

Parameter	Type	Description
`packet`	`net_packet`	Target network packet.

Returns

void

Implementation of

cse_zone_visual.UPDATE_Write

Inherited from

MockAnomalousZone.UPDATE_Write

use_ai_locations()

use_ai_locations(value: boolean): void;

Enable or disable AI location graph use.

Parameters

Parameter	Type	Description
`value`	`boolean`	Whether AI locations should be used.

Returns

void

Implementation of

cse_zone_visual.use_ai_locations

Inherited from

MockAnomalousZone.use_ai_locations

used_ai_locations()

used_ai_locations(): boolean;

Returns

boolean

Whether the object uses AI location graph data.

Implementation of

cse_zone_visual.used_ai_locations

Inherited from

MockAnomalousZone.used_ai_locations

visible_for_map()

Call Signature

visible_for_map(): boolean;

Returns

boolean

Whether the object is visible on the map.

Implementation of

cse_zone_visual.visible_for_map

Inherited from

MockAnomalousZone.visible_for_map

Call Signature

visible_for_map(value: boolean): void;

Set whether the object is visible on the map.

Parameters

Parameter	Type	Description
`value`	`boolean`	Whether the object should be shown on the map.

Returns

void

Implementation of

cse_zone_visual.visible_for_map

Inherited from

MockAnomalousZone.visible_for_map

create()

static create(config?: IMockAlifeObjectConfig): MockZoneVisual;

Parameters

Parameter	Type
`config`	`IMockAlifeObjectConfig`

Returns

MockZoneVisual

Overrides

MockAnomalousZone.create

mock()

static mock(config?: IMockAlifeObjectConfig): cse_zone_visual;

Parameters

Parameter	Type
`config`	`IMockAlifeObjectConfig`

Returns

cse_zone_visual

Overrides

MockAnomalousZone.mock

mockWithClassId()

static mockWithClassId(classId: number): cse_alife_object;

Parameters

Parameter	Type
`classId`	`number`

Returns

cse_alife_object

Inherited from

MockAnomalousZone.mockWithClassId

toMock()

static toMock(object: cse_alife_object): MockAlifeObject;

Parameters

Parameter	Type
`object`	`cse_alife_object`

Returns

MockAlifeObject

Inherited from

MockAnomalousZone.toMock

Properties

alive

alive: Mock<() => boolean>;

Inherited from

MockAnomalousZone.alive

angle

angle: vector;

Server-side orientation angles.

Implementation of

cse_zone_visual.angle

Inherited from

MockAnomalousZone.angle

canSave

canSave: boolean;

Inherited from

MockAnomalousZone.canSave

canSwitchOffline

canSwitchOffline: boolean;

Inherited from

MockAnomalousZone.canSwitchOffline

canSwitchOnline

canSwitchOnline: boolean;

Inherited from

MockAnomalousZone.canSwitchOnline

classId

classId: TXR_class_id;

Inherited from

MockAnomalousZone.classId

clear_smart_terrain

clear_smart_terrain: Mock<UnknownFunction>;

Inherited from

MockAnomalousZone.clear_smart_terrain

community

community: <T>() => T;

Type Parameters

Type Parameter	Default type
`T` extends `string`	`string`

Returns

T

Inherited from

MockAnomalousZone.community

id

id: number;

Server object id.

Implementation of

cse_zone_visual.id

Inherited from

MockAnomalousZone.id

isInteractive

isInteractive: boolean;

Inherited from

MockAnomalousZone.isInteractive

isVisibleForMap

isVisibleForMap: boolean;

Inherited from

MockAnomalousZone.isVisibleForMap

m_game_vertex_id

m_game_vertex_id: number;

Game graph vertex used by ALife simulation.

Implementation of

cse_zone_visual.m_game_vertex_id

Inherited from

MockAnomalousZone.m_game_vertex_id

m_level_vertex_id

m_level_vertex_id: number;

Level graph vertex used by ALife simulation.

Implementation of

cse_zone_visual.m_level_vertex_id

Inherited from

MockAnomalousZone.m_level_vertex_id

m_story_id

m_story_id: number;

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

Implementation of

cse_zone_visual.m_story_id

Inherited from

MockAnomalousZone.m_story_id

objectAlive

objectAlive: boolean;

Inherited from

MockAnomalousZone.objectAlive

objectCommunity

objectCommunity: string;

Inherited from

MockAnomalousZone.objectCommunity

objectName

objectName: string;

Inherited from

MockAnomalousZone.objectName

online

online: boolean;

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

Implementation of

cse_zone_visual.online

Inherited from

MockAnomalousZone.online

parent_id

parent_id: number;

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

Implementation of

cse_zone_visual.parent_id

Inherited from

MockAnomalousZone.parent_id

position

position: vector;

Server-side world position.

Implementation of

cse_zone_visual.position

Inherited from

MockAnomalousZone.position

script_version

script_version: number;

Script data version stored with this object.

Implementation of

cse_zone_visual.script_version

Inherited from

MockAnomalousZone.script_version

section

section: string;

Inherited from

MockAnomalousZone.section

shouldMoveOffline

shouldMoveOffline: boolean;

Inherited from

MockAnomalousZone.shouldMoveOffline

spawn_ini

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

Returns

Spawn ini attached to this object, if any.

Implementation of

cse_zone_visual.spawn_ini

Inherited from

MockAnomalousZone.spawn_ini

spawnIni

spawnIni: ini_file | null;

Inherited from

MockAnomalousZone.spawnIni

usesAiLocations

usesAiLocations: boolean;

Inherited from

MockAnomalousZone.usesAiLocations

Class: MockZoneVisual ​

Extends ​

Implements ​

Accessors ​

__name ​

Get Signature ​

Returns ​

Implementation of ​

Inherited from ​

__name ​

Get Signature ​

Returns ​

Inherited from ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Inherited from ​

Methods ​

can_save() ​

Returns ​

Implementation of ​

Inherited from ​

can_switch_offline() ​

Call Signature ​

Returns ​

Implementation of ​

Inherited from ​

Call Signature ​

Parameters ​

Returns ​

Remarks ​

Implementation of ​

Inherited from ​

can_switch_online() ​

Call Signature ​

Returns ​

Implementation of ​

Inherited from ​

Call Signature ​

Parameters ​

Returns ​

Remarks ​

Implementation of ​

Inherited from ​

clsid() ​

Returns ​

Implementation of ​

Inherited from ​

FillProps() ​

Parameters ​

Returns ​

Implementation of ​

Inherited from ​

init() ​

Returns ​

Implementation of ​

Inherited from ​

interactive() ​

Returns ​

Implementation of ​

Inherited from ​

keep_saved_data_anyway() ​

Returns ​

Implementation of ​

Inherited from ​

move_offline() ​

Call Signature ​

Returns ​

Implementation of ​

Inherited from ​

Call Signature ​

Parameters ​

Returns ​

Implementation of ​

Inherited from ​

name() ​

Type Parameters ​

Returns ​

Implementation of ​

Class: MockZoneVisual

Extends

Implements

Accessors

__name

Get Signature

Returns

Implementation of

Inherited from

__name

Get Signature

Returns

Inherited from

Constructors

Constructor

Parameters

Returns

Inherited from

Methods

can_save()

Returns

Implementation of

Inherited from

can_switch_offline()

Call Signature

Returns

Implementation of

Inherited from

Call Signature

Parameters

Returns

Remarks

Implementation of

Inherited from

can_switch_online()

Call Signature

Returns

Implementation of

Inherited from

Call Signature

Parameters

Returns

Remarks

Implementation of

Inherited from

clsid()

Returns

Implementation of

Inherited from

FillProps()

Parameters

Returns

Implementation of

Inherited from

init()

Returns

Implementation of

Inherited from

interactive()

Returns

Implementation of

Inherited from

keep_saved_data_anyway()

Returns

Implementation of

Inherited from

move_offline()

Call Signature

Returns

Implementation of

Inherited from

Call Signature

Parameters

Returns

Implementation of

Inherited from

name()

Type Parameters

Returns

Implementation of