raknet.receive Synchronous

RakNet.Receive
RakNet.receive
raknet.Receive

Defaults 2, 3, 0; table input supplies its own fields.

Syntax

Luau

raknet.receive(
    data: PacketData | PacketOptions | RakNetPacket,
    priority: number?,
    reliability: number?,
    channel: number?
) -> ()

Parameters

Function parameters
Parameter	Type
`data`	`PacketData \| PacketOptions \| RakNetPacket`
`priority`	`number?`
`reliability`	`number?`
`channel`	`number?`

Argument fields

PacketData fields

Luau

PacketData = string | buffer | {number}

PacketOptions fields

Luau

PacketOptions = {
  Data: PacketData, Priority: number?, Reliability: number?, OrderingChannel: number?,
  SystemIdentifier: (string | number)?, Broadcast: boolean?, ForceReceiptNumber: number?
}

RakNetPacket fields

Luau

RakNetPacket = {
  Data: buffer, AsArray: {number}, AsBuffer: buffer, AsString: string,
  Size: number, PacketId: number, ID: number, Id: number, PacketID: number, Priority: number,
  Reliability: number, OrderingChannel: number,
  SystemIdentifier: string, Broadcast: boolean, ForceReceiptNumber: number
}

Returns

()

This function returns no values.

Availability

RakNet is disabled by default. RakNet and raknet are removed when the setting is off; retained references can still call is_enabled().