Index · Object → RefCounted → Resource → SceneReplicationConfig

SceneReplicationConfig

Configuration for properties to synchronize with a MultiplayerSynchronizer.

Properties

Inherited from Resource (4)

Methods

func add_property(path: NodePath, index: int = -1) -> void

Adds the property identified by the given path to the list of the properties being synchronized, optionally passing an index.

Note: For details on restrictions and limitations on property synchronization, see MultiplayerSynchronizer.

func get_properties() -> NodePath[]

Returns a list of synchronized property NodePaths.

func has_property(path: NodePath) -> bool

Returns true if the given path is configured for synchronization.

func property_get_index(path: NodePath) -> int

Finds the index of the given path.

func property_get_replication_mode(path: NodePath) -> SceneReplicationConfig.ReplicationMode

Returns the replication mode for the property identified by the given path.

func property_get_spawn(path: NodePath) -> bool

Returns true if the property identified by the given path is configured to be synchronized on spawn.

func property_get_sync(path: NodePath) -> bool

Returns true if the property identified by the given path is configured to be synchronized on process.

func property_get_watch(path: NodePath) -> bool

Returns true if the property identified by the given path is configured to be reliably synchronized when changes are detected on process.

func property_set_replication_mode(path: NodePath, mode: SceneReplicationConfig.ReplicationMode) -> void

Sets the synchronization mode for the property identified by the given path.

func property_set_spawn(path: NodePath, enabled: bool) -> void

Sets whether the property identified by the given path is configured to be synchronized on spawn.

func property_set_sync(path: NodePath, enabled: bool) -> void

Sets whether the property identified by the given path is configured to be synchronized on process.

func property_set_watch(path: NodePath, enabled: bool) -> void

Sets whether the property identified by the given path is configured to be reliably synchronized when changes are detected on process.

func remove_property(path: NodePath) -> void

Removes the property identified by the given path from the configuration.

Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)

Enums & Constants

enum ReplicationMode
REPLICATION_MODE_NEVER = 0

Do not keep the given property synchronized.

REPLICATION_MODE_ALWAYS = 1

Replicate the given property on process by constantly sending updates using unreliable transfer mode.

REPLICATION_MODE_ON_CHANGE = 2

Replicate the given property on process by sending updates using reliable transfer mode when its value changes.