Skip to content

Class: CEntityAlive ​

Runtime family wrapper for alive entities returned by game_object.cast_EntityAlive().

Source ​

src/xrGame/script_game_object_script3.cpp, cast_EntityAlive binding.

Custom Constructor ​

CEntityAlive

Remarks ​

This is a cast target, not a directly registered script constructor. Use game_object.is_entity_alive() or a narrower predicate before calling alive-object methods from the shared game_object surface.

Extends ​

Constructors ​

Constructor ​

ts
protected new CEntityAlive(): CEntityAlive;

Cast-only runtime wrapper.

Returns ​

CEntityAlive

Overrides ​

CGameObject.constructor

Methods ​

_construct() ​

ts
_construct(): DLL_Pure;

Construct engine-side object state.

Returns ​

DLL_Pure

Constructed base object.

Remarks ​

Lifecycle hook used by the engine. Calling it from gameplay scripts can reinitialize native state unexpectedly.

Inherited from ​

CGameObject._construct


getEnabled() ​

ts
getEnabled(): boolean;

Returns ​

boolean

Whether the object is enabled in the client object loop.

Inherited from ​

CGameObject.getEnabled


getVisible() ​

ts
getVisible(): boolean;

Returns ​

boolean

Whether the object is visible.

Inherited from ​

CGameObject.getVisible


net_Export() ​

ts
net_Export(net_packet: net_packet): void;

Export network state to a packet.

Parameters ​

ParameterTypeDescription
net_packetnet_packetDestination network packet.

Returns ​

void

Inherited from ​

CGameObject.net_Export


net_Import() ​

ts
net_Import(net_packet: net_packet): void;

Import network state from a packet.

Parameters ​

ParameterTypeDescription
net_packetnet_packetSource network packet.

Returns ​

void

Inherited from ​

CGameObject.net_Import


net_Spawn() ​

ts
net_Spawn(cse_abstract: cse_abstract): boolean;

Spawn the client object from its server object.

Parameters ​

ParameterTypeDescription
cse_abstractcse_abstractServer object used for spawn data.

Returns ​

boolean

Whether spawn succeeded.

Remarks ​

Lifecycle hook used during network spawn. Return false to reject spawn in custom subclasses.

Inherited from ​

CGameObject.net_Spawn


use() ​

ts
use(object: CGameObject): boolean;

Use another object through the engine interaction path.

Parameters ​

ParameterTypeDescription
objectCGameObjectObject being used.

Returns ​

boolean

Whether the use action was handled.

Inherited from ​

CGameObject.use


Visual() ​

ts
Visual(): IXR_IRender_Visual;

Returns ​

IXR_IRender_Visual

Render visual assigned to the object.

Inherited from ​

CGameObject.Visual

Properties ​

__name ​

ts
readonly __name: string;

LuaBind instance constructor name.

Inherited from ​

CGameObject.__name


__name ​

ts
readonly static __name: string;

LuaBind class constructor name.

Inherited from ​

CGameObject.__name