SceneReplicationConfig — C# API

class SceneReplicationConfigReckfellSharpInherits Resource

Configuration for properties to synchronize with a MultiplayerSynchronizer.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

SceneReplicationConfigConstructor

C#
public SceneReplicationConfig();

Methods13

AddPropertyvoid

# AddProperty

C#
public void AddProperty(EntityPath path, int index = -1);

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.

Parameters
Name	Type	Default
`path`	`EntityPath`	—
`index`	`int`	`-1`

GetPropertiesReckfell.Collections.Array<EntityPath>

# GetProperties

C#
public Reckfell.Collections.Array<EntityPath> GetProperties();

Returns a list of synchronized property EntityPaths.

Returns Reckfell.Collections.Array<EntityPath>

HasPropertybool

# HasProperty

C#
public bool HasProperty(EntityPath path);

Returns true if the given path is configured for synchronization.

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns bool

PropertyGetIndexint

# PropertyGetIndex

C#
public int PropertyGetIndex(EntityPath path);

Finds the index of the given path.

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns int

PropertyGetReplicationModeSceneReplicationConfig.ReplicationMode

# PropertyGetReplicationMode

C#
public SceneReplicationConfig.ReplicationMode PropertyGetReplicationMode(EntityPath path);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns SceneReplicationConfig.ReplicationMode

PropertyGetSpawnbool

# PropertyGetSpawn

C#
public bool PropertyGetSpawn(EntityPath path);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns bool

PropertyGetSyncbool · Deprecated

# PropertyGetSync

C#
public bool PropertyGetSync(EntityPath path);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns bool

PropertyGetWatchbool · Deprecated

# PropertyGetWatch

C#
public bool PropertyGetWatch(EntityPath path);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—

Returns bool

PropertySetReplicationModevoid

# PropertySetReplicationMode

C#
public void PropertySetReplicationMode(EntityPath path, SceneReplicationConfig.ReplicationMode mode);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—
`mode`	`SceneReplicationConfig.ReplicationMode`	—

PropertySetSpawnvoid

# PropertySetSpawn

C#
public void PropertySetSpawn(EntityPath path, bool enabled);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—
`enabled`	`bool`	—

PropertySetSyncvoid · Deprecated

# PropertySetSync

C#
public void PropertySetSync(EntityPath path, bool enabled);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—
`enabled`	`bool`	—

PropertySetWatchvoid · Deprecated

# PropertySetWatch

C#
public void PropertySetWatch(EntityPath path, bool enabled);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—
`enabled`	`bool`	—

RemovePropertyvoid

# RemoveProperty

C#
public void RemoveProperty(EntityPath path);

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

Parameters
Name	Type	Default
`path`	`EntityPath`	—

SceneReplicationConfig.ReplicationMode

Value	Description
`Always = 1`	Replicate the given property on process by constantly sending updates using unreliable transfer mode.
`Never = 0`	Do not keep the given property synchronized.
`OnChange = 2`	Replicate the given property on process by sending updates using reliable transfer mode when its value changes.