stan220/godot-docs
1
0
Fork 0
mirror of https://github.com/stan220/godot-docs.git synced 2026-09-08 17:28:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

classref: Sync with latest 4.0-dev

Browse Source
This commit is contained in:
Rémi Verschelde
2021-10-06 11:19:07 +02:00
parent 6952796767
commit f6f6c1bf19
958 changed files with 113054 additions and 52009 deletions
Download Patch File Download Diff File Expand all files Collapse all files
classes/class_webrtcdatachannel.rst
+50 -34
View File
@@ -9,9 +9,9 @@
WebRTCDataChannel
=================
**Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`Reference<class_Reference>` **<** :ref:`Object<class_Object>`
**Inherits:** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
**Inherited By:** :ref:`WebRTCDataChannelGDNative<class_WebRTCDataChannelGDNative>`
**Inherited By:** :ref:`WebRTCDataChannelExtension<class_WebRTCDataChannelExtension>`
@@ -25,29 +25,31 @@ Properties
Methods
-------
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_WebRTCDataChannel_method_close>` **(** **)** |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_id<class_WebRTCDataChannel_method_get_id>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_label<class_WebRTCDataChannel_method_get_label>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_packet_life_time<class_WebRTCDataChannel_method_get_max_packet_life_time>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_retransmits<class_WebRTCDataChannel_method_get_max_retransmits>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_protocol<class_WebRTCDataChannel_method_get_protocol>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`ChannelState<enum_WebRTCDataChannel_ChannelState>` | :ref:`get_ready_state<class_WebRTCDataChannel_method_get_ready_state>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_negotiated<class_WebRTCDataChannel_method_is_negotiated>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ordered<class_WebRTCDataChannel_method_is_ordered>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`poll<class_WebRTCDataChannel_method_poll>` **(** **)** |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`was_string_packet<class_WebRTCDataChannel_method_was_string_packet>` **(** **)** const |
+----------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| void | :ref:`close<class_WebRTCDataChannel_method_close>` **(** **)** |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_buffered_amount<class_WebRTCDataChannel_method_get_buffered_amount>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_id<class_WebRTCDataChannel_method_get_id>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_label<class_WebRTCDataChannel_method_get_label>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_packet_life_time<class_WebRTCDataChannel_method_get_max_packet_life_time>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_max_retransmits<class_WebRTCDataChannel_method_get_max_retransmits>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_String>` | :ref:`get_protocol<class_WebRTCDataChannel_method_get_protocol>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`ChannelState<enum_WebRTCDataChannel_ChannelState>` | :ref:`get_ready_state<class_WebRTCDataChannel_method_get_ready_state>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_negotiated<class_WebRTCDataChannel_method_is_negotiated>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_ordered<class_WebRTCDataChannel_method_is_ordered>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`Error<enum_@GlobalScope_Error>` | :ref:`poll<class_WebRTCDataChannel_method_poll>` **(** **)** |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`was_string_packet<class_WebRTCDataChannel_method_was_string_packet>` **(** **)** |const| |
+----------------------------------------------------------+--------------------------------------------------------------------------------------------------------------+
Enumerations
------------
@@ -114,9 +116,17 @@ Closes this data channel, notifying the other peer.
----
.. _class_WebRTCDataChannel_method_get_buffered_amount:
- :ref:`int<class_int>` **get_buffered_amount** **(** **)** |const|
Returns the number of bytes currently queued to be sent over this channel.
----
.. _class_WebRTCDataChannel_method_get_id:
- :ref:`int<class_int>` **get_id** **(** **)** const
- :ref:`int<class_int>` **get_id** **(** **)** |const|
Returns the id assigned to this channel during creation (or auto-assigned during negotiation).
@@ -126,7 +136,7 @@ If the channel is not negotiated out-of-band the id will only be available after
.. _class_WebRTCDataChannel_method_get_label:
- :ref:`String<class_String>` **get_label** **(** **)** const
- :ref:`String<class_String>` **get_label** **(** **)** |const|
Returns the label assigned to this channel during creation.
@@ -134,7 +144,7 @@ Returns the label assigned to this channel during creation.
.. _class_WebRTCDataChannel_method_get_max_packet_life_time:
- :ref:`int<class_int>` **get_max_packet_life_time** **(** **)** const
- :ref:`int<class_int>` **get_max_packet_life_time** **(** **)** |const|
Returns the ``maxPacketLifeTime`` value assigned to this channel during creation.
@@ -144,7 +154,7 @@ Will be ``65535`` if not specified.
.. _class_WebRTCDataChannel_method_get_max_retransmits:
- :ref:`int<class_int>` **get_max_retransmits** **(** **)** const
- :ref:`int<class_int>` **get_max_retransmits** **(** **)** |const|
Returns the ``maxRetransmits`` value assigned to this channel during creation.
@@ -154,7 +164,7 @@ Will be ``65535`` if not specified.
.. _class_WebRTCDataChannel_method_get_protocol:
- :ref:`String<class_String>` **get_protocol** **(** **)** const
- :ref:`String<class_String>` **get_protocol** **(** **)** |const|
Returns the sub-protocol assigned to this channel during creation. An empty string if not specified.
@@ -162,7 +172,7 @@ Returns the sub-protocol assigned to this channel during creation. An empty stri
.. _class_WebRTCDataChannel_method_get_ready_state:
- :ref:`ChannelState<enum_WebRTCDataChannel_ChannelState>` **get_ready_state** **(** **)** const
- :ref:`ChannelState<enum_WebRTCDataChannel_ChannelState>` **get_ready_state** **(** **)** |const|
Returns the current state of this channel, see :ref:`ChannelState<enum_WebRTCDataChannel_ChannelState>`.
@@ -170,7 +180,7 @@ Returns the current state of this channel, see :ref:`ChannelState<enum_WebRTCDat
.. _class_WebRTCDataChannel_method_is_negotiated:
- :ref:`bool<class_bool>` **is_negotiated** **(** **)** const
- :ref:`bool<class_bool>` **is_negotiated** **(** **)** |const|
Returns ``true`` if this channel was created with out-of-band configuration.
@@ -178,7 +188,7 @@ Returns ``true`` if this channel was created with out-of-band configuration.
.. _class_WebRTCDataChannel_method_is_ordered:
- :ref:`bool<class_bool>` **is_ordered** **(** **)** const
- :ref:`bool<class_bool>` **is_ordered** **(** **)** |const|
Returns ``true`` if this channel was created with ordering enabled (default).
@@ -194,7 +204,13 @@ Reserved, but not used for now.
.. _class_WebRTCDataChannel_method_was_string_packet:
- :ref:`bool<class_bool>` **was_string_packet** **(** **)** const
- :ref:`bool<class_bool>` **was_string_packet** **(** **)** |const|
Returns ``true`` if the last received packet was transferred as text. See :ref:`write_mode<class_WebRTCDataChannel_property_write_mode>`.
.. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
.. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
.. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
.. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
.. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
.. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`