Class: MockAlifeSmartZone

Mock alife smart zone server object.

Extends

• MockAlifeDynamicObject

Implements

• cse_alife_smart_zone

Accessors

__name

Get Signature

get __name(): string;

Returns

string

Implementation of

cse_alife_smart_zone.__name

Inherited from

MockAlifeDynamicObject.__name

---

__name

Get Signature

get static __name(): string;

Returns

string

Inherited from

MockAlifeDynamicObject.__name

Constructors

Constructor

new MockAlifeSmartZone(config?: IMockAlifeSmartZoneConfig): MockAlifeSmartZone;

Parameters

Parameter	Type
config	IMockAlifeSmartZoneConfig

Returns

MockAlifeSmartZone

Overrides

MockAlifeDynamicObject.constructor

Methods

can_save()

can_save(): boolean;

Returns

boolean

Whether this object should be saved.

Implementation of

cse_alife_smart_zone.can_save

Inherited from

MockAlifeDynamicObject.can_save

---

can_switch_offline()

Call Signature

can_switch_offline(): boolean;

Returns

boolean

Whether this object may switch offline.

Implementation of

cse_alife_smart_zone.can_switch_offline

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.can_switch_offline

Inherited from

MockAlifeDynamicObject.can_switch_offline

---

can_switch_online()

Call Signature

can_switch_online(): boolean;

Returns

boolean

Whether this object may switch online.

Implementation of

cse_alife_smart_zone.can_switch_online

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.can_switch_online

Inherited from

MockAlifeDynamicObject.can_switch_online

---

clsid()

clsid(): TXR_class_id;

Returns

TXR_class_id

Engine class id.

Implementation of

cse_alife_smart_zone.clsid

Inherited from

MockAlifeDynamicObject.clsid

---

detect_probability()

detect_probability(): number;

Returns

number

Probability used by the zone for detecting objects.

Implementation of

cse_alife_smart_zone.detect_probability

---

enabled()

enabled(_monster: cse_alife_monster_abstract): boolean;

Check whether this smart zone is enabled for a monster.

Parameters

Parameter	Type
_monster	cse_alife_monster_abstract

Returns

boolean

Whether the zone can be used.

Implementation of

cse_alife_smart_zone.enabled

---

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_alife_smart_zone.FillProps

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.init

Inherited from

MockAlifeDynamicObject.init

---

interactive()

interactive(): boolean;

Returns

boolean

Whether the object is interactive.

Implementation of

cse_alife_smart_zone.interactive

Inherited from

MockAlifeDynamicObject.interactive

---

keep_saved_data_anyway()

keep_saved_data_anyway(): boolean;

Returns

boolean

Implementation of

cse_alife_smart_zone.keep_saved_data_anyway

Inherited from

MockAlifeDynamicObject.keep_saved_data_anyway

---

move_offline()

Call Signature

move_offline(): boolean;

Returns

boolean

Whether the object should move while offline.

Implementation of

cse_alife_smart_zone.move_offline

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.move_offline

Inherited from

MockAlifeDynamicObject.move_offline

---

name()

name<T>(): T;

Type Parameters

Type Parameter
T extends string

Returns

T

Runtime object name.

Implementation of

cse_alife_smart_zone.name

Inherited from

MockAlifeDynamicObject.name

---

on_before_register()

on_before_register(): void;

Returns

void

Implementation of

cse_alife_smart_zone.on_before_register

Inherited from

MockAlifeDynamicObject.on_before_register

---

on_register()

on_register(): void;

Returns

void

Implementation of

cse_alife_smart_zone.on_register

Inherited from

MockAlifeDynamicObject.on_register

---

on_spawn()

on_spawn(): void;

Returns

void

Implementation of

cse_alife_smart_zone.on_spawn

Inherited from

MockAlifeDynamicObject.on_spawn

---

on_unregister()

on_unregister(): void;

Returns

void

Implementation of

cse_alife_smart_zone.on_unregister

Inherited from

MockAlifeDynamicObject.on_unregister

---

register_npc()

register_npc(monster: cse_alife_monster_abstract): void;

Register a monster in the smart zone.

Parameters

Parameter	Type	Description
monster	cse_alife_monster_abstract	Monster server object.

Returns

void

Implementation of

cse_alife_smart_zone.register_npc

---

section_name()

section_name<T>(): T;

Type Parameters

Type Parameter
T extends string

Returns

T

Spawn section name.

Implementation of

cse_alife_smart_zone.section_name

Inherited from

MockAlifeDynamicObject.section_name

---

smart_touch()

smart_touch(_monster: cse_alife_monster_abstract): void;

Notify the smart zone that a monster touched it.

Parameters

Parameter	Type
_monster	cse_alife_monster_abstract

Returns

void

Remarks

The base implementation is empty; concrete smart zones can override behavior.

Implementation of

cse_alife_smart_zone.smart_touch

---

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_alife_smart_zone.STATE_Read

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.STATE_Write

Inherited from

MockAlifeDynamicObject.STATE_Write

---

suitable()

suitable(_monster: cse_alife_monster_abstract): number;

Rate how suitable this smart zone is for a monster.

Parameters

Parameter	Type
_monster	cse_alife_monster_abstract

Returns

number

Suitability score.

Implementation of

cse_alife_smart_zone.suitable

---

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_alife_smart_zone.switch_offline

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.switch_online

Inherited from

MockAlifeDynamicObject.switch_online

---

task()

task(_monster: cse_alife_monster_abstract): CALifeSmartTerrainTask | null;

Get the smart terrain task assigned to a monster.

Parameters

Parameter	Type
_monster	cse_alife_monster_abstract

Returns

CALifeSmartTerrainTask | null

Smart terrain task, or null when none is assigned.

Implementation of

cse_alife_smart_zone.task

---

unregister_npc()

unregister_npc(monster: cse_alife_monster_abstract): void;

Remove a monster from the smart zone.

Parameters

Parameter	Type	Description
monster	cse_alife_monster_abstract	Monster server object.

Returns

void

Implementation of

cse_alife_smart_zone.unregister_npc

---

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_alife_smart_zone.UPDATE_Read

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.UPDATE_Write

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.use_ai_locations

Inherited from

MockAlifeDynamicObject.use_ai_locations

---

used_ai_locations()

used_ai_locations(): boolean;

Returns

boolean

Whether the object uses AI location graph data.

Implementation of

cse_alife_smart_zone.used_ai_locations

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.visible_for_map

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.visible_for_map

Inherited from

MockAlifeDynamicObject.visible_for_map

---

create()

static create(config?: IMockAlifeSmartZoneConfig): MockAlifeSmartZone;

Parameters

Parameter	Type
config	IMockAlifeSmartZoneConfig

Returns

MockAlifeSmartZone

Overrides

MockAlifeDynamicObject.create

---

mock()

static mock(config?: IMockAlifeSmartZoneConfig): cse_alife_smart_zone;

Parameters

Parameter	Type
config	IMockAlifeSmartZoneConfig

Returns

cse_alife_smart_zone

Overrides

MockAlifeDynamicObject.mock

---

mockWithClassId()

static mockWithClassId(classId: number): cse_alife_object;

Parameters

Parameter	Type
classId	number

Returns

cse_alife_object

Inherited from

MockAlifeDynamicObject.mockWithClassId

---

toMock()

static toMock(object: cse_alife_object): MockAlifeObject;

Parameters

Parameter	Type
object	cse_alife_object

Returns

MockAlifeObject

Inherited from

MockAlifeDynamicObject.toMock

Properties

alive

alive: Mock<() => boolean>;

Inherited from

MockAlifeDynamicObject.alive

---

angle

angle: vector;

Server-side orientation angles.

Implementation of

cse_alife_smart_zone.angle

Inherited from

MockAlifeDynamicObject.angle

---

canSave

canSave: boolean;

Inherited from

MockAlifeDynamicObject.canSave

---

canSwitchOffline

canSwitchOffline: boolean;

Inherited from

MockAlifeDynamicObject.canSwitchOffline

---

canSwitchOnline

canSwitchOnline: boolean;

Inherited from

MockAlifeDynamicObject.canSwitchOnline

---

classId

classId: TXR_class_id;

Inherited from

MockAlifeDynamicObject.classId

---

clear_smart_terrain

clear_smart_terrain: Mock<UnknownFunction>;

Inherited from

MockAlifeDynamicObject.clear_smart_terrain

---

community

community: <T>() => T;

Type Parameters

Type Parameter	Default type
T extends string	string

Returns

T

Inherited from

MockAlifeDynamicObject.community

---

id

id: number;

Server object id.

Implementation of

cse_alife_smart_zone.id

Inherited from

MockAlifeDynamicObject.id

---

isInteractive

isInteractive: boolean;

Inherited from

MockAlifeDynamicObject.isInteractive

---

isVisibleForMap

isVisibleForMap: boolean;

Inherited from

MockAlifeDynamicObject.isVisibleForMap

---

m_game_vertex_id

m_game_vertex_id: number;

Game graph vertex used by ALife simulation.

Implementation of

cse_alife_smart_zone.m_game_vertex_id

Inherited from

MockAlifeDynamicObject.m_game_vertex_id

---

m_level_vertex_id

m_level_vertex_id: number;

Level graph vertex used by ALife simulation.

Implementation of

cse_alife_smart_zone.m_level_vertex_id

Inherited from

MockAlifeDynamicObject.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_alife_smart_zone.m_story_id

Inherited from

MockAlifeDynamicObject.m_story_id

---

objectAlive

objectAlive: boolean;

Inherited from

MockAlifeDynamicObject.objectAlive

---

objectCommunity

objectCommunity: string;

Inherited from

MockAlifeDynamicObject.objectCommunity

---

objectDetectProbability

objectDetectProbability: number;

---

objectEnabled

objectEnabled: boolean;

---

objectName

objectName: string;

Inherited from

MockAlifeDynamicObject.objectName

---

objectSuitable

objectSuitable: number;

---

objectTask

objectTask: CALifeSmartTerrainTask | null;

---

online

online: boolean;

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

Implementation of

cse_alife_smart_zone.online

Inherited from

MockAlifeDynamicObject.online

---

parent_id

parent_id: number;

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

Implementation of

cse_alife_smart_zone.parent_id

Inherited from

MockAlifeDynamicObject.parent_id

---

position

position: vector;

Server-side world position.

Implementation of

cse_alife_smart_zone.position

Inherited from

MockAlifeDynamicObject.position

---

registeredNpcs

registeredNpcs: Map<number, cse_alife_monster_abstract>;

---

script_version

script_version: number;

Script data version stored with this object.

Implementation of

cse_alife_smart_zone.script_version

Inherited from

MockAlifeDynamicObject.script_version

---

section

section: string;

Inherited from

MockAlifeDynamicObject.section

---

set_available_loopholes

set_available_loopholes: Mock<UnknownFunction>;

---

shouldMoveOffline

shouldMoveOffline: boolean;

Inherited from

MockAlifeDynamicObject.shouldMoveOffline

---

spawn_ini

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

Returns

Spawn ini attached to this object, if any.

Implementation of

cse_alife_smart_zone.spawn_ini

Inherited from

MockAlifeDynamicObject.spawn_ini

---

spawnIni

spawnIni: ini_file | null;

Inherited from

MockAlifeDynamicObject.spawnIni

---

update

update: Mock<UnknownFunction>;

Run the server-side ALife update for this object.

Implementation of

cse_alife_smart_zone.update

Inherited from

MockAlifeDynamicObject.update

---

usesAiLocations

usesAiLocations: boolean;

Inherited from

MockAlifeDynamicObject.usesAiLocations