.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/MultiplayerPeer.xml. .. _class_MultiplayerPeer: MultiplayerPeer =============== **Inherits:** :ref:`PacketPeer` **<** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`ENetMultiplayerPeer`, :ref:`MultiplayerPeerExtension`, :ref:`OfflineMultiplayerPeer`, :ref:`WebRTCMultiplayerPeer`, :ref:`WebSocketMultiplayerPeer` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ | :ref:`bool` | :ref:`refuse_new_connections` | ``false`` | +--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ | :ref:`int` | :ref:`transfer_channel` | ``0`` | +--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ | :ref:`TransferMode` | :ref:`transfer_mode` | ``2`` | +--------------------------------------------------------+--------------------------------------------------------------------------------------+-----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`close` **(** **)** | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` peer, :ref:`bool` force=false **)** | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`generate_unique_id` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`ConnectionStatus` | :ref:`get_connection_status` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_channel` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`TransferMode` | :ref:`get_packet_mode` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_packet_peer` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unique_id` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_server_relay_supported` **(** **)** |const| | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`poll` **(** **)** | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_target_peer` **(** :ref:`int` id **)** | +----------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_MultiplayerPeer_signal_peer_connected: .. rst-class:: classref-signal **peer_connected** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_signal_peer_disconnected: .. rst-class:: classref-signal **peer_disconnected** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_MultiplayerPeer_ConnectionStatus: .. rst-class:: classref-enumeration enum **ConnectionStatus**: .. _class_MultiplayerPeer_constant_CONNECTION_DISCONNECTED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionStatus` **CONNECTION_DISCONNECTED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerPeer_constant_CONNECTION_CONNECTING: .. rst-class:: classref-enumeration-constant :ref:`ConnectionStatus` **CONNECTION_CONNECTING** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerPeer_constant_CONNECTION_CONNECTED: .. rst-class:: classref-enumeration-constant :ref:`ConnectionStatus` **CONNECTION_CONNECTED** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _enum_MultiplayerPeer_TransferMode: .. rst-class:: classref-enumeration enum **TransferMode**: .. _class_MultiplayerPeer_constant_TRANSFER_MODE_UNRELIABLE: .. rst-class:: classref-enumeration-constant :ref:`TransferMode` **TRANSFER_MODE_UNRELIABLE** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerPeer_constant_TRANSFER_MODE_UNRELIABLE_ORDERED: .. rst-class:: classref-enumeration-constant :ref:`TransferMode` **TRANSFER_MODE_UNRELIABLE_ORDERED** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerPeer_constant_TRANSFER_MODE_RELIABLE: .. rst-class:: classref-enumeration-constant :ref:`TransferMode` **TRANSFER_MODE_RELIABLE** = ``2`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Constants --------- .. _class_MultiplayerPeer_constant_TARGET_PEER_BROADCAST: .. rst-class:: classref-constant **TARGET_PEER_BROADCAST** = ``0`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. _class_MultiplayerPeer_constant_TARGET_PEER_SERVER: .. rst-class:: classref-constant **TARGET_PEER_SERVER** = ``1`` .. container:: contribute There is currently no description for this constant. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_MultiplayerPeer_property_refuse_new_connections: .. rst-class:: classref-property :ref:`bool` **refuse_new_connections** = ``false`` .. rst-class:: classref-property-setget - void **set_refuse_new_connections** **(** :ref:`bool` value **)** - :ref:`bool` **is_refusing_new_connections** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_property_transfer_channel: .. rst-class:: classref-property :ref:`int` **transfer_channel** = ``0`` .. rst-class:: classref-property-setget - void **set_transfer_channel** **(** :ref:`int` value **)** - :ref:`int` **get_transfer_channel** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_property_transfer_mode: .. rst-class:: classref-property :ref:`TransferMode` **transfer_mode** = ``2`` .. rst-class:: classref-property-setget - void **set_transfer_mode** **(** :ref:`TransferMode` value **)** - :ref:`TransferMode` **get_transfer_mode** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_MultiplayerPeer_method_close: .. rst-class:: classref-method void **close** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_disconnect_peer: .. rst-class:: classref-method void **disconnect_peer** **(** :ref:`int` peer, :ref:`bool` force=false **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_generate_unique_id: .. rst-class:: classref-method :ref:`int` **generate_unique_id** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_get_connection_status: .. rst-class:: classref-method :ref:`ConnectionStatus` **get_connection_status** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_get_packet_channel: .. rst-class:: classref-method :ref:`int` **get_packet_channel** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_get_packet_mode: .. rst-class:: classref-method :ref:`TransferMode` **get_packet_mode** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_get_packet_peer: .. rst-class:: classref-method :ref:`int` **get_packet_peer** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_get_unique_id: .. rst-class:: classref-method :ref:`int` **get_unique_id** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_is_server_relay_supported: .. rst-class:: classref-method :ref:`bool` **is_server_relay_supported** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_poll: .. rst-class:: classref-method void **poll** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerPeer_method_set_target_peer: .. rst-class:: classref-method void **set_target_peer** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`