maxmustermann/godot
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[Net/Docs] Update extensions documentation.

Browse source
This commit is contained in:
Fabio Alessandrelli 2021-09-08 01:50:22 +02:00
parent ead6d10715
commit 2d810e8cd9
14 changed files with 361 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/MultiplayerPeer.xml
View file

@ -52,14 +52,14 @@
</method>
</methods>
<members>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" default="true">
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" default="false">
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_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="TransferMode" default="0">
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" enum="TransferMode" default="2">
The manner in which to send packets to the [code]target_peer[/code]. See [enum TransferMode].
</member>
</members>

99
doc/classes/MultiplayerPeerExtension.xml Normal file
View file

@ -0,0 +1,99 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MultiplayerPeerExtension" inherits="MultiplayerPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_available_packet_count" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_connection_status" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="const void*" />
<argument index="1" name="r_buffer_size" type="int32_t*" />
<description>
</description>
</method>
<method name="_get_packet_peer" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_transfer_channel" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_transfer_mode" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_unique_id" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_is_refusing_new_connections" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_is_server" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
<return type="int" />
<description>
</description>
</method>
<method name="_put_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_buffer" type="const void*" />
<argument index="1" name="p_buffer_size" type="int" />
<description>
</description>
</method>
<method name="_set_refuse_new_connections" qualifiers="virtual">
<return type="void" />
<argument index="0" name="p_enable" type="bool" />
<description>
</description>
</method>
<method name="_set_target_peer" qualifiers="virtual">
<return type="void" />
<argument index="0" name="p_peer" type="int" />
<description>
</description>
</method>
<method name="_set_transfer_channel" qualifiers="virtual">
<return type="void" />
<argument index="0" name="p_channel" type="int" />
<description>
</description>
</method>
<method name="_set_transfer_mode" qualifiers="virtual">
<return type="void" />
<argument index="0" name="p_mode" type="int" />
<description>
</description>
</method>
</methods>
</class>

35
doc/classes/PacketPeerExtension.xml Normal file
View file

@ -0,0 +1,35 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeerExtension" inherits="PacketPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_available_packet_count" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="const void*" />
<argument index="1" name="r_buffer_size" type="int32_t*" />
<description>
</description>
</method>
<method name="_put_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_buffer" type="const void*" />
<argument index="1" name="p_buffer_size" type="int" />
<description>
</description>
</method>
</methods>
</class>

48
doc/classes/StreamPeerExtension.xml Normal file
View file

@ -0,0 +1,48 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerExtension" inherits="StreamPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_get_available_bytes" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="uint8_t*" />
<argument index="1" name="r_bytes" type="int" />
<argument index="2" name="r_received" type="int32_t*" />
<description>
</description>
</method>
<method name="_get_partial_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="uint8_t*" />
<argument index="1" name="r_bytes" type="int" />
<argument index="2" name="r_received" type="int32_t*" />
<description>
</description>
</method>
<method name="_put_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_data" type="const void*" />
<argument index="1" name="p_bytes" type="int" />
<argument index="2" name="r_sent" type="int32_t*" />
<description>
</description>
</method>
<method name="_put_partial_data" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_data" type="const void*" />
<argument index="1" name="p_bytes" type="int" />
<argument index="2" name="r_sent" type="int32_t*" />
<description>
</description>
</method>
</methods>
</class>

2
modules/enet/doc_classes/ENetMultiplayerPeer.xml
View file

@ -77,10 +77,8 @@
<member name="host" type="ENetConnection" setter="" getter="get_host">
The underlying [ENetConnection] created after [method create_client] and [method create_server].
</member>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
<member name="server_relay" type="bool" setter="set_server_relay_enabled" getter="is_server_relay_enabled" default="true">
Enable or disable the server feature that notifies clients of other peers' connection/disconnection, and relays messages between them. When this option is [code]false[/code], clients won't be automatically notified of other peers and won't be able to send them packets through the server.
</member>
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" override="true" enum="TransferMode" default="2" />
</members>
</class>

9
modules/gdnative/doc_classes/MultiplayerPeerGDNative.xml
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MultiplayerPeerGDNative" inherits="MultiplayerPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
</class>

9
modules/gdnative/doc_classes/PacketPeerGDNative.xml
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="PacketPeerGDNative" inherits="PacketPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
</class>

9
modules/gdnative/doc_classes/StreamPeerGDNative.xml
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerGDNative" inherits="StreamPeer" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
</class>

9
modules/gdnative/doc_classes/WebRTCDataChannelGDNative.xml
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebRTCDataChannelGDNative" inherits="WebRTCDataChannel" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
</class>

9
modules/gdnative/doc_classes/WebRTCPeerConnectionGDNative.xml
View file

@ -1,9 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebRTCPeerConnectionGDNative" inherits="WebRTCPeerConnection" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
</class>

106
modules/webrtc/doc_classes/WebRTCDataChannelExtension.xml Normal file
View file

@ -0,0 +1,106 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebRTCDataChannelExtension" inherits="WebRTCDataChannel" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_close" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_get_available_packet_count" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_buffered_amount" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_id" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_label" qualifiers="virtual const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_max_packet_life_time" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_packet_size" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_max_retransmits" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="r_buffer" type="const void*" />
<argument index="1" name="r_buffer_size" type="int32_t*" />
<description>
</description>
</method>
<method name="_get_protocol" qualifiers="virtual const">
<return type="String" />
<description>
</description>
</method>
<method name="_get_ready_state" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_get_write_mode" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_is_negotiated" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_is_ordered" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
<return type="int" />
<description>
</description>
</method>
<method name="_put_packet" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_buffer" type="const void*" />
<argument index="1" name="p_buffer_size" type="int" />
<description>
</description>
</method>
<method name="_set_write_mode" qualifiers="virtual">
<return type="void" />
<argument index="0" name="p_write_mode" type="int" />
<description>
</description>
</method>
<method name="_was_string_packet" qualifiers="virtual const">
<return type="bool" />
<description>
</description>
</method>
</methods>
</class>

4
modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml
View file

@ -67,8 +67,4 @@
</description>
</method>
</methods>
<members>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" override="true" enum="TransferMode" default="2" />
</members>
</class>

71
modules/webrtc/doc_classes/WebRTCPeerConnectionExtension.xml Normal file
View file

@ -0,0 +1,71 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebRTCPeerConnectionExtension" inherits="WebRTCPeerConnection" version="4.0">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="_add_ice_candidate" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_sdp_mid_name" type="String" />
<argument index="1" name="p_sdp_mline_index" type="int" />
<argument index="2" name="p_sdp_name" type="String" />
<description>
</description>
</method>
<method name="_close" qualifiers="virtual">
<return type="void" />
<description>
</description>
</method>
<method name="_create_data_channel" qualifiers="virtual">
<return type="Object" />
<argument index="0" name="p_label" type="String" />
<argument index="1" name="p_config" type="Dictionary" />
<description>
</description>
</method>
<method name="_create_offer" qualifiers="virtual">
<return type="int" />
<description>
</description>
</method>
<method name="_get_connection_state" qualifiers="virtual const">
<return type="int" />
<description>
</description>
</method>
<method name="_initialize" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_config" type="Dictionary" />
<description>
</description>
</method>
<method name="_poll" qualifiers="virtual">
<return type="int" />
<description>
</description>
</method>
<method name="_set_local_description" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_type" type="String" />
<argument index="1" name="p_sdp" type="String" />
<description>
</description>
</method>
<method name="_set_remote_description" qualifiers="virtual">
<return type="int" />
<argument index="0" name="p_type" type="String" />
<argument index="1" name="p_sdp" type="String" />
<description>
</description>
</method>
<method name="make_default">
<return type="void" />
<description>
</description>
</method>
</methods>
</class>

4
modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
View file

@ -30,10 +30,6 @@
</description>
</method>
</methods>
<members>
<member name="refuse_new_connections" type="bool" setter="set_refuse_new_connections" getter="is_refusing_new_connections" override="true" default="false" />
<member name="transfer_mode" type="int" setter="set_transfer_mode" getter="get_transfer_mode" override="true" enum="TransferMode" default="2" />
</members>
<signals>
<signal name="peer_packet">
<argument index="0" name="peer_source" type="int" />