Description

Base class for high-level multiplayer API implementations. See alsoMultiplayerPeer.

By default,SceneTree has a reference to an implementation of this class and uses it to provide multiplayer capabilities (i.e. RPCs) across the whole scene.

It is possible to override the MultiplayerAPI instance used by specific tree branches by calling theSceneTree.set_multiplayer() method, effectively allowing to run both client and server in the same scene.

It is also possible to extend or replace the default implementation via scripting or native extensions. SeeMultiplayerAPIExtension for details about extensions,SceneMultiplayer for the details about the default implementation.

Properties

Methods

Signals

connected_to_server()🔗

Emitted when this MultiplayerAPI'smultiplayer_peer successfully connected to a server. Only emitted on clients.

connection_failed()🔗

Emitted when this MultiplayerAPI'smultiplayer_peer fails to establish a connection to a server. Only emitted on clients.

peer_connected(id:int)🔗

Emitted when this MultiplayerAPI'smultiplayer_peer connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1).

peer_disconnected(id:int)🔗

Emitted when this MultiplayerAPI'smultiplayer_peer disconnects from a peer. Clients get notified when other clients disconnect from the same server.

server_disconnected()🔗

Emitted when this MultiplayerAPI'smultiplayer_peer disconnects from server. Only emitted on clients.

Enumerations

enumRPCMode:🔗

RPCModeRPC_MODE_DISABLED =0

Used withNode.rpc_config() to disable a method or property for all RPC calls, making it unavailable. Default for all methods.

RPCModeRPC_MODE_ANY_PEER =1

Used withNode.rpc_config() to set a method to be callable remotely by any peer. Analogous to the@rpc("any_peer") annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not.

RPCModeRPC_MODE_AUTHORITY =2

Used withNode.rpc_config() to set a method to be callable remotely only by the current multiplayer authority (which is the server by default). Analogous to the@rpc("authority") annotation. SeeNode.set_multiplayer_authority().

Property Descriptions

MultiplayerPeermultiplayer_peer🔗

• voidset_multiplayer_peer(value:MultiplayerPeer)

• MultiplayerPeerget_multiplayer_peer()

The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check withis_server()) and will set root node's network mode to authority, or it will become a regular client peer. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals.

Method Descriptions

MultiplayerAPIcreate_default_interface()static🔗

Returns a new instance of the default MultiplayerAPI.

StringNameget_default_interface()static🔗

Returns the default MultiplayerAPI implementation class name. This is usually"SceneMultiplayer" whenSceneMultiplayer is available. Seeset_default_interface().

PackedInt32Arrayget_peers()🔗

Returns the peer IDs of all connected peers of this MultiplayerAPI'smultiplayer_peer.

intget_remote_sender_id()🔗

Returns the sender's peer ID for the RPC currently being executed.

Note: This method returns0 when called outside of an RPC. As such, the original peer ID may be lost when code execution is delayed (such as with GDScript'sawait keyword).

intget_unique_id()🔗

Returns the unique peer ID of this MultiplayerAPI'smultiplayer_peer.

boolhas_multiplayer_peer()🔗

Returnstrue if there is amultiplayer_peer set.

boolis_server()🔗

Returnstrue if this MultiplayerAPI'smultiplayer_peer is valid and in server mode (listening for connections).

Errorobject_configuration_add(object:Object, configuration:Variant)🔗

Notifies the MultiplayerAPI of a newconfiguration for the givenobject. This method is used internally bySceneTree to configure the root path for this MultiplayerAPI (passingnull and a validNodePath asconfiguration). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g.SceneMultiplayer) for details on how they use it.

Note: This method is mostly relevant when extending or overriding the MultiplayerAPI behavior viaMultiplayerAPIExtension.

Errorobject_configuration_remove(object:Object, configuration:Variant)🔗

Notifies the MultiplayerAPI to remove aconfiguration for the givenobject. This method is used internally bySceneTree to configure the root path for this MultiplayerAPI (passingnull and an emptyNodePath asconfiguration). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g.SceneMultiplayer) for details on how they use it.

Note: This method is mostly relevant when extending or overriding the MultiplayerAPI behavior viaMultiplayerAPIExtension.

Errorpoll()🔗

Method used for polling the MultiplayerAPI. You only need to worry about this if you setSceneTree.multiplayer_poll tofalse. By default,SceneTree will poll its MultiplayerAPI(s) for you.

Note: This method results in RPCs being called, so they will be executed in the same context of this function (e.g._process,physics,Thread).

Errorrpc(peer:int, object:Object, method:StringName, arguments:Array = [])🔗

Sends an RPC to the targetpeer. The givenmethod will be called on the remoteobject with the providedarguments. The RPC may also be called locally depending on the implementation and RPC configuration. SeeNode.rpc() andNode.rpc_config().

Note: Prefer usingNode.rpc(),Node.rpc_id(), ormy_method.rpc(peer,arg1,arg2,...) (in GDScript), since they are faster. This method is mostly useful in conjunction withMultiplayerAPIExtension when extending or replacing the multiplayer capabilities.

voidset_default_interface(interface_name:StringName)static🔗

Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used bySceneTree when the engine starts.