RakNet.add_receive_hook

Registers a callback for observed incoming RakNet packets. The callback receives one RakNetPacket while the packet is valid. Registering the same closure again replaces its stored reference. The function returns the callback it was given.

Syntax

RakNet.add_receive_hook(callback: (packet: RakNetPacket) -> ()): function

Aliases

raknet.add_receive_hook

Arguments

Name	Type	Required	Description
`callback`	`(packet: RakNetPacket) -> ()`	Yes	Function called with each observed incoming RakNetPacket.

Returns

Name	Type	Description
`callback`	`function`	The same callback function that was passed in.

Types

RakNetPacket

Live packet object passed to RakNet hooks and packet signal callbacks. It is only valid during the callback that receives it.

Name	Type	Required	Description
`SetData`	`(data: string \| buffer \| {number}) -> ()`	Yes	Replaces packet bytes and updates the packet id from the first byte, or 0 for empty data.
`Block`	`() -> ()`	Yes	Marks the packet as blocked.
`Ignore`	`() -> ()`	Yes	Alias that resolves to Block.
`AsString`	`string`	Yes	Packet bytes as a Lua string.
`AsArray`	`{number}`	Yes	Packet bytes as a 1-based array of numbers.
`AsBuffer`	`buffer`	Yes	Packet bytes as a buffer.
`Data`	`buffer`	Yes	Packet bytes as a buffer.
`ID`	`number`	Yes	Packet id value. PacketId, PacketID, and Id resolve to the same value.
`Priority`	`number`	Yes	Packet priority value.
`Reliability`	`number`	Yes	Packet reliability value.
`OrderingChannel`	`number`	Yes	Packet ordering channel value.
`SystemIdentifier`	`string`	Yes	Packet system identifier as decimal string.
`Broadcast`	`boolean`	Yes	Packet broadcast flag.
`ForceReceiptNumber`	`number`	Yes	Packet receipt number.
`Size`	`number`	Yes	Number of bytes in the packet data.

Example

Observe incoming packets with a callback and remove the same callback later.

if not raknet.is_enabled then
    return
end

local function onReceive(packet)
    print(packet.ID, packet.Size)
end

raknet.add_receive_hook(onReceive)
task.wait(1)
raknet.remove_receive_hook(onReceive)

⌘I

Overview

Cache

Cryptography

Filesystem

JSON

Console

Drawing

ImGui

Input

Instances

Reflection

Scripts

Signals

WebSocket

Actors

Closures

Debug

Environment

Metatables

Threads

Disassembler

Miscellaneous

RakNet

RealSignal

SaveInstance

Syntax

Aliases

Arguments

Returns

Types

RakNetPacket

Example

​Syntax

​Aliases

​Arguments

​Returns

​Types

​RakNetPacket

​Example

Syntax

Aliases

Arguments

Returns

Types

RakNetPacket

Example