seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages 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
Download Patch File Download Diff File Expand all files Collapse all files

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>