.. 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/modules/multiplayer/doc_classes/SceneMultiplayer.xml. .. _class_SceneMultiplayer: SceneMultiplayer ================ **Inherits:** :ref:`MultiplayerAPI` **<** :ref:`RefCounted` **<** :ref:`Object` .. 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:`allow_object_decoding` | ``false`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`Callable` | :ref:`auth_callback` | ``Callable()`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`float` | :ref:`auth_timeout` | ``3.0`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`max_delta_packet_size` | ``65535`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`int` | :ref:`max_sync_packet_size` | ``1350`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`refuse_new_connections` | ``false`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`NodePath` | :ref:`root_path` | ``NodePath("")`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ | :ref:`bool` | :ref:`server_relay` | ``true`` | +---------------------------------+---------------------------------------------------------------------------------------+------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`clear` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`complete_auth` **(** :ref:`int` id **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`disconnect_peer` **(** :ref:`int` id **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`get_authenticating_peers` **(** **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`send_auth` **(** :ref:`int` id, :ref:`PackedByteArray` data **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`send_bytes` **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2, :ref:`int` channel=0 **)** | +-------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Signals ------- .. _class_SceneMultiplayer_signal_peer_authenticating: .. rst-class:: classref-signal **peer_authenticating** **(** :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_SceneMultiplayer_signal_peer_authentication_failed: .. rst-class:: classref-signal **peer_authentication_failed** **(** :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_SceneMultiplayer_signal_peer_packet: .. rst-class:: classref-signal **peer_packet** **(** :ref:`int` id, :ref:`PackedByteArray` packet **)** .. 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 Property Descriptions --------------------- .. _class_SceneMultiplayer_property_allow_object_decoding: .. rst-class:: classref-property :ref:`bool` **allow_object_decoding** = ``false`` .. rst-class:: classref-property-setget - void **set_allow_object_decoding** **(** :ref:`bool` value **)** - :ref:`bool` **is_object_decoding_allowed** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_property_auth_callback: .. rst-class:: classref-property :ref:`Callable` **auth_callback** = ``Callable()`` .. rst-class:: classref-property-setget - void **set_auth_callback** **(** :ref:`Callable` value **)** - :ref:`Callable` **get_auth_callback** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_property_auth_timeout: .. rst-class:: classref-property :ref:`float` **auth_timeout** = ``3.0`` .. rst-class:: classref-property-setget - void **set_auth_timeout** **(** :ref:`float` value **)** - :ref:`float` **get_auth_timeout** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_property_max_delta_packet_size: .. rst-class:: classref-property :ref:`int` **max_delta_packet_size** = ``65535`` .. rst-class:: classref-property-setget - void **set_max_delta_packet_size** **(** :ref:`int` value **)** - :ref:`int` **get_max_delta_packet_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_property_max_sync_packet_size: .. rst-class:: classref-property :ref:`int` **max_sync_packet_size** = ``1350`` .. rst-class:: classref-property-setget - void **set_max_sync_packet_size** **(** :ref:`int` value **)** - :ref:`int` **get_max_sync_packet_size** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_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_SceneMultiplayer_property_root_path: .. rst-class:: classref-property :ref:`NodePath` **root_path** = ``NodePath("")`` .. rst-class:: classref-property-setget - void **set_root_path** **(** :ref:`NodePath` value **)** - :ref:`NodePath` **get_root_path** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_property_server_relay: .. rst-class:: classref-property :ref:`bool` **server_relay** = ``true`` .. rst-class:: classref-property-setget - void **set_server_relay_enabled** **(** :ref:`bool` value **)** - :ref:`bool` **is_server_relay_enabled** **(** **)** .. 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_SceneMultiplayer_method_clear: .. rst-class:: classref-method void **clear** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_method_complete_auth: .. rst-class:: classref-method :ref:`Error` **complete_auth** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_method_disconnect_peer: .. rst-class:: classref-method void **disconnect_peer** **(** :ref:`int` id **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_method_get_authenticating_peers: .. rst-class:: classref-method :ref:`PackedInt32Array` **get_authenticating_peers** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_method_send_auth: .. rst-class:: classref-method :ref:`Error` **send_auth** **(** :ref:`int` id, :ref:`PackedByteArray` data **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_SceneMultiplayer_method_send_bytes: .. rst-class:: classref-method :ref:`Error` **send_bytes** **(** :ref:`PackedByteArray` bytes, :ref:`int` id=0, :ref:`TransferMode` mode=2, :ref:`int` channel=0 **)** .. 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.)`