Class: cse_spectator

Server object binding for cse_spectator.

Source

C++ class cse_spectator : cse_abstract

Custom Constructor

cse_spectator

Extends

• cse_abstract

Constructors

Constructor

new cse_spectator(section: string): cse_spectator;

Create a server object for an object section.

Parameters

Parameter	Type	Description
section	string	Spawn section name.

Returns

cse_spectator

Inherited from

cse_abstract.constructor

Methods

clsid()

clsid(): TXR_class_id;

Returns

TXR_class_id

Engine class id.

Inherited from

cse_abstract.clsid

---

FillProps()

FillProps(pref: string, items: prop_item_vec): void;

Fill editor property rows for this object.

Parameters

Parameter	Type	Description
pref	string	Property prefix.
items	prop_item_vec	Property collection to populate.

Returns

void

Inherited from

cse_abstract.FillProps

---

init()

init(): void;

Initialize spectator server state.

Returns

void

---

name()

name<T>(): T;

Type Parameters

Type Parameter	Default type
T extends string	string

Returns

T

Runtime object name.

Inherited from

cse_abstract.name

---

section_name()

section_name<T>(): T;

Type Parameters

Type Parameter	Default type
T extends string	string

Returns

T

Spawn section name.

Inherited from

cse_abstract.section_name

---

spawn_ini()

spawn_ini(): Nullable<ini_file>;

Returns

Nullable<ini_file>

Spawn ini attached to this object, if any.

Inherited from

cse_abstract.spawn_ini

---

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.

Inherited from

cse_abstract.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

Inherited from

cse_abstract.STATE_Write

---

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.

Inherited from

cse_abstract.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

Inherited from

cse_abstract.UPDATE_Write

Properties

__name

readonly __name: string;

LuaBind instance constructor name.

Inherited from

cse_abstract.__name

---

angle

angle: vector;

Server-side orientation angles.

Inherited from

cse_abstract.angle

---

id

readonly id: number;

Server object id.

Inherited from

cse_abstract.id

---

parent_id

readonly parent_id: number;

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

Inherited from

cse_abstract.parent_id

---

position

position: vector;

Server-side world position.

Inherited from

cse_abstract.position

---

script_version

readonly script_version: number;

Script data version stored with this object.

Inherited from

cse_abstract.script_version

---

__name

readonly static __name: string;

LuaBind class constructor name.

Inherited from

cse_abstract.__name