MultiplayerAPIExtension
Base class used for extending the MultiplayerAPI
.
class MultiplayerAPIExtension
This class can be used to augment or replace the default MultiplayerAPI
implementation via script or extensions.
The following example augment the default implementation (SceneMultiplayer
) by logging every RPC being made, and every object being configured for replication.
Then in your main scene or in an autoload call setMultiplayer(_:rootPath:)
to start using your custom MultiplayerAPI
:
Native extensions can alternatively use the setDefaultInterface(interfaceName:)
method during initialization to configure themselves as the default implementation.
Superclasses
class MultiplayerAPI
High-level multiplayer API interface.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentable
Types that conform to VariantRepresentable can be stored directly in
Variant
with 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 VariantStorable
Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
Show implementation details (9)
Hide implementation details
func _getMultiplayerPeer(
) -> MultiplayerPeer? Called when the
multiplayerPeer
is retrieved.func _getPeerIds(
) -> PackedInt32Array Callback for
getPeers
.func _getRemoteSenderId(
) -> Int32 Callback for
getRemoteSenderId
.func _getUniqueId(
) -> Int32 Callback for
getUniqueId
.func _objectConfigurationAdd(object: Object?, configuration: Variant
) -> GodotError Callback for
objectConfigurationAdd(object:configuration:)
.func _objectConfigurationRemove(object: Object?, configuration: Variant
) -> GodotError Callback for
objectConfigurationRemove(object:configuration:)
.func _poll(
) -> GodotError Callback for
poll
.func _rpc(peer: Int32, object: Object?, method: StringName, args: GArray
) -> GodotError Callback for
rpc(peer:object:method:arguments:)
.func _setMultiplayerPeer(MultiplayerPeer?
) Called when the
multiplayerPeer
is set.