.. 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/MultiplayerAPI.xml. .. _class_MultiplayerAPI: MultiplayerAPI ============== **Inherits:** :ref:`RefCounted` **<** :ref:`Object` **Inherited By:** :ref:`MultiplayerAPIExtension`, :ref:`SceneMultiplayer` .. 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:`MultiplayerPeer` | :ref:`multiplayer_peer` | +-----------------------------------------------+-------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MultiplayerAPI` | :ref:`create_default_interface` **(** **)** |static| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`StringName` | :ref:`get_default_interface` **(** **)** |static| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_peers` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_remote_sender_id` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_unique_id` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`has_multiplayer_peer` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_server` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`object_configuration_add` **(** :ref:`Object` object, :ref:`Variant` configuration **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`object_configuration_remove` **(** :ref:`Object` object, :ref:`Variant` configuration **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`poll` **(** **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`rpc` **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` arguments=[] **)** | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`set_default_interface` **(** :ref:`StringName` interface_name **)** |static| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_MultiplayerAPI_signal_connected_to_server: .. rst-class:: classref-signal **connected_to_server** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_signal_connection_failed: .. rst-class:: classref-signal **connection_failed** **(** **)** .. container:: contribute There is currently no description for this signal. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_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_MultiplayerAPI_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-item-separator ---- .. _class_MultiplayerAPI_signal_server_disconnected: .. rst-class:: classref-signal **server_disconnected** **(** **)** .. 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_MultiplayerAPI_RPCMode: .. rst-class:: classref-enumeration enum **RPCMode**: .. _class_MultiplayerAPI_constant_RPC_MODE_DISABLED: .. rst-class:: classref-enumeration-constant :ref:`RPCMode` **RPC_MODE_DISABLED** = ``0`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerAPI_constant_RPC_MODE_ANY_PEER: .. rst-class:: classref-enumeration-constant :ref:`RPCMode` **RPC_MODE_ANY_PEER** = ``1`` .. container:: contribute There is currently no description for this enum. Please help us by :ref:`contributing one `! .. _class_MultiplayerAPI_constant_RPC_MODE_AUTHORITY: .. rst-class:: classref-enumeration-constant :ref:`RPCMode` **RPC_MODE_AUTHORITY** = ``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 Property Descriptions --------------------- .. _class_MultiplayerAPI_property_multiplayer_peer: .. rst-class:: classref-property :ref:`MultiplayerPeer` **multiplayer_peer** .. rst-class:: classref-property-setget - void **set_multiplayer_peer** **(** :ref:`MultiplayerPeer` value **)** - :ref:`MultiplayerPeer` **get_multiplayer_peer** **(** **)** .. 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_MultiplayerAPI_method_create_default_interface: .. rst-class:: classref-method :ref:`MultiplayerAPI` **create_default_interface** **(** **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_get_default_interface: .. rst-class:: classref-method :ref:`StringName` **get_default_interface** **(** **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_get_peers: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_peers** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_get_remote_sender_id: .. rst-class:: classref-method :ref:`int` **get_remote_sender_id** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_get_unique_id: .. rst-class:: classref-method :ref:`int` **get_unique_id** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_has_multiplayer_peer: .. rst-class:: classref-method :ref:`bool` **has_multiplayer_peer** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_is_server: .. rst-class:: classref-method :ref:`bool` **is_server** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_object_configuration_add: .. rst-class:: classref-method :ref:`Error` **object_configuration_add** **(** :ref:`Object` object, :ref:`Variant` configuration **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_object_configuration_remove: .. rst-class:: classref-method :ref:`Error` **object_configuration_remove** **(** :ref:`Object` object, :ref:`Variant` configuration **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_poll: .. rst-class:: classref-method :ref:`Error` **poll** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_rpc: .. rst-class:: classref-method :ref:`Error` **rpc** **(** :ref:`int` peer, :ref:`Object` object, :ref:`StringName` method, :ref:`Array` arguments=[] **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPI_method_set_default_interface: .. rst-class:: classref-method void **set_default_interface** **(** :ref:`StringName` interface_name **)** |static| .. 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.)`