Class: reader
Binary reader used for save data and chunk payloads.
Source
C++ class reader
Custom Constructor
reader
Remarks
Reader methods advance a cursor over existing binary data. They do not own or mutate the source buffer. Reader values usually come from engine-owned chunks; scripts do not create them directly.
Constructors
Constructor
new reader(): reader;Returns
reader
Methods
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.
r_angle16()
r_angle16(): number;Read a 16-bit compressed angle.
Returns
number
Angle in radians.
r_angle8()
r_angle8(): number;Read an 8-bit compressed angle.
Returns
number
Angle in radians.
r_bool()
r_bool(): boolean;Read boolean value.
Returns
boolean
Boolean value.
r_dir()
r_dir(vector: vector): void;Read compressed direction vector.
Parameters
| Parameter | Type | Description |
|---|---|---|
vector | vector | Vector to fill. |
Returns
void
r_elapsed()
r_elapsed(): number;Get unread byte count.
Returns
number
Remaining bytes.
r_eof()
r_eof(): boolean;Check whether the reader cursor reached the end.
Returns
boolean
Whether reader is fully consumed.
r_float()
r_float<T>(value?: T): T;Read float value.
Type Parameters
| Type Parameter |
|---|
T extends number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Float value.
r_float_q16()
r_float_q16<T>(min: T, max: T): T;Read a 16-bit quantized float.
Type Parameters
| Type Parameter |
|---|
T extends number |
Parameters
| Parameter | Type | Description |
|---|---|---|
min | T | Minimum decoded value. |
max | T | Maximum decoded value. |
Returns
T
Decoded float.
r_float_q8()
r_float_q8<T>(min: T, max: T): T;Read an 8-bit quantized float.
Type Parameters
| Type Parameter |
|---|
T extends number |
Parameters
| Parameter | Type | Description |
|---|---|---|
min | T | Minimum decoded value. |
max | T | Maximum decoded value. |
Returns
T
Decoded float.
r_s16()
r_s16<T>(value?: T): T;Read signed 16-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Signed 16-bit integer.
r_s32()
r_s32<T>(value?: T): T;Read signed 32-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Signed 32-bit integer.
r_s64()
r_s64<T>(value?: T): T;Read signed 64-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Signed 64-bit integer.
r_s8()
r_s8<T>(value?: T): T;Read signed 8-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Signed 8-bit integer.
r_sdir()
r_sdir(vector: vector): void;Read signed compressed direction vector.
Parameters
| Parameter | Type | Description |
|---|---|---|
vector | vector | Vector to fill. |
Returns
void
r_seek()
r_seek(offset: number): void;Move read cursor to an absolute byte offset.
Parameters
| Parameter | Type | Description |
|---|---|---|
offset | number | Byte offset. |
Returns
void
Remarks
Offsets beyond the reader buffer fail native verification.
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.
r_tell()
r_tell(): number;Get current read cursor offset.
Returns
number
Byte offset.
r_u16()
r_u16<T>(value?: T): T;Read unsigned 16-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Unsigned 16-bit integer.
r_u32()
r_u32<T>(value?: T): T;Read unsigned 32-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Unsigned 32-bit integer.
r_u64()
r_u64<T>(value?: T): T;Read unsigned 64-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Unsigned 64-bit integer.
r_u8()
r_u8<T>(value?: T): T;Read unsigned 8-bit integer.
Type Parameters
| Type Parameter | Default type |
|---|---|
T extends number | number |
Parameters
| Parameter | Type | Description |
|---|---|---|
value? | T | Optional placeholder value. |
Returns
T
Unsigned 8-bit integer.
r_vec3()
r_vec3(vector: vector): void;Read 3D vector.
Parameters
| Parameter | Type | Description |
|---|---|---|
vector | vector | Vector to fill. |
Returns
void