MultiplayerAPI
High-level multiplayer API interface.
MultiplayerAPI.swift:27class MultiplayerAPIBase class for high-level multiplayer API implementations. See also MultiplayerPeer.
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 the setMultiplayer(_:rootPath:) 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. See MultiplayerAPIExtension for details about extensions, SceneMultiplayer for the details about the default implementation.
This object emits the following signals:
Superclasses
class RefCountedBase class for reference-counted objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Types
enum RPCModeclass Signal1Signal support.
class Signal2Signal support.
Type members
static func createDefaultInterface() -> MultiplayerAPI? Returns a new instance of the default MultiplayerAPI.
static func getDefaultInterface() -> StringName Returns the default MultiplayerAPI implementation class name. This is usually
"SceneMultiplayer"whenSceneMultiplayeris available. SeesetDefaultInterface(interfaceName:).static func setDefaultInterface(interfaceName: StringName) Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by
SceneTreewhen the engine starts.class var godotClassName: StringName
Instance members
var connectedToServer: SimpleSignalEmitted when this MultiplayerAPI’s
multiplayerPeersuccessfully connected to a server. Only emitted on clients.var connectionFailed: SimpleSignalEmitted when this MultiplayerAPI’s
multiplayerPeerfails to establish a connection to a server. Only emitted on clients.var multiplayerPeer: MultiplayerPeer?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 with
isServer) 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.var peerConnected: Signal1Emitted when this MultiplayerAPI’s
multiplayerPeerconnects 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).var peerDisconnected: Signal2Emitted when this MultiplayerAPI’s
multiplayerPeerdisconnects from a peer. Clients get notified when other clients disconnect from the same server.var serverDisconnected: SimpleSignalEmitted when this MultiplayerAPI’s
multiplayerPeerdisconnects from server. Only emitted on clients.func getPeers() -> PackedInt32Array Returns the peer IDs of all connected peers of this MultiplayerAPI’s
multiplayerPeer.func getRemoteSenderId() -> Int32 Returns the sender’s peer ID for the RPC currently being executed.
func getUniqueId() -> Int32 Returns the unique peer ID of this MultiplayerAPI’s
multiplayerPeer.func hasMultiplayerPeer() -> Bool Returns
trueif there is amultiplayerPeerset.func isServer() -> Bool Returns
trueif this MultiplayerAPI’smultiplayerPeeris valid and in server mode (listening for connections).func objectConfigurationAdd(object: Object?, configuration: Variant) -> GodotError Notifies the MultiplayerAPI of a new
configurationfor the givenobject. This method is used internally bySceneTreeto configure the root path for this MultiplayerAPI (passingnulland a validNodePathasconfiguration). 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.func objectConfigurationRemove(object: Object?, configuration: Variant) -> GodotError Notifies the MultiplayerAPI to remove a
configurationfor the givenobject. This method is used internally bySceneTreeto configure the root path for this MultiplayerAPI (passingnulland an emptyNodePathasconfiguration). 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.func poll() -> GodotError Method used for polling the MultiplayerAPI. You only need to worry about this if you set
multiplayerPolltofalse. By default,SceneTreewill poll its MultiplayerAPI(s) for you.func rpc(peer: Int32, object: Object?, method: StringName, arguments: GArray) -> GodotError Sends an RPC to the target
peer. The givenmethodwill be called on the remoteobjectwith the providedarguments. The RPC may also be called locally depending on the implementation and RPC configuration. SeeNode/rpc(method:)andrpcConfig(method:config:).
Subclasses
class MultiplayerAPIExtensionBase class used for extending the
MultiplayerAPI.class SceneMultiplayerHigh-level multiplayer API implementation.