Class: MockServerAlifeCreatureAbstract

Mock server creature object.

Extends

• MockAlifeDynamicObjectVisual

Extended by

• MockAlifeMonsterBase
• MockAlifeCreatureActor
• MockAlifeHumanStalker

Implements

• cse_alife_creature_abstract

Accessors

__name

Get Signature

get __name(): string;

Returns

string

Implementation of

cse_alife_creature_abstract.__name

Inherited from

MockAlifeDynamicObjectVisual.__name

---

__name

Get Signature

get static __name(): string;

Returns

string

Inherited from

MockAlifeDynamicObjectVisual.__name

Constructors

Constructor

new MockServerAlifeCreatureAbstract(config: IMockAlifeObjectConfig): MockServerAlifeCreatureAbstract;

Parameters

Parameter	Type
config	IMockAlifeObjectConfig

Returns

MockServerAlifeCreatureAbstract

Overrides

MockAlifeDynamicObjectVisual.constructor

Methods

can_save()

can_save(): boolean;

Returns

boolean

Whether this object should be saved.

Implementation of

cse_alife_creature_abstract.can_save

Inherited from

MockAlifeDynamicObjectVisual.can_save

---

can_switch_offline()

Call Signature

can_switch_offline(): boolean;

Returns

boolean

Whether this object may switch offline.

Implementation of

cse_alife_creature_abstract.can_switch_offline

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.can_switch_offline

Inherited from

MockAlifeDynamicObjectVisual.can_switch_offline

---

can_switch_online()

Call Signature

can_switch_online(): boolean;

Returns

boolean

Whether this object may switch online.

Implementation of

cse_alife_creature_abstract.can_switch_online

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.can_switch_online

Inherited from

MockAlifeDynamicObjectVisual.can_switch_online

---

clsid()

clsid(): TXR_class_id;

Returns

TXR_class_id

Engine class id.

Implementation of

cse_alife_creature_abstract.clsid

Inherited from

MockAlifeDynamicObjectVisual.clsid

---

current_level_travel_speed()

Call Signature

current_level_travel_speed(): number;

Returns

number

Travel speed used inside the current level.

Implementation of

cse_alife_creature_abstract.current_level_travel_speed

Call Signature

current_level_travel_speed(value: number): void;

Set travel speed used inside the current level.

Parameters

Parameter	Type	Description
value	number	New travel speed.

Returns

void

Implementation of

cse_alife_creature_abstract.current_level_travel_speed

---

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

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.init

Inherited from

MockAlifeDynamicObjectVisual.init

---

interactive()

interactive(): boolean;

Returns

boolean

Whether the object is interactive.

Implementation of

cse_alife_creature_abstract.interactive

Inherited from

MockAlifeDynamicObjectVisual.interactive

---

keep_saved_data_anyway()

keep_saved_data_anyway(): boolean;

Returns

boolean

Implementation of

cse_alife_creature_abstract.keep_saved_data_anyway

Inherited from

MockAlifeDynamicObjectVisual.keep_saved_data_anyway

---

kill()

kill(): void;

Kill the server-side creature.

Returns

void

Remarks

Intended for creature server objects managed by ALife.

Implementation of

cse_alife_creature_abstract.kill

---

move_offline()

Call Signature

move_offline(): boolean;

Returns

boolean

Whether the object should move while offline.

Implementation of

cse_alife_creature_abstract.move_offline

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.move_offline

Inherited from

MockAlifeDynamicObjectVisual.move_offline

---

name()

name<T>(): T;

Type Parameters

Type Parameter
T extends string

Returns

T

Runtime object name.

Implementation of

cse_alife_creature_abstract.name

Inherited from

MockAlifeDynamicObjectVisual.name

---

on_before_register()

on_before_register(): void;

Returns

void

Implementation of

cse_alife_creature_abstract.on_before_register

Inherited from

MockAlifeDynamicObjectVisual.on_before_register

---

on_death()

on_death(_killer?: cse_alife_object): void;

Notify the server object that this creature died.

Parameters

Parameter	Type
_killer?	cse_alife_object

Returns

void

Remarks

Marks server-side health as dead and records death time. It is not a general damage method.

Implementation of

cse_alife_creature_abstract.on_death

---

on_register()

on_register(): void;

Returns

void

Implementation of

cse_alife_creature_abstract.on_register

Inherited from

MockAlifeDynamicObjectVisual.on_register

---

on_spawn()

on_spawn(): void;

Returns

void

Implementation of

cse_alife_creature_abstract.on_spawn

Inherited from

MockAlifeDynamicObjectVisual.on_spawn

---

on_unregister()

on_unregister(): void;

Returns

void

Implementation of

cse_alife_creature_abstract.on_unregister

Inherited from

MockAlifeDynamicObjectVisual.on_unregister

---

section_name()

section_name<T>(): T;

Type Parameters

Type Parameter
T extends string

Returns

T

Spawn section name.

Implementation of

cse_alife_creature_abstract.section_name

Inherited from

MockAlifeDynamicObjectVisual.section_name

---

set_yaw()

set_yaw(yaw: number): void;

Set object yaw.

Parameters

Parameter	Type	Description
yaw	number	Yaw angle.

Returns

void

Implementation of

cse_alife_creature_abstract.set_yaw

Inherited from

MockAlifeDynamicObjectVisual.set_yaw

---

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

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.STATE_Write

Inherited from

MockAlifeDynamicObjectVisual.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_alife_creature_abstract.switch_offline

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.switch_online

Inherited from

MockAlifeDynamicObjectVisual.switch_online

---

travel_speed()

Call Signature

travel_speed(): number;

Returns

number

Travel speed used for graph movement.

Implementation of

cse_alife_creature_abstract.travel_speed

Call Signature

travel_speed(value: number): void;

Set travel speed used for graph movement.

Parameters

Parameter	Type	Description
value	number	New travel speed.

Returns

void

Implementation of

cse_alife_creature_abstract.travel_speed

---

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

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.UPDATE_Write

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.use_ai_locations

Inherited from

MockAlifeDynamicObjectVisual.use_ai_locations

---

used_ai_locations()

used_ai_locations(): boolean;

Returns

boolean

Whether the object uses AI location graph data.

Implementation of

cse_alife_creature_abstract.used_ai_locations

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.visible_for_map

Inherited from

MockAlifeDynamicObjectVisual.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_creature_abstract.visible_for_map

Inherited from

MockAlifeDynamicObjectVisual.visible_for_map

---

create()

static create(config?: IMockAlifeObjectConfig): MockServerAlifeCreatureAbstract;

Parameters

Parameter	Type
config	IMockAlifeObjectConfig

Returns

MockServerAlifeCreatureAbstract

Overrides

MockAlifeDynamicObjectVisual.create

---

mock()

static mock(config?: IMockAlifeObjectConfig): cse_alife_creature_abstract;

Parameters

Parameter	Type
config	IMockAlifeObjectConfig

Returns

cse_alife_creature_abstract

Overrides

MockAlifeDynamicObjectVisual.mock

---

mockWithClassId()

static mockWithClassId(classId: number): cse_alife_object;

Parameters

Parameter	Type
classId	number

Returns

cse_alife_object

Inherited from

MockAlifeDynamicObjectVisual.mockWithClassId

---

toMock()

static toMock(object: cse_alife_object): MockAlifeObject;

Parameters

Parameter	Type
object	cse_alife_object

Returns

MockAlifeObject

Inherited from

MockAlifeDynamicObjectVisual.toMock

Properties

aiBrain

aiBrain: CALifeMonsterBrain;

---

alive

alive: Mock<() => boolean>;

Implementation of

cse_alife_creature_abstract.alive

Inherited from

MockAlifeDynamicObjectVisual.alive

---

angle

angle: vector;

Server-side orientation angles.

Implementation of

cse_alife_creature_abstract.angle

Inherited from

MockAlifeDynamicObjectVisual.angle

---

brain

brain: Mock<() => CALifeMonsterBrain>;

Throws

If this creature type has no ALife monster brain.

Returns

ALife brain that drives offline monster behavior.

Implementation of

cse_alife_creature_abstract.brain

---

canSave

canSave: boolean;

Inherited from

MockAlifeDynamicObjectVisual.canSave

---

canSwitchOffline

canSwitchOffline: boolean;

Inherited from

MockAlifeDynamicObjectVisual.canSwitchOffline

---

canSwitchOnline

canSwitchOnline: boolean;

Inherited from

MockAlifeDynamicObjectVisual.canSwitchOnline

---

classId

classId: TXR_class_id;

Inherited from

MockAlifeDynamicObjectVisual.classId

---

clear_smart_terrain

clear_smart_terrain: Mock<UnknownFunction>;

Implementation of

cse_alife_creature_abstract.clear_smart_terrain

Inherited from

MockAlifeDynamicObjectVisual.clear_smart_terrain

---

community

community: <T>() => T;

Type Parameters

Type Parameter	Default type
T extends string	string

Returns

T

Implementation of

cse_alife_creature_abstract.community

Inherited from

MockAlifeDynamicObjectVisual.community

---

force_set_goodwill

force_set_goodwill: Mock<UnknownFunction>;

Set goodwill from this creature toward another object.

Remarks

npc_id must resolve to an ALife object that can store personal goodwill.

Param

goodwill

New goodwill value.

Param

npc_id

Target object id.

Implementation of

cse_alife_creature_abstract.force_set_goodwill

---

g_group

g_group: Mock<() => number>;

Returns

Game group id.

Implementation of

cse_alife_creature_abstract.g_group

---

g_squad

g_squad: Mock<() => number>;

Returns

Game squad id.

Implementation of

cse_alife_creature_abstract.g_squad

---

g_team

g_team: Mock<() => number>;

Returns

Game team id.

Implementation of

cse_alife_creature_abstract.g_team

---

group

group: number;

Game group id.

Implementation of

cse_alife_creature_abstract.group

---

group_id

group_id: number;

Object squad id, maximal u16 (65535) if no squad assigned.

Implementation of

cse_alife_creature_abstract.group_id

---

has_detector

has_detector: Mock<() => boolean>;

Returns

Whether the creature has a detector.

Implementation of

cse_alife_creature_abstract.has_detector

---

health

health: Mock<() => number>;

Returns

Current creature health.

Implementation of

cse_alife_creature_abstract.health

---

id

id: number;

Server object id.

Implementation of

cse_alife_creature_abstract.id

Inherited from

MockAlifeDynamicObjectVisual.id

---

isInteractive

isInteractive: boolean;

Inherited from

MockAlifeDynamicObjectVisual.isInteractive

---

isVisibleForMap

isVisibleForMap: boolean;

Inherited from

MockAlifeDynamicObjectVisual.isVisibleForMap

---

m_game_vertex_id

m_game_vertex_id: number;

Game graph vertex used by ALife simulation.

Implementation of

cse_alife_creature_abstract.m_game_vertex_id

Inherited from

MockAlifeDynamicObjectVisual.m_game_vertex_id

---

m_level_vertex_id

m_level_vertex_id: number;

Level graph vertex used by ALife simulation.

Implementation of

cse_alife_creature_abstract.m_level_vertex_id

Inherited from

MockAlifeDynamicObjectVisual.m_level_vertex_id

---

m_smart_terrain_id

m_smart_terrain_id: number;

Assigned smart terrain id, or 65535 when none is assigned.

Implementation of

cse_alife_creature_abstract.m_smart_terrain_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_creature_abstract.m_story_id

Inherited from

MockAlifeDynamicObjectVisual.m_story_id

---

o_torso

o_torso: Mock<() => rotation>;

Returns

Torso rotation state.

Implementation of

cse_alife_creature_abstract.o_torso

---

objectAlive

objectAlive: boolean;

Inherited from

MockAlifeDynamicObjectVisual.objectAlive

---

objectCommunity

objectCommunity: string;

Inherited from

MockAlifeDynamicObjectVisual.objectCommunity

---

objectCurrentLevelTravelSpeed

objectCurrentLevelTravelSpeed: number;

---

objectHasDetector

objectHasDetector: boolean;

---

objectHealth

objectHealth: number;

---

objectName

objectName: string;

Inherited from

MockAlifeDynamicObjectVisual.objectName

---

objectRank

objectRank: number;

---

objectTravelSpeed

objectTravelSpeed: number;

---

online

online: boolean;

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

Implementation of

cse_alife_creature_abstract.online

Inherited from

MockAlifeDynamicObjectVisual.online

---

parent_id

parent_id: number;

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

Implementation of

cse_alife_creature_abstract.parent_id

Inherited from

MockAlifeDynamicObjectVisual.parent_id

---

position

position: vector;

Server-side world position.

Implementation of

cse_alife_creature_abstract.position

Inherited from

MockAlifeDynamicObjectVisual.position

---

rank

rank: Mock<() => number>;

Returns

Creature rank.

Implementation of

cse_alife_creature_abstract.rank

---

script_version

script_version: number;

Script data version stored with this object.

Implementation of

cse_alife_creature_abstract.script_version

Inherited from

MockAlifeDynamicObjectVisual.script_version

---

section

section: string;

Inherited from

MockAlifeDynamicObjectVisual.section

---

shouldMoveOffline

shouldMoveOffline: boolean;

Inherited from

MockAlifeDynamicObjectVisual.shouldMoveOffline

---

smart_terrain_id

smart_terrain_id: Mock<() => number>;

Returns

Assigned smart terrain id, or 65535 when none is assigned.

Implementation of

cse_alife_creature_abstract.smart_terrain_id

---

smart_terrain_task_activate

smart_terrain_task_activate: Mock<UnknownFunction>;

Works for CSE_ALifeMonsterAbstract, marks smart terrain as reached and switches logic to terrain task.

Remarks

Only meaningful for monsters assigned to a smart terrain task.

Implementation of

cse_alife_creature_abstract.smart_terrain_task_activate

---

smart_terrain_task_deactivate

smart_terrain_task_deactivate: Mock<UnknownFunction>;

Mark the current smart terrain task as not reached.

Implementation of

cse_alife_creature_abstract.smart_terrain_task_deactivate

---

spawn_ini

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

Returns

Spawn ini attached to this object, if any.

Implementation of

cse_alife_creature_abstract.spawn_ini

Inherited from

MockAlifeDynamicObjectVisual.spawn_ini

---

spawnIni

spawnIni: ini_file | null;

Inherited from

MockAlifeDynamicObjectVisual.spawnIni

---

squad

squad: number;

Squad identifier that links squad and parent smart terrain.

Implementation of

cse_alife_creature_abstract.squad

---

team

team: number;

Team (community) of the object. Defined in game_relations.ltx -> [game_relations] -> [communities].

Example: 8 is monster, 9 is stalker, 0 is actor, 4 is freedom.

Implementation of

cse_alife_creature_abstract.team

---

torso

torso: rotation;

---

update

update: Mock<UnknownFunction>;

Run the server-side ALife update for this object.

Implementation of

cse_alife_creature_abstract.update

Inherited from

MockAlifeDynamicObjectVisual.update

---

usesAiLocations

usesAiLocations: boolean;

Inherited from

MockAlifeDynamicObjectVisual.usesAiLocations