SceneReplicationConfig
Configuration for properties to synchronize with a MultiplayerSynchronizer
.
class SceneReplicationConfig
Superclasses
class Resource
Base class for serializable objects.
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.
Types
Type members
Instance members
func addProperty(path: NodePath, index: Int32
) Adds the property identified by the given
path
to the list of the properties being synchronized, optionally passing anindex
.func getProperties(
) -> VariantCollection<NodePath> Returns a list of synchronized property
NodePath
s.func hasProperty(path: NodePath
) -> Bool Returns whether the given
path
is configured for synchronization.func propertyGetIndex(path: NodePath
) -> Int32 Finds the index of the given
path
.func propertyGetReplicationMode(path: NodePath
) -> SceneReplicationConfig.ReplicationMode Returns the replication mode for the property identified by the given
path
. SeeReplicationMode
.func propertyGetSpawn(path: NodePath
) -> Bool Returns whether the property identified by the given
path
is configured to be synchronized on spawn.func propertyGetSync(path: NodePath
) -> Bool Returns whether the property identified by the given
path
is configured to be synchronized on process.func propertyGetWatch(path: NodePath
) -> Bool Returns whether the property identified by the given
path
is configured to be reliably synchronized when changes are detected on process.func propertySetReplicationMode(path: NodePath, mode: SceneReplicationConfig.ReplicationMode
) Sets the synchronization mode for the property identified by the given
path
. SeeReplicationMode
.func propertySetSpawn(path: NodePath, enabled: Bool
) Sets whether the property identified by the given
path
is configured to be synchronized on spawn.func propertySetSync(path: NodePath, enabled: Bool
) Sets whether the property identified by the given
path
is configured to be synchronized on process.func propertySetWatch(path: NodePath, enabled: Bool
) Sets whether the property identified by the given
path
is configured to be reliably synchronized when changes are detected on process.func removeProperty(path: NodePath
) Removes the property identified by the given
path
from the configuration.