Difference between revisions of "enet.host:broadcast"

(Created page with "Queues a packet to be sent to all connected peers. == Function == === Synopsis === <source lang="lua"> host:broadcast(data, channel, flag) </source> === Arguments...")
 
(Added variant added in love 12)
 
(4 intermediate revisions by 2 users not shown)
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 ===
 +
Nothing.
 +
 
 +
== Function ==
 +
{{newin|[[12.0]]|120|type=variant}}
 +
=== Synopsis ===
 +
<source lang="lua">
 +
host:send(pointer, size, channel, flag)
 +
</source>
 +
=== Arguments ===
 +
{{param|light userdata|pointer|The data of the packet to send to all clients.}}
 +
{{param|number|size|The size of the memory starting at the pointer.}}
 +
{{param|number|channel|The channel to send the packet on. Optional. 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. 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 ===
None
+
Nothing.
  
 
== See Also ==
 
== See Also ==
 
* [[parent::lua-enet]]
 
* [[parent::lua-enet]]
 
* [[enet.peer]]
 
* [[enet.peer]]
 +
* [[enet.peer:send]]
 
== Other Languages ==
 
== Other Languages ==
{{i18n|enet.host:connect}}
+
{{i18n|enet.host:broadcast}}

Latest revision as of 17:57, 9 May 2023

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.

Function

Available since LÖVE 12.0
This variant is not supported in earlier versions.

Synopsis

host:send(pointer, size, channel, flag)

Arguments

light userdata pointer
The data of the packet to send to all clients.
number size
The size of the memory starting at the pointer.
number channel
The channel to send the packet on. Optional. 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