Real Documentation

Syntax

RakNetPacket.Block(packet: RakNetPacket)

Aliases RakNetPacket.Ignore

Arguments

Name	Type	Description
`packet`	`RakNetPacket`	Live packet object passed to a RakNet hook or signal callback.

Description

Marks a live RakNetPacket as blocked. Ignore resolves to the same method. The method returns no values.

Call it with 1 parameter(s): packet. The argument table explains which values are required and which ones only refine the behavior.

It does not return data. Treat the call as an action and handle errors around the call site when needed.

Example

Mark a live packet as blocked from inside a packet callback.

if RakNet.is_enabled then
    RakNet.OnPacketSend:Connect(function(packet)
        if packet.ID == 0 then
            packet:Block()
        end
    end)
end

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.