Difference between revisions of "enet.host:broadcast"

m (Returns: stylistic edit.)
m (Arguments: carbon copied my better explanation over from peer:send for consistency's sake.)
Line 8: Line 8:
 
{{param|string|data|The data to send.}}
 
{{param|string|data|The data to send.}}
 
{{param|number|channel|The channel to send the packet on. Defaults to 0.}}
 
{{param|number|channel|The channel to send the packet on. Defaults to 0.}}
{{param|string|flag|Flag is one of "reliable", "unsequenced", or "unreliable". Reliable packets are guaranteed to arrive, and arrive in the order in which they are sent. Unsequenced packets are unreliable and have no guarantee on the order they arrive. Defaults to reliable.}}
+
{{param|string|flag|flag is one of "reliable", "unsequenced", or "unreliable". Reliable packets are guaranteed to arrive, and arrive in the order in which they are sent. Unreliable packets arrive in the order in which they are sent, but they aren't guaranteed to arrive. Unsequenced packets are neither guaranteed to arrive, nor do they have any guarantee on the order they arrive. Optional. Defaults to reliable.}}
 +
 
 
=== Returns ===
 
=== Returns ===
 
Nothing
 
Nothing

Revision as of 02:19, 30 October 2016

Queues a packet to be sent to all connected peers.

Function

Synopsis

host:broadcast(data, channel, flag)

Arguments

string data
The data to send.
number channel
The channel to send the packet on. Defaults to 0.
string flag
flag is one of "reliable", "unsequenced", or "unreliable". Reliable packets are guaranteed to arrive, and arrive in the order in which they are sent. Unreliable packets arrive in the order in which they are sent, but they aren't guaranteed to arrive. Unsequenced packets are neither guaranteed to arrive, nor do they have any guarantee on the order they arrive. Optional. Defaults to reliable.

Returns

Nothing

See Also

Other Languages