summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavid Snopek <dsnopek@gmail.com>2023-03-19 12:41:25 -0700
committerRĂ©mi Verschelde <rverschelde@gmail.com>2023-05-12 12:31:22 +0200
commit2a8501e1a26b12dadd4f6fcbed799e319cd77027 (patch)
treed71c8943a2d350c5873359cd7a9aec0238b9fb0e /doc
parent07128ccb9d380dcaa090c1ea1c358af515fac20a (diff)
Add missing documentation for MultiplayerPeerExtension
(cherry picked from commit 4d13be3c5eab71b04f6d7a0ed9d7e8679b377494)
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/MultiplayerPeerExtension.xml20
1 files changed, 19 insertions, 1 deletions
diff --git a/doc/classes/MultiplayerPeerExtension.xml b/doc/classes/MultiplayerPeerExtension.xml
index 5717135b80..c7d46f136d 100644
--- a/doc/classes/MultiplayerPeerExtension.xml
+++ b/doc/classes/MultiplayerPeerExtension.xml
@@ -49,6 +49,18 @@
Called when a packet needs to be received by the [MultiplayerAPI], with [param r_buffer_size] being the size of the binary [param r_buffer] in bytes.
</description>
</method>
+ <method name="_get_packet_channel" qualifiers="virtual const">
+ <return type="int" />
+ <description>
+ Called to get the channel over which the next available packet was received. See [method MultiplayerPeer.get_packet_channel].
+ </description>
+ </method>
+ <method name="_get_packet_mode" qualifiers="virtual const">
+ <return type="int" enum="MultiplayerPeer.TransferMode" />
+ <description>
+ Called to get the [enum MultiplayerPeer.TransferMode] the remote peer used to send the next available packet. See [method MultiplayerPeer.get_packet_mode].
+ </description>
+ </method>
<method name="_get_packet_peer" qualifiers="virtual const">
<return type="int" />
<description>
@@ -76,7 +88,7 @@
<method name="_get_unique_id" qualifiers="virtual const">
<return type="int" />
<description>
- Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]).
+ Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). The value must be between [code]1[/code] and [code]2147483647[/code].
</description>
</method>
<method name="_is_refusing_new_connections" qualifiers="virtual const">
@@ -91,6 +103,12 @@
Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server].
</description>
</method>
+ <method name="_is_server_relay_supported" qualifiers="virtual const">
+ <return type="bool" />
+ <description>
+ Called to check if the server can act as a relay in the current configuration. See [method MultiplayerPeer.is_server_relay_supported].
+ </description>
+ </method>
<method name="_poll" qualifiers="virtual">
<return type="void" />
<description>