Syntax
RakNet.OnPacketSend.Connect(callback: (packet: RakNetPacket) -> ()): RakNetSignalConnectionAliases
raknet.OnPacketSend.ConnectArguments
| Name | Type | Description |
|---|---|---|
callback | (packet: RakNetPacket) -> () | Function called with each observed outgoing RakNetPacket. |
Returns
| Name | Type | Description |
|---|---|---|
connection | RakNetSignalConnection | Connection object with Disconnect and Connected. |
Description
Connects a callback to the OnPacketSend signal table and returns a RakNetSignalConnection. The callback receives a RakNetPacket while the packet is valid.
Call it with 1 parameter(s): callback. The argument table explains which values are required and which ones only refine the behavior.
It returns connection (RakNetSignalConnection). Use the returns table to separate successful values from nil results and recoverable errors.
Example
Use the signal-style API to observe outgoing packets and disconnect the returned connection.
if not RakNet.is_enabled then
return
end
local connection = RakNet.OnPacketSend:Connect(function(packet)
print(packet.ID, packet.Size)
end)
task.wait(1)
connection:Disconnect()Types
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.RakNetSignalConnection
Connection object returned by RakNet.OnPacketSend.Connect and RakNet.OnPacketReceive.Connect.
Disconnect () -> () Removes the connection from the packet signal.Connected boolean true while the connection still exists for the current RakNet hook generation.