Enumerationmigueldeicaza.swiftgodot 0.45.0SwiftGodot
VisibilityUpdateMode
MultiplayerSynchronizer.swift:29enum VisibilityUpdateMode
Cases
case idle
Visibility filters are updated during process frames (see
Node
notificationInternalProcess````).case physics
Visibility filters are updated during physics frames (see
Node
notificationInternalPhysicsProcess````).case none
Visibility filters are not updated automatically, and must be updated manually by calling
updateVisibility(forPeer:)
.
Other members in extension
View members
Hide members
This section is hidden by default because it contains too many (16) members.
Types
class Signal1
Signal support.
Type members
Instance members
var deltaInterval: Double
Time interval between delta synchronizations. When set to
0.0
(the default), delta synchronizations happen every network process frame.var deltaSynchronized: SimpleSignal
Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated.
var publicVisibility: Bool
Whether synchronization should be visible to all peers by default. See
setVisibilityFor(peer:visible:)
andaddVisibilityFilter(_:)
for ways of configuring fine-grained visibility options.var replicationConfig: SceneReplicationConfig?
Resource containing which properties to synchronize.
var replicationInterval: Double
Time interval between synchronizations. When set to
0.0
(the default), synchronizations happen every network process frame.var rootPath: NodePath
Node path that replicated properties are relative to.
var synchronized: SimpleSignal
Emitted when a new synchronization state is received by this synchronizer after the properties have been updated.
var visibilityChanged: Signal1
Emitted when visibility of
forPeer
is updated. SeeupdateVisibility(forPeer:)
.var visibilityUpdateMode: MultiplayerSynchronizer.VisibilityUpdateMode
Specifies when visibility filters are updated (see
VisibilityUpdateMode
for options).func addVisibilityFilter(Callable
) Adds a peer visibility filter for this synchronizer.
func getVisibilityFor(peer: Int32
) -> Bool Queries the current visibility for peer
peer
.func removeVisibilityFilter(Callable
) Removes a peer visibility filter from this synchronizer.
func setVisibilityFor(peer: Int32, visible: Bool
) Sets the visibility of
peer
tovisible
. Ifpeer
is0
, the value ofpublicVisibility
will be updated instead.func updateVisibility(forPeer: Int32
) Updates the visibility of
forPeer
according to visibility filters. IfforPeer
is0
(the default), all peers’ visibilties are updated.
Citizens in SwiftGodot
Conformances
protocol CaseIterable
A type that provides a collection of all of its values.
protocol CustomDebugStringConvertible
A type with a customized textual representation suitable for debugging purposes.
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 RawRepresentable<RawValue>
A type that can be converted to and from an associated raw value.
Type members
Instance members
var debugDescription: String
A textual representation of this instance, suitable for debugging
Type features
static func != (lhs: Self, rhs: Self
) -> Bool Returns a Boolean value indicating whether two values are not equal.