:github_url: hide .. meta:: :keywords: network .. 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/doc/classes/MultiplayerAPIExtension.xml. .. _class_MultiplayerAPIExtension: MultiplayerAPIExtension ======================= **Inherits:** :ref:`MultiplayerAPI` **<** :ref:`RefCounted` **<** :ref:`Object` Base class used for extending the :ref:`MultiplayerAPI`. .. rst-class:: classref-introduction-group Description ----------- This class can be used to extend or replace the default :ref:`MultiplayerAPI` implementation via script or extensions. The following example extend the default implementation (:ref:`SceneMultiplayer`) by logging every RPC being made, and every object being configured for replication. .. tabs:: .. code-tab:: gdscript extends MultiplayerAPIExtension class_name LogMultiplayer # We want to extend the default SceneMultiplayer. var base_multiplayer = SceneMultiplayer.new() func _init(): # Just passthrough base signals (copied to var to avoid cyclic reference) var cts = connected_to_server var cf = connection_failed var sd = server_disconnected var pc = peer_connected var pd = peer_disconnected base_multiplayer.connected_to_server.connect(func(): cts.emit()) base_multiplayer.connection_failed.connect(func(): cf.emit()) base_multiplayer.server_disconnected.connect(func(): sd.emit()) base_multiplayer.peer_connected.connect(func(id): pc.emit(id)) base_multiplayer.peer_disconnected.connect(func(id): pd.emit(id)) func _poll(): return base_multiplayer.poll() # Log RPC being made and forward it to the default multiplayer. func _rpc(peer: int, object: Object, method: StringName, args: Array) -> Error: print("Got RPC for %d: %s::%s(%s)" % [peer, object, method, args]) return base_multiplayer.rpc(peer, object, method, args) # Log configuration add. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom. func _object_configuration_add(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: print("Adding synchronization configuration for %s. Synchronizer: %s" % [object, config]) elif config is MultiplayerSpawner: print("Adding node %s to the spawn list. Spawner: %s" % [object, config]) return base_multiplayer.object_configuration_add(object, config) # Log configuration remove. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom. func _object_configuration_remove(object, config: Variant) -> Error: if config is MultiplayerSynchronizer: print("Removing synchronization configuration for %s. Synchronizer: %s" % [object, config]) elif config is MultiplayerSpawner: print("Removing node %s from the spawn list. Spawner: %s" % [object, config]) return base_multiplayer.object_configuration_remove(object, config) # These can be optional, but in our case we want to extend SceneMultiplayer, so forward everything. func _set_multiplayer_peer(p_peer: MultiplayerPeer): base_multiplayer.multiplayer_peer = p_peer func _get_multiplayer_peer() -> MultiplayerPeer: return base_multiplayer.multiplayer_peer func _get_unique_id() -> int: return base_multiplayer.get_unique_id() func _get_remote_sender_id() -> int: return base_multiplayer.get_remote_sender_id() func _get_peer_ids() -> PackedInt32Array: return base_multiplayer.get_peers() Then in your main scene or in an autoload call :ref:`SceneTree.set_multiplayer()` to start using your custom :ref:`MultiplayerAPI`: .. tabs:: .. code-tab:: gdscript # autoload.gd func _enter_tree(): # Sets our custom multiplayer as the main one in SceneTree. get_tree().set_multiplayer(LogMultiplayer.new()) Native extensions can alternatively use the :ref:`MultiplayerAPI.set_default_interface()` method during initialization to configure themselves as the default implementation. .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`MultiplayerPeer` | :ref:`_get_multiplayer_peer`\ (\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedInt32Array` | :ref:`_get_peer_ids`\ (\ ) |virtual| |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_remote_sender_id`\ (\ ) |virtual| |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`_get_unique_id`\ (\ ) |virtual| |const| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_object_configuration_add`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_object_configuration_remove`\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_poll`\ (\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`_rpc`\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`_set_multiplayer_peer`\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| | +-------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_MultiplayerAPIExtension_private_method__get_multiplayer_peer: .. rst-class:: classref-method :ref:`MultiplayerPeer` **_get_multiplayer_peer**\ (\ ) |virtual| :ref:`🔗` Called when the :ref:`MultiplayerAPI.multiplayer_peer` is retrieved. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__get_peer_ids: .. rst-class:: classref-method :ref:`PackedInt32Array` **_get_peer_ids**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_peers()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__get_remote_sender_id: .. rst-class:: classref-method :ref:`int` **_get_remote_sender_id**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_remote_sender_id()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__get_unique_id: .. rst-class:: classref-method :ref:`int` **_get_unique_id**\ (\ ) |virtual| |const| :ref:`🔗` Callback for :ref:`MultiplayerAPI.get_unique_id()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__object_configuration_add: .. rst-class:: classref-method :ref:`Error` **_object_configuration_add**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.object_configuration_add()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__object_configuration_remove: .. rst-class:: classref-method :ref:`Error` **_object_configuration_remove**\ (\ object\: :ref:`Object`, configuration\: :ref:`Variant`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.object_configuration_remove()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__poll: .. rst-class:: classref-method :ref:`Error` **_poll**\ (\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.poll()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__rpc: .. rst-class:: classref-method :ref:`Error` **_rpc**\ (\ peer\: :ref:`int`, object\: :ref:`Object`, method\: :ref:`StringName`, args\: :ref:`Array`\ ) |virtual| :ref:`🔗` Callback for :ref:`MultiplayerAPI.rpc()`. .. rst-class:: classref-item-separator ---- .. _class_MultiplayerAPIExtension_private_method__set_multiplayer_peer: .. rst-class:: classref-method |void| **_set_multiplayer_peer**\ (\ multiplayer_peer\: :ref:`MultiplayerPeer`\ ) |virtual| :ref:`🔗` Called when the :ref:`MultiplayerAPI.multiplayer_peer` is set. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |void| replace:: :abbr:`void (No return value.)`