Home Explore Help
Sign In
Godot
/
godot-docs
mirror of https://github.com/godotengine/godot-docs.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 2be4e9b938
Branches Tags
godot-docs
/
classes
/
class_multiplayerpeerextension.rst

class_multiplayerpeerextension.rst 15 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213 
  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/doc/classes/MultiplayerPeerExtension.xml.
    7. 

  7. 

  8. .. _class_MultiplayerPeerExtension:
    9. 

  9. 

  10. MultiplayerPeerExtension
    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. Class that can be inherited to implement custom multiplayer API networking layers via GDExtension.
    16. 

  16. 

  17. Description
    18. 

  18. -----------
    19. 

  19. 

  20. This class is designed to be inherited from a GDExtension plugin to implement custom networking layers for the multiplayer API (such as WebRTC). All the methods below **must** be implemented to have a working custom multiplayer implementation. See also :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    21. 

  21. 

  22. Methods
    23. 

  23. -------
    24. 

  24. 

  25. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    26. 

  26. | :ref:`int<class_int>`                         | :ref:`_get_available_packet_count<class_MultiplayerPeerExtension_method__get_available_packet_count>` **(** **)** |virtual| |const|                              |
    27. 

  27. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    28. 

  28. | :ref:`int<class_int>`                         | :ref:`_get_connection_status<class_MultiplayerPeerExtension_method__get_connection_status>` **(** **)** |virtual| |const|                                        |
    29. 

  29. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    30. 

  30. | :ref:`int<class_int>`                         | :ref:`_get_max_packet_size<class_MultiplayerPeerExtension_method__get_max_packet_size>` **(** **)** |virtual| |const|                                            |
    31. 

  31. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    32. 

  32. | :ref:`int<class_int>`                         | :ref:`_get_packet<class_MultiplayerPeerExtension_method__get_packet>` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual|                    |
    33. 

  33. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    34. 

  34. | :ref:`int<class_int>`                         | :ref:`_get_packet_peer<class_MultiplayerPeerExtension_method__get_packet_peer>` **(** **)** |virtual| |const|                                                    |
    35. 

  35. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    36. 

  36. | :ref:`PackedByteArray<class_PackedByteArray>` | :ref:`_get_packet_script<class_MultiplayerPeerExtension_method__get_packet_script>` **(** **)** |virtual|                                                        |
    37. 

  37. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    38. 

  38. | :ref:`int<class_int>`                         | :ref:`_get_transfer_channel<class_MultiplayerPeerExtension_method__get_transfer_channel>` **(** **)** |virtual| |const|                                          |
    39. 

  39. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    40. 

  40. | :ref:`int<class_int>`                         | :ref:`_get_transfer_mode<class_MultiplayerPeerExtension_method__get_transfer_mode>` **(** **)** |virtual| |const|                                                |
    41. 

  41. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    42. 

  42. | :ref:`int<class_int>`                         | :ref:`_get_unique_id<class_MultiplayerPeerExtension_method__get_unique_id>` **(** **)** |virtual| |const|                                                        |
    43. 

  43. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    44. 

  44. | :ref:`bool<class_bool>`                       | :ref:`_is_refusing_new_connections<class_MultiplayerPeerExtension_method__is_refusing_new_connections>` **(** **)** |virtual| |const|                            |
    45. 

  45. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    46. 

  46. | :ref:`bool<class_bool>`                       | :ref:`_is_server<class_MultiplayerPeerExtension_method__is_server>` **(** **)** |virtual| |const|                                                                |
    47. 

  47. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    48. 

  48. | :ref:`int<class_int>`                         | :ref:`_poll<class_MultiplayerPeerExtension_method__poll>` **(** **)** |virtual|                                                                                  |
    49. 

  49. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    50. 

  50. | :ref:`int<class_int>`                         | :ref:`_put_packet<class_MultiplayerPeerExtension_method__put_packet>` **(** const uint8_t* p_buffer, :ref:`int<class_int>` p_buffer_size **)** |virtual|         |
    51. 

  51. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    52. 

  52. | :ref:`int<class_int>`                         | :ref:`_put_packet_script<class_MultiplayerPeerExtension_method__put_packet_script>` **(** :ref:`PackedByteArray<class_PackedByteArray>` p_buffer **)** |virtual| |
    53. 

  53. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    54. 

  54. | void                                          | :ref:`_set_refuse_new_connections<class_MultiplayerPeerExtension_method__set_refuse_new_connections>` **(** :ref:`bool<class_bool>` p_enable **)** |virtual|     |
    55. 

  55. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    56. 

  56. | void                                          | :ref:`_set_target_peer<class_MultiplayerPeerExtension_method__set_target_peer>` **(** :ref:`int<class_int>` p_peer **)** |virtual|                               |
    57. 

  57. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    58. 

  58. | void                                          | :ref:`_set_transfer_channel<class_MultiplayerPeerExtension_method__set_transfer_channel>` **(** :ref:`int<class_int>` p_channel **)** |virtual|                  |
    59. 

  59. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    60. 

  60. | void                                          | :ref:`_set_transfer_mode<class_MultiplayerPeerExtension_method__set_transfer_mode>` **(** :ref:`int<class_int>` p_mode **)** |virtual|                           |
    61. 

  61. +-----------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    62. 

  62. 

  63. Method Descriptions
    64. 

  64. -------------------
    65. 

  65. 

  66. .. _class_MultiplayerPeerExtension_method__get_available_packet_count:
    67. 

  67. 

  68. - :ref:`int<class_int>` **_get_available_packet_count** **(** **)** |virtual| |const|
    69. 

  69. 

  70. Called when the available packet count is internally requested by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    71. 

  71. 

  72. ----
    73. 

  73. 

  74. .. _class_MultiplayerPeerExtension_method__get_connection_status:
    75. 

  75. 

  76. - :ref:`int<class_int>` **_get_connection_status** **(** **)** |virtual| |const|
    77. 

  77. 

  78. Called when the connection status is requested on the :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.get_connection_status<class_MultiplayerPeer_method_get_connection_status>`).
    79. 

  79. 

  80. ----
    81. 

  81. 

  82. .. _class_MultiplayerPeerExtension_method__get_max_packet_size:
    83. 

  83. 

  84. - :ref:`int<class_int>` **_get_max_packet_size** **(** **)** |virtual| |const|
    85. 

  85. 

  86. Called when the maximum allowed packet size (in bytes) is requested by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`.
    87. 

  87. 

  88. ----
    89. 

  89. 

  90. .. _class_MultiplayerPeerExtension_method__get_packet:
    91. 

  91. 

  92. - :ref:`int<class_int>` **_get_packet** **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual|
    93. 

  93. 

  94. Called when a packet needs to be received by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`, with ``p_buffer_size`` being the size of the binary ``p_buffer`` in bytes.
    95. 

  95. 

  96. ----
    97. 

  97. 

  98. .. _class_MultiplayerPeerExtension_method__get_packet_peer:
    99. 

  99. 

  100. - :ref:`int<class_int>` **_get_packet_peer** **(** **)** |virtual| |const|
    101. 

  101. 

  102. Called when the ID of the :ref:`MultiplayerPeer<class_MultiplayerPeer>` who sent the most recent packet is requested (see :ref:`MultiplayerPeer.get_packet_peer<class_MultiplayerPeer_method_get_packet_peer>`).
    103. 

  103. 

  104. ----
    105. 

  105. 

  106. .. _class_MultiplayerPeerExtension_method__get_packet_script:
    107. 

  107. 

  108. - :ref:`PackedByteArray<class_PackedByteArray>` **_get_packet_script** **(** **)** |virtual|
    109. 

  109. 

  110. Called when a packet needs to be received by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`, if :ref:`_get_packet<class_MultiplayerPeerExtension_method__get_packet>` isn't implemented. Use this when extending this class via GDScript.
    111. 

  111. 

  112. ----
    113. 

  113. 

  114. .. _class_MultiplayerPeerExtension_method__get_transfer_channel:
    115. 

  115. 

  116. - :ref:`int<class_int>` **_get_transfer_channel** **(** **)** |virtual| |const|
    117. 

  117. 

  118. Called when the transfer channel to use is read on this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.transfer_channel<class_MultiplayerPeer_property_transfer_channel>`).
    119. 

  119. 

  120. ----
    121. 

  121. 

  122. .. _class_MultiplayerPeerExtension_method__get_transfer_mode:
    123. 

  123. 

  124. - :ref:`int<class_int>` **_get_transfer_mode** **(** **)** |virtual| |const|
    125. 

  125. 

  126. Called when the transfer mode to use is read on this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.transfer_mode<class_MultiplayerPeer_property_transfer_mode>`).
    127. 

  127. 

  128. ----
    129. 

  129. 

  130. .. _class_MultiplayerPeerExtension_method__get_unique_id:
    131. 

  131. 

  132. - :ref:`int<class_int>` **_get_unique_id** **(** **)** |virtual| |const|
    133. 

  133. 

  134. Called when the unique ID of this :ref:`MultiplayerPeer<class_MultiplayerPeer>` is requested (see :ref:`MultiplayerPeer.get_unique_id<class_MultiplayerPeer_method_get_unique_id>`).
    135. 

  135. 

  136. ----
    137. 

  137. 

  138. .. _class_MultiplayerPeerExtension_method__is_refusing_new_connections:
    139. 

  139. 

  140. - :ref:`bool<class_bool>` **_is_refusing_new_connections** **(** **)** |virtual| |const|
    141. 

  141. 

  142. Called when the "refuse new connections" status is requested on this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.refuse_new_connections<class_MultiplayerPeer_property_refuse_new_connections>`).
    143. 

  143. 

  144. ----
    145. 

  145. 

  146. .. _class_MultiplayerPeerExtension_method__is_server:
    147. 

  147. 

  148. - :ref:`bool<class_bool>` **_is_server** **(** **)** |virtual| |const|
    149. 

  149. 

  150. Called when the "is server" status is requested on the :ref:`MultiplayerAPI<class_MultiplayerAPI>`. See :ref:`MultiplayerAPI.is_server<class_MultiplayerAPI_method_is_server>`.
    151. 

  151. 

  152. ----
    153. 

  153. 

  154. .. _class_MultiplayerPeerExtension_method__poll:
    155. 

  155. 

  156. - :ref:`int<class_int>` **_poll** **(** **)** |virtual|
    157. 

  157. 

  158. Called when the :ref:`MultiplayerAPI<class_MultiplayerAPI>` is polled. See :ref:`MultiplayerAPI.poll<class_MultiplayerAPI_method_poll>`.
    159. 

  159. 

  160. ----
    161. 

  161. 

  162. .. _class_MultiplayerPeerExtension_method__put_packet:
    163. 

  163. 

  164. - :ref:`int<class_int>` **_put_packet** **(** const uint8_t* p_buffer, :ref:`int<class_int>` p_buffer_size **)** |virtual|
    165. 

  165. 

  166. Called when a packet needs to be sent by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`, with ``p_buffer_size`` being the size of the binary ``p_buffer`` in bytes.
    167. 

  167. 

  168. ----
    169. 

  169. 

  170. .. _class_MultiplayerPeerExtension_method__put_packet_script:
    171. 

  171. 

  172. - :ref:`int<class_int>` **_put_packet_script** **(** :ref:`PackedByteArray<class_PackedByteArray>` p_buffer **)** |virtual|
    173. 

  173. 

  174. Called when a packet needs to be sent by the :ref:`MultiplayerAPI<class_MultiplayerAPI>`, if :ref:`_put_packet<class_MultiplayerPeerExtension_method__put_packet>` isn't implemented. Use this when extending this class via GDScript.
    175. 

  175. 

  176. ----
    177. 

  177. 

  178. .. _class_MultiplayerPeerExtension_method__set_refuse_new_connections:
    179. 

  179. 

  180. - void **_set_refuse_new_connections** **(** :ref:`bool<class_bool>` p_enable **)** |virtual|
    181. 

  181. 

  182. Called when the "refuse new connections" status is set on this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.refuse_new_connections<class_MultiplayerPeer_property_refuse_new_connections>`).
    183. 

  183. 

  184. ----
    185. 

  185. 

  186. .. _class_MultiplayerPeerExtension_method__set_target_peer:
    187. 

  187. 

  188. - void **_set_target_peer** **(** :ref:`int<class_int>` p_peer **)** |virtual|
    189. 

  189. 

  190. Called when the target peer to use is set for this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.set_target_peer<class_MultiplayerPeer_method_set_target_peer>`).
    191. 

  191. 

  192. ----
    193. 

  193. 

  194. .. _class_MultiplayerPeerExtension_method__set_transfer_channel:
    195. 

  195. 

  196. - void **_set_transfer_channel** **(** :ref:`int<class_int>` p_channel **)** |virtual|
    197. 

  197. 

  198. Called when the channel to use is set for this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.transfer_channel<class_MultiplayerPeer_property_transfer_channel>`).
    199. 

  199. 

  200. ----
    201. 

  201. 

  202. .. _class_MultiplayerPeerExtension_method__set_transfer_mode:
    203. 

  203. 

  204. - void **_set_transfer_mode** **(** :ref:`int<class_int>` p_mode **)** |virtual|
    205. 

  205. 

  206. Called when the transfer mode is set on this :ref:`MultiplayerPeer<class_MultiplayerPeer>` (see :ref:`MultiplayerPeer.transfer_mode<class_MultiplayerPeer_property_transfer_mode>`).
    207. 

  207. 

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

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

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

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

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

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