RakNet

RakNet.add_send_hook

Registers a callback for observed outgoing RakNet packets.

Syntax

RakNet.add_send_hook(callback: (packet: RakNetPacket) -> ()): function
Aliase raknet.add_send_hook

Argumente

NameTypBeschreibung
callback(packet: RakNetPacket) -> ()Function called with each observed outgoing RakNetPacket.

Rückgaben

NameTypBeschreibung
callbackfunctionThe same callback function that was passed in.

Beschreibung

Registers a callback for observed outgoing 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.

Rufe es mit 1 Parameter(n) auf: callback. Die Argumenttabelle erklärt, welche Werte erforderlich sind und welche nur das Verhalten verfeinern.

Es gibt callback (function) zurück. Nutze die Rückgabetabelle, um erfolgreiche Werte von nil-Ergebnissen und behandelbaren Fehlern zu trennen.

Beispiel

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

if not raknet.is_enabled then
    return
end

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

raknet.add_send_hook(onSend)
task.wait(1)
raknet.remove_send_hook(onSend)

Typen

RakNetPacket

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

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