Class: MockNetProcessor

X-Ray net processor mock for testing save/load of data.

Implements

• reader
• net_packet

Constructors

Constructor

new MockNetProcessor(dataList?: unknown[]): MockNetProcessor;

Parameters

Parameter	Type	Default value
dataList	unknown[]	[]

Returns

MockNetProcessor

Methods

asNetPacket()

asNetPacket(): net_packet;

Returns

net_packet

---

asNetProcessor()

asNetProcessor(): net_packet;

Returns

net_packet

---

asNetReader()

asNetReader(): reader;

Returns

reader

---

hasData()

hasData(): boolean;

Returns

boolean

---

r_advance()

r_advance(size: number): void;

Advance the read cursor.

Parameters

Parameter	Type	Description
size	number	Number of bytes to skip.

Returns

void

Remarks

Native code verifies that the new cursor stays inside the reader buffer.

Implementation of

reader.r_advance

---

r_angle16()

Call Signature

r_angle16(): number;

Read a 16-bit compressed angle.

Returns

number

Angle in radians.

Implementation of

reader.r_angle16

Call Signature

r_angle16(value: number): void;

Parameters

Parameter	Type
value	number

Returns

void

Implementation of

reader.r_angle16

---

r_angle8()

Call Signature

r_angle8(): number;

Read an 8-bit compressed angle.

Returns

number

Angle in radians.

Implementation of

reader.r_angle8

Call Signature

r_angle8(value: number): void;

Parameters

Parameter	Type
value	number

Returns

void

Implementation of

reader.r_angle8

---

r_begin()

r_begin(_type: number): number;

Read packet message header.

Parameters

Parameter	Type
_type	number

Returns

number

Packet receive time.

Remarks

Resets the read cursor to the packet start before reading the message type.

Implementation of

net_packet.r_begin

---

r_bool()

r_bool(): boolean;

Read boolean value.

Returns

boolean

Boolean value.

Implementation of

reader.r_bool

---

r_clientID()

r_clientID(): ClientID;

Read client id.

Returns

ClientID

Client id.

Implementation of

net_packet.r_clientID

---

r_dir()

r_dir(vector: vector): void;

Read compressed direction vector.

Parameters

Parameter	Type	Description
vector	vector	Vector to fill.

Returns

void

Implementation of

reader.r_dir

---

r_elapsed()

r_elapsed(): number;

Get unread byte count.

Returns

number

Remaining bytes.

Implementation of

reader.r_elapsed

---

r_eof()

r_eof(): boolean;

Check whether the reader cursor reached the end.

Returns

boolean

Whether reader is fully consumed.

Implementation of

reader.r_eof

---

r_float()

r_float<T>(_?: T | undefined): T;

Read float value.

Type Parameters

Type Parameter
T extends number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Float value.

Implementation of

reader.r_float

---

r_float_q16()

r_float_q16<T>(_: T, _max: T): T;

Read a 16-bit quantized float.

Type Parameters

Type Parameter
T extends number

Parameters

Parameter	Type
_	T
_max	T

Returns

T

Decoded float.

Implementation of

reader.r_float_q16

---

r_float_q8()

r_float_q8<T>(_: T, _max: T): T;

Read an 8-bit quantized float.

Type Parameters

Type Parameter
T extends number

Parameters

Parameter	Type
_	T
_max	T

Returns

T

Decoded float.

Implementation of

reader.r_float_q8

---

r_matrix()

r_matrix(matrix: matrix): matrix;

Read matrix data.

Parameters

Parameter	Type	Description
matrix	matrix	Matrix to fill.

Returns

matrix

Filled matrix.

Implementation of

net_packet.r_matrix

---

r_s16()

r_s16<T>(_?: T | undefined): T;

Read signed 16-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Signed 16-bit integer.

Implementation of

reader.r_s16

---

r_s32()

r_s32<T>(_?: T | undefined): T;

Read signed 32-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Signed 32-bit integer.

Implementation of

reader.r_s32

---

r_s64()

r_s64<T>(_?: T | undefined): T;

Read signed 64-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Signed 64-bit integer.

Implementation of

reader.r_s64

---

r_s8()

r_s8<T>(_?: T | undefined): T;

Read signed 8-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Signed 8-bit integer.

Implementation of

reader.r_s8

---

r_sdir()

r_sdir(vector: vector): void;

Read signed compressed direction vector.

Parameters

Parameter	Type	Description
vector	vector	Vector to fill.

Returns

void

Implementation of

reader.r_sdir

---

r_seek()

r_seek(_offset: number): void;

Move read cursor to an absolute byte offset.

Parameters

Parameter	Type
_offset	number

Returns

void

Remarks

Offsets beyond the reader buffer fail native verification.

Implementation of

reader.r_seek

---

r_stringZ()

r_stringZ<T>(): T;

Read zero-terminated string.

Type Parameters

Type Parameter	Default type
T extends string	string

Returns

T

String value.

Remarks

Advances past the trailing zero byte.

Implementation of

reader.r_stringZ

---

r_tell()

r_tell(): number;

Get current read cursor offset.

Returns

number

Byte offset.

Implementation of

reader.r_tell

---

r_u16()

r_u16<T>(_?: T | undefined): T;

Read unsigned 16-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Unsigned 16-bit integer.

Implementation of

reader.r_u16

---

r_u32()

r_u32<T>(_?: T | undefined): T;

Read unsigned 32-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Unsigned 32-bit integer.

Implementation of

reader.r_u32

---

r_u64()

r_u64<T>(_?: T | undefined): T;

Read unsigned 64-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Unsigned 64-bit integer.

Implementation of

reader.r_u64

---

r_u8()

r_u8<T>(_?: T | undefined): T;

Read unsigned 8-bit integer.

Type Parameters

Type Parameter	Default type
T extends number	number

Parameters

Parameter	Type	Default value
_	T | undefined	undefined

Returns

T

Unsigned 8-bit integer.

Implementation of

reader.r_u8

---

r_vec3()

r_vec3(vector: vector): void;

Read 3D vector.

Parameters

Parameter	Type	Description
vector	vector	Vector to fill.

Returns

void

Implementation of

reader.r_vec3

---

w_angle16()

w_angle16(value: number): void;

Write a 16-bit compressed angle.

Parameters

Parameter	Type	Description
value	number	Angle in radians.

Returns

void

Remarks

The engine normalizes the angle and stores it as a 16-bit quantized value over 0..2 * PI.

Implementation of

net_packet.w_angle16

---

w_angle8()

w_angle8(value: number): void;

Write an 8-bit compressed angle.

Parameters

Parameter	Type	Description
value	number	Angle in radians.

Returns

void

Remarks

The engine normalizes the angle and stores it as an 8-bit quantized value over 0..2 * PI.

Implementation of

net_packet.w_angle8

---

w_begin()

w_begin(type: number): void;

Start packet with message type.

Parameters

Parameter	Type	Description
type	number	Message type.

Returns

void

Remarks

Clears existing packet contents before writing the message type.

Implementation of

net_packet.w_begin

---

w_bool()

w_bool(data: boolean): void;

Write boolean value.

Parameters

Parameter	Type
data	boolean

Returns

void

Remarks

Booleans are serialized as one byte.

Implementation of

net_packet.w_bool

---

w_chunk_close16()

w_chunk_close16(_marker: number): void;

Close a 16-bit size-prefixed chunk.

Parameters

Parameter	Type
_marker	number

Returns

void

Remarks

The chunk payload must fit into 65535 bytes.

Implementation of

net_packet.w_chunk_close16

---

w_chunk_close8()

w_chunk_close8(_marker: number): void;

Close an 8-bit size-prefixed chunk.

Parameters

Parameter	Type
_marker	number

Returns

void

Remarks

The chunk payload must fit into 255 bytes.

Implementation of

net_packet.w_chunk_close8

---

w_chunk_open16()

w_chunk_open16(_marker: number): void;

Open a 16-bit size-prefixed chunk.

Parameters

Parameter	Type
_marker	number

Returns

void

Remarks

Writes a placeholder size at the current write cursor. Pass the returned marker to w_chunk_close16.

Implementation of

net_packet.w_chunk_open16

---

w_chunk_open8()

w_chunk_open8(_marker: number): void;

Open an 8-bit size-prefixed chunk.

Parameters

Parameter	Type
_marker	number

Returns

void

Remarks

Writes a placeholder size at the current write cursor. Pass the returned marker to w_chunk_close8.

Implementation of

net_packet.w_chunk_open8

---

w_clientID()

w_clientID(clientId: ClientID): void;

Write client id.

Parameters

Parameter	Type
clientId	ClientID

Returns

void

Implementation of

net_packet.w_clientID

---

w_dir()

w_dir(vector: vector): void;

Write compressed direction vector.

Parameters

Parameter	Type	Description
vector	vector	Direction vector.

Returns

void

Implementation of

net_packet.w_dir

---

w_float()

w_float(data: number): void;

Write float value.

Parameters

Parameter	Type
data	number

Returns

void

Implementation of

net_packet.w_float

---

w_float_q16()

w_float_q16(
   value: number, 
   _min: number, 
   _max: number): void;

Write a 16-bit quantized float.

Parameters

Parameter	Type	Description
value	number	Value to write.
_min	number	-
_max	number	-

Returns

void

Remarks

Native code verifies that value is inside [min, max].

Implementation of

net_packet.w_float_q16

---

w_float_q8()

w_float_q8(
   value: number, 
   _min: number, 
   _max: number): void;

Write an 8-bit quantized float.

Parameters

Parameter	Type	Description
value	number	Value to write.
_min	number	-
_max	number	-

Returns

void

Remarks

Native code verifies that value is inside [min, max].

Implementation of

net_packet.w_float_q8

---

w_matrix()

w_matrix(matrix: matrix): void;

Write matrix data.

Parameters

Parameter	Type	Description
matrix	matrix	Matrix to write.

Returns

void

Implementation of

net_packet.w_matrix

---

w_s16()

w_s16(value: number): void;

Write signed 16-bit integer.

Parameters

Parameter	Type	Description
value	number	Signed 16-bit integer.

Returns

void

Implementation of

net_packet.w_s16

---

w_s32()

w_s32(data: number): void;

Write signed 32-bit integer.

Parameters

Parameter	Type
data	number

Returns

void

Implementation of

net_packet.w_s32

---

w_s64()

w_s64(value: number): void;

Write signed 64-bit integer.

Parameters

Parameter	Type	Description
value	number	Signed 64-bit integer.

Returns

void

Implementation of

net_packet.w_s64

---

w_sdir()

w_sdir(vector: vector): void;

Write signed compressed direction vector.

Parameters

Parameter	Type	Description
vector	vector	Direction vector.

Returns

void

Implementation of

net_packet.w_sdir

---

w_stringZ()

w_stringZ(data: string): void;

Write zero-terminated string.

Parameters

Parameter	Type
data	string

Returns

void

Remarks

The binding writes the string bytes followed by \0.

Implementation of

net_packet.w_stringZ

---

w_tell()

w_tell(): number;

Get current write cursor offset.

Returns

number

Byte offset.

Implementation of

net_packet.w_tell

---

w_u16()

w_u16(data: number): void;

Write unsigned 16-bit integer.

Parameters

Parameter	Type
data	number

Returns

void

Implementation of

net_packet.w_u16

---

w_u32()

w_u32(data: number): void;

Write unsigned 32-bit integer.

Parameters

Parameter	Type
data	number

Returns

void

Implementation of

net_packet.w_u32

---

w_u64()

w_u64(value: number): void;

Write unsigned 64-bit integer.

Parameters

Parameter	Type	Description
value	number	Unsigned 64-bit integer.

Returns

void

Implementation of

net_packet.w_u64

---

w_u8()

w_u8(data: number): void;

Write unsigned 8-bit integer.

Parameters

Parameter	Type
data	number

Returns

void

Implementation of

net_packet.w_u8

---

w_vec3()

w_vec3(vector: vector): void;

Write 3D vector.

Parameters

Parameter	Type	Description
vector	vector	Vector to write.

Returns

void

Implementation of

net_packet.w_vec3

---

create()

static create(dataList?: unknown[]): MockNetProcessor;

Parameters

Parameter	Type	Default value
dataList	unknown[]	[]

Returns

MockNetProcessor

---

mock()

static mock(): TXR_net_processor;

Returns

TXR_net_processor

---

mockNetPacket()

static mockNetPacket(): net_packet;

Returns

net_packet

---

mockReader()

static mockReader(): reader;

Returns

reader

Properties

dataList

dataList: unknown[];

---

readDataOrder

readDataOrder: EMockPacketDataType[] = [];

---

writeDataOrder

writeDataOrder: EMockPacketDataType[] = [];