xhookLua
Game

NetMessage

Sequential reader over one usermsg, valid only inside on_net_message.

Methods

msg:name

msg:name() -> string

Message name, like "DeathMsg".

msg:read_char

msg:read_char() -> integer

Reads 1 signed byte.

Returns -128 to 127

msg:read_byte

msg:read_byte() -> integer

Reads 1 unsigned byte.

Returns 0 to 255

msg:read_short

msg:read_short() -> integer

Reads a signed 2-byte value.

Returns -32768 to 32767

msg:read_word

msg:read_word() -> integer

Reads an unsigned 2-byte value.

Returns 0 to 65535

msg:read_long

msg:read_long() -> integer

Reads a signed 4-byte integer.

msg:read_float

msg:read_float() -> number

Reads a 4-byte IEEE float.

msg:read_coord

msg:read_coord() -> number

Reads a 16-bit coordinate (short / 8).

Returns World units

msg:read_angle

msg:read_angle() -> number

Reads a 1-byte angle (value * 360 / 256).

Returns Degrees, about -180 to 178.6

msg:read_string

msg:read_string() -> string

Reads a NUL-terminated string, up to 2047 characters.

Returns "" when empty or past end

msg:eof

msg:eof() -> boolean

True once every byte is read.

Fields

NameTypeDescription
overruninfoReads past the end return junk, never raise.
lifetimeinfoStored readers raise after on_net_message returns.
NetMessage ยท Lua API ยท xhook