godot-docs/classes/class_multiplayerpeerextension.rst

:github_url: hide

.. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the MultiplayerPeerExtension.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_MultiplayerPeerExtension:

MultiplayerPeerExtension
========================

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



Methods
-------

+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_available_packet_count<class_MultiplayerPeerExtension_method__get_available_packet_count>` **(** **)** |virtual| |const|                          |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_connection_status<class_MultiplayerPeerExtension_method__get_connection_status>` **(** **)** |virtual| |const|                                    |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_max_packet_size<class_MultiplayerPeerExtension_method__get_max_packet_size>` **(** **)** |virtual| |const|                                        |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_packet<class_MultiplayerPeerExtension_method__get_packet>` **(** const uint8_t ** r_buffer, int32_t* r_buffer_size **)** |virtual|                |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_packet_peer<class_MultiplayerPeerExtension_method__get_packet_peer>` **(** **)** |virtual| |const|                                                |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_transfer_channel<class_MultiplayerPeerExtension_method__get_transfer_channel>` **(** **)** |virtual| |const|                                      |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_transfer_mode<class_MultiplayerPeerExtension_method__get_transfer_mode>` **(** **)** |virtual| |const|                                            |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_get_unique_id<class_MultiplayerPeerExtension_method__get_unique_id>` **(** **)** |virtual| |const|                                                    |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_is_refusing_new_connections<class_MultiplayerPeerExtension_method__is_refusing_new_connections>` **(** **)** |virtual| |const|                        |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`_is_server<class_MultiplayerPeerExtension_method__is_server>` **(** **)** |virtual| |const|                                                            |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`   | :ref:`_poll<class_MultiplayerPeerExtension_method__poll>` **(** **)** |virtual|                                                                              |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :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|     |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                    | :ref:`_set_refuse_new_connections<class_MultiplayerPeerExtension_method__set_refuse_new_connections>` **(** :ref:`bool<class_bool>` p_enable **)** |virtual| |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                    | :ref:`_set_target_peer<class_MultiplayerPeerExtension_method__set_target_peer>` **(** :ref:`int<class_int>` p_peer **)** |virtual|                           |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                    | :ref:`_set_transfer_channel<class_MultiplayerPeerExtension_method__set_transfer_channel>` **(** :ref:`int<class_int>` p_channel **)** |virtual|              |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void                    | :ref:`_set_transfer_mode<class_MultiplayerPeerExtension_method__set_transfer_mode>` **(** :ref:`int<class_int>` p_mode **)** |virtual|                       |
+-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------+

Method Descriptions
-------------------

.. _class_MultiplayerPeerExtension_method__get_available_packet_count:

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

----

.. _class_MultiplayerPeerExtension_method__get_connection_status:

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

----

.. _class_MultiplayerPeerExtension_method__get_max_packet_size:

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

----

.. _class_MultiplayerPeerExtension_method__get_packet:

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

----

.. _class_MultiplayerPeerExtension_method__get_packet_peer:

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

----

.. _class_MultiplayerPeerExtension_method__get_transfer_channel:

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

----

.. _class_MultiplayerPeerExtension_method__get_transfer_mode:

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

----

.. _class_MultiplayerPeerExtension_method__get_unique_id:

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

----

.. _class_MultiplayerPeerExtension_method__is_refusing_new_connections:

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

----

.. _class_MultiplayerPeerExtension_method__is_server:

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

----

.. _class_MultiplayerPeerExtension_method__poll:

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

----

.. _class_MultiplayerPeerExtension_method__put_packet:

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

----

.. _class_MultiplayerPeerExtension_method__set_refuse_new_connections:

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

----

.. _class_MultiplayerPeerExtension_method__set_target_peer:

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

----

.. _class_MultiplayerPeerExtension_method__set_transfer_channel:

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

----

.. _class_MultiplayerPeerExtension_method__set_transfer_mode:

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

.. |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.)`