diff options
| author | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-07-27 12:06:48 +0200 |
|---|---|---|
| committer | Fabio Alessandrelli <fabio.alessandrelli@gmail.com> | 2021-07-30 17:29:50 +0200 |
| commit | 2cf39b97ae326a28015b67221b928e4861380d29 (patch) | |
| tree | 12d05483c198a7387768a6739fedbf143bd1ae0d /doc/classes | |
| parent | c27ef1565ff44eaacc081081b6b21b23665fbe10 (diff) | |
[Net] Implement RPC channels in MultiplayerAPI.
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/MultiplayerAPI.xml | 1 | ||||
| -rw-r--r-- | doc/classes/MultiplayerPeer.xml | 4 |
2 files changed, 5 insertions, 0 deletions
diff --git a/doc/classes/MultiplayerAPI.xml b/doc/classes/MultiplayerAPI.xml index 104f649921..552e0fce4c 100644 --- a/doc/classes/MultiplayerAPI.xml +++ b/doc/classes/MultiplayerAPI.xml @@ -61,6 +61,7 @@ <argument index="0" name="bytes" type="PackedByteArray" /> <argument index="1" name="id" type="int" default="0" /> <argument index="2" name="mode" type="int" enum="MultiplayerPeer.TransferMode" default="2" /> + <argument index="3" name="channel" type="int" default="0" /> <description> Sends the given raw [code]bytes[/code] to a specific peer identified by [code]id[/code] (see [method MultiplayerPeer.set_target_peer]). Default ID is [code]0[/code], i.e. broadcast to all peers. </description> diff --git a/doc/classes/MultiplayerPeer.xml b/doc/classes/MultiplayerPeer.xml index 88cd058c51..adaa359168 100644 --- a/doc/classes/MultiplayerPeer.xml +++ b/doc/classes/MultiplayerPeer.xml @@ -55,6 +55,10 @@ <member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" default="true"> If [code]true[/code], this [MultiplayerPeer] refuses new connections. </member> + <member name="transfer_channel" type="int" setter="set_transfer_channel" getter="get_transfer_channel" default="0"> + The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send [b]different and independent[/b] state updates is a common way to optimize network usage and decrease latency in fast-paced games. + [b]Note:[/b] The default channel ([code]0[/code]) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_UNRELIABLE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly. + </member> <member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="MultiplayerPeer.TransferMode" default="0"> The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode]. </member> |