首頁 探索 說明
登入
godotengine
/
godot-docs
镜像来自 https://github.com/godotengine/godot-docs
關註 1
讚好 1
複刻 0
Files
目錄樹: 8fe5feaf3f
分支列表 標籤列表
godot-docs
/
classes
/
class_webrtcmultiplayerpeer.rst

class_webrtcmultiplayerpeer.rst 13 KB
文件歷史 原始文件

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171 
  1. :github_url: hide
    2. 

  2. 

  3. .. DO NOT EDIT THIS FILE!!!
    4. 

  4. .. Generated automatically from Godot engine sources.
    5. 

  5. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py.
    6. 

  6. .. XML source: https://github.com/godotengine/godot/tree/master/modules/webrtc/doc_classes/WebRTCMultiplayerPeer.xml.
    7. 

  7. 

  8. .. _class_WebRTCMultiplayerPeer:
    9. 

  9. 

  10. WebRTCMultiplayerPeer
    11. 

  11. =====================
    12. 

  12. 

  13. **Inherits:** :ref:`MultiplayerPeer<class_MultiplayerPeer>` **<** :ref:`PacketPeer<class_PacketPeer>` **<** :ref:`RefCounted<class_RefCounted>` **<** :ref:`Object<class_Object>`
    14. 

  14. 

  15. A simple interface to create a peer-to-peer mesh network composed of :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>` that is compatible with the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    16. 

  16. 

  17. .. rst-class:: classref-introduction-group
    18. 

  18. 

  19. Description
    20. 

  20. -----------
    21. 

  21. 

  22. This class constructs a full mesh of :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>` (one connection for each peer) that can be used as a :ref:`MultiplayerAPI.multiplayer_peer<class_MultiplayerAPI_property_multiplayer_peer>`.
    23. 

  23. 

  24. You can add each :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>` via :ref:`add_peer()<class_WebRTCMultiplayerPeer_method_add_peer>` or remove them via :ref:`remove_peer()<class_WebRTCMultiplayerPeer_method_remove_peer>`. Peers must be added in :ref:`WebRTCPeerConnection.STATE_NEW<class_WebRTCPeerConnection_constant_STATE_NEW>` state to allow it to create the appropriate channels. This class will not create offers nor set descriptions, it will only poll them, and notify connections and disconnections.
    25. 

  25. 

  26. When creating the peer via :ref:`create_client()<class_WebRTCMultiplayerPeer_method_create_client>` or :ref:`create_server()<class_WebRTCMultiplayerPeer_method_create_server>` the :ref:`MultiplayerPeer.is_server_relay_supported()<class_MultiplayerPeer_method_is_server_relay_supported>` method will return ``true`` enabling peer exchange and packet relaying when supported by the :ref:`MultiplayerAPI<class_MultiplayerAPI>` implementation.
    27. 

  27. 

  28. \ **Note:** When exporting to Android, make sure to enable the ``INTERNET`` permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
    29. 

  29. 

  30. .. rst-class:: classref-reftable-group
    31. 

  31. 

  32. Methods
    33. 

  33. -------
    34. 

  34. 

  35. .. table::
    36. 

  36.    :widths: auto
    37. 

  37. 

  38.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    39. 

  39.    | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`add_peer<class_WebRTCMultiplayerPeer_method_add_peer>`\ (\ peer\: :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, peer_id\: :ref:`int<class_int>`, unreliable_lifetime\: :ref:`int<class_int>` = 1\ ) |
    40. 

  40.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    41. 

  41.    | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_client<class_WebRTCMultiplayerPeer_method_create_client>`\ (\ peer_id\: :ref:`int<class_int>`, channels_config\: :ref:`Array<class_Array>` = []\ )                                                      |
    42. 

  42.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    43. 

  43.    | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_mesh<class_WebRTCMultiplayerPeer_method_create_mesh>`\ (\ peer_id\: :ref:`int<class_int>`, channels_config\: :ref:`Array<class_Array>` = []\ )                                                          |
    44. 

  44.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    45. 

  45.    | :ref:`Error<enum_@GlobalScope_Error>` | :ref:`create_server<class_WebRTCMultiplayerPeer_method_create_server>`\ (\ channels_config\: :ref:`Array<class_Array>` = []\ )                                                                                       |
    46. 

  46.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    47. 

  47.    | :ref:`Dictionary<class_Dictionary>`   | :ref:`get_peer<class_WebRTCMultiplayerPeer_method_get_peer>`\ (\ peer_id\: :ref:`int<class_int>`\ )                                                                                                                  |
    48. 

  48.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    49. 

  49.    | :ref:`Dictionary<class_Dictionary>`   | :ref:`get_peers<class_WebRTCMultiplayerPeer_method_get_peers>`\ (\ )                                                                                                                                                 |
    50. 

  50.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    51. 

  51.    | :ref:`bool<class_bool>`               | :ref:`has_peer<class_WebRTCMultiplayerPeer_method_has_peer>`\ (\ peer_id\: :ref:`int<class_int>`\ )                                                                                                                  |
    52. 

  52.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    53. 

  53.    | |void|                                | :ref:`remove_peer<class_WebRTCMultiplayerPeer_method_remove_peer>`\ (\ peer_id\: :ref:`int<class_int>`\ )                                                                                                            |
    54. 

  54.    +---------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    55. 

  55. 

  56. .. rst-class:: classref-section-separator
    57. 

  57. 

  58. ----
    59. 

  59. 

  60. .. rst-class:: classref-descriptions-group
    61. 

  61. 

  62. Method Descriptions
    63. 

  63. -------------------
    64. 

  64. 

  65. .. _class_WebRTCMultiplayerPeer_method_add_peer:
    66. 

  66. 

  67. .. rst-class:: classref-method
    68. 

  68. 

  69. :ref:`Error<enum_@GlobalScope_Error>` **add_peer**\ (\ peer\: :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>`, peer_id\: :ref:`int<class_int>`, unreliable_lifetime\: :ref:`int<class_int>` = 1\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_add_peer>`
    70. 

  70. 

  71. Add a new peer to the mesh with the given ``peer_id``. The :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>` must be in state :ref:`WebRTCPeerConnection.STATE_NEW<class_WebRTCPeerConnection_constant_STATE_NEW>`.
    72. 

  72. 

  73. Three channels will be created for reliable, unreliable, and ordered transport. The value of ``unreliable_lifetime`` will be passed to the ``"maxPacketLifetime"`` option when creating unreliable and ordered channels (see :ref:`WebRTCPeerConnection.create_data_channel()<class_WebRTCPeerConnection_method_create_data_channel>`).
    74. 

  74. 

  75. .. rst-class:: classref-item-separator
    76. 

  76. 

  77. ----
    78. 

  78. 

  79. .. _class_WebRTCMultiplayerPeer_method_create_client:
    80. 

  80. 

  81. .. rst-class:: classref-method
    82. 

  82. 

  83. :ref:`Error<enum_@GlobalScope_Error>` **create_client**\ (\ peer_id\: :ref:`int<class_int>`, channels_config\: :ref:`Array<class_Array>` = []\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_create_client>`
    84. 

  84. 

  85. Initialize the multiplayer peer as a client with the given ``peer_id`` (must be between 2 and 2147483647). In this mode, you should only call :ref:`add_peer()<class_WebRTCMultiplayerPeer_method_add_peer>` once and with ``peer_id`` of ``1``. This mode enables :ref:`MultiplayerPeer.is_server_relay_supported()<class_MultiplayerPeer_method_is_server_relay_supported>`, allowing the upper :ref:`MultiplayerAPI<class_MultiplayerAPI>` layer to perform peer exchange and packet relaying.
    86. 

  86. 

  87. You can optionally specify a ``channels_config`` array of :ref:`TransferMode<enum_MultiplayerPeer_TransferMode>` which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
    88. 

  88. 

  89. .. rst-class:: classref-item-separator
    90. 

  90. 

  91. ----
    92. 

  92. 

  93. .. _class_WebRTCMultiplayerPeer_method_create_mesh:
    94. 

  94. 

  95. .. rst-class:: classref-method
    96. 

  96. 

  97. :ref:`Error<enum_@GlobalScope_Error>` **create_mesh**\ (\ peer_id\: :ref:`int<class_int>`, channels_config\: :ref:`Array<class_Array>` = []\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_create_mesh>`
    98. 

  98. 

  99. Initialize the multiplayer peer as a mesh (i.e. all peers connect to each other) with the given ``peer_id`` (must be between 1 and 2147483647).
    100. 

  100. 

  101. .. rst-class:: classref-item-separator
    102. 

  102. 

  103. ----
    104. 

  104. 

  105. .. _class_WebRTCMultiplayerPeer_method_create_server:
    106. 

  106. 

  107. .. rst-class:: classref-method
    108. 

  108. 

  109. :ref:`Error<enum_@GlobalScope_Error>` **create_server**\ (\ channels_config\: :ref:`Array<class_Array>` = []\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_create_server>`
    110. 

  110. 

  111. Initialize the multiplayer peer as a server (with unique ID of ``1``). This mode enables :ref:`MultiplayerPeer.is_server_relay_supported()<class_MultiplayerPeer_method_is_server_relay_supported>`, allowing the upper :ref:`MultiplayerAPI<class_MultiplayerAPI>` layer to perform peer exchange and packet relaying.
    112. 

  112. 

  113. You can optionally specify a ``channels_config`` array of :ref:`TransferMode<enum_MultiplayerPeer_TransferMode>` which will be used to create extra channels (WebRTC only supports one transfer mode per channel).
    114. 

  114. 

  115. .. rst-class:: classref-item-separator
    116. 

  116. 

  117. ----
    118. 

  118. 

  119. .. _class_WebRTCMultiplayerPeer_method_get_peer:
    120. 

  120. 

  121. .. rst-class:: classref-method
    122. 

  122. 

  123. :ref:`Dictionary<class_Dictionary>` **get_peer**\ (\ peer_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_get_peer>`
    124. 

  124. 

  125. Returns a dictionary representation of the peer with given ``peer_id`` with three keys. ``"connection"`` containing the :ref:`WebRTCPeerConnection<class_WebRTCPeerConnection>` to this peer, ``"channels"`` an array of three :ref:`WebRTCDataChannel<class_WebRTCDataChannel>`, and ``"connected"`` a boolean representing if the peer connection is currently connected (all three channels are open).
    126. 

  126. 

  127. .. rst-class:: classref-item-separator
    128. 

  128. 

  129. ----
    130. 

  130. 

  131. .. _class_WebRTCMultiplayerPeer_method_get_peers:
    132. 

  132. 

  133. .. rst-class:: classref-method
    134. 

  134. 

  135. :ref:`Dictionary<class_Dictionary>` **get_peers**\ (\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_get_peers>`
    136. 

  136. 

  137. Returns a dictionary which keys are the peer ids and values the peer representation as in :ref:`get_peer()<class_WebRTCMultiplayerPeer_method_get_peer>`.
    138. 

  138. 

  139. .. rst-class:: classref-item-separator
    140. 

  140. 

  141. ----
    142. 

  142. 

  143. .. _class_WebRTCMultiplayerPeer_method_has_peer:
    144. 

  144. 

  145. .. rst-class:: classref-method
    146. 

  146. 

  147. :ref:`bool<class_bool>` **has_peer**\ (\ peer_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_has_peer>`
    148. 

  148. 

  149. Returns ``true`` if the given ``peer_id`` is in the peers map (it might not be connected though).
    150. 

  150. 

  151. .. rst-class:: classref-item-separator
    152. 

  152. 

  153. ----
    154. 

  154. 

  155. .. _class_WebRTCMultiplayerPeer_method_remove_peer:
    156. 

  156. 

  157. .. rst-class:: classref-method
    158. 

  158. 

  159. |void| **remove_peer**\ (\ peer_id\: :ref:`int<class_int>`\ ) :ref:`🔗<class_WebRTCMultiplayerPeer_method_remove_peer>`
    160. 

  160. 

  161. Remove the peer with given ``peer_id`` from the mesh. If the peer was connected, and :ref:`MultiplayerPeer.peer_connected<class_MultiplayerPeer_signal_peer_connected>` was emitted for it, then :ref:`MultiplayerPeer.peer_disconnected<class_MultiplayerPeer_signal_peer_disconnected>` will be emitted.
    162. 

  162. 

  163. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
    164. 

  164. .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
    165. 

  165. .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
    166. 

  166. .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
    167. 

  167. .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
    168. 

  168. .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
    169. 

  169. .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`
    170. 

  170. .. |void| replace:: :abbr:`void (No return value.)`
    171. 

  171.