Class SceneReplicationConfig

Configuration for properties to synchronize with a MultiplayerSynchronizer.

Inheritance

Resource

RefCounted

Object

SceneReplicationConfig

Methods

add_property(NodePath, int)

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.

void add_property(NodePath path, int index)

Parameters

path NodePath

index int

get_properties

Qualifiers: const

Returns a list of synchronized property NodePaths.

NodePath[] get_properties

has_property(NodePath)

Qualifiers: const

Returns true if the given path is configured for synchronization.

bool has_property(NodePath path)

Parameters

path NodePath

property_get_index(NodePath)

Qualifiers: const

Finds the index of the given path.

int property_get_index(NodePath path)

Parameters

path NodePath

property_get_replication_mode(NodePath)

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

int property_get_replication_mode(NodePath path)

Parameters

path NodePath

property_get_spawn(NodePath)

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

bool property_get_spawn(NodePath path)

Parameters

path NodePath

property_get_sync(NodePath)

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

bool property_get_sync(NodePath path)

Parameters

path NodePath

property_get_watch(NodePath)

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

bool property_get_watch(NodePath path)

Parameters

path NodePath

property_set_replication_mode(NodePath, int)

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

void property_set_replication_mode(NodePath path, int mode)

Parameters

path NodePath

mode int

property_set_spawn(NodePath, bool)

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

void property_set_spawn(NodePath path, bool enabled)

Parameters

path NodePath

enabled bool

property_set_sync(NodePath, bool)

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

void property_set_sync(NodePath path, bool enabled)

Parameters

path NodePath

enabled bool

property_set_watch(NodePath, bool)

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

void property_set_watch(NodePath path, bool enabled)

Parameters

path NodePath

enabled bool

remove_property(NodePath)

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

void remove_property(NodePath path)

Parameters

path NodePath