Class NetworkReplicationNode
Base class for the network objects replication hierarchy nodes. Contains a list of objects.
Namespace: FlaxEngine.Networking
Assembly: FlaxEngine.CSharp.dll
Syntax
[Unmanaged]
public abstract class NetworkReplicationNode : Object
Constructors
NetworkReplicationNode()
Initializes a new instance of the NetworkReplicationNode.
Declaration
protected NetworkReplicationNode()
Properties
Objects
List with objects stored in this node.
Declaration
[Unmanaged]
public NetworkReplicationHierarchyObject[] Objects { get; set; }
Property Value
NetworkReplicationHierarchyObject[]
|
Methods
AddObject(NetworkReplicationHierarchyObject)
Adds an object into the hierarchy.
Declaration
[Unmanaged]
public virtual void AddObject(NetworkReplicationHierarchyObject obj)
Parameters
NetworkReplicationHierarchyObject
obj
The object to add. |
DirtyObject(Object)
Force replicates the object during the next update. Resets any internal tracking state to force the synchronization.
Declaration
[Unmanaged]
public virtual bool DirtyObject(Object obj)
Parameters
Object
obj
The object to update. |
Returns
System.Boolean
True on successful update, otherwise false. |
GetObject(Object, NetworkReplicationHierarchyObject)
Gets object from the hierarchy.
Declaration
[Unmanaged]
public virtual bool GetObject(Object obj, NetworkReplicationHierarchyObject result)
Parameters
Object
obj
The object to get. |
NetworkReplicationHierarchyObject
result
The hierarchy object to retrieve. |
Returns
System.Boolean
True on successful retrieval, otherwise false. |
RemoveObject(Object)
Removes object from the hierarchy.
Declaration
[Unmanaged]
public virtual bool RemoveObject(Object obj)
Parameters
Object
obj
The object to remove. |
Returns
System.Boolean
True on successful removal, otherwise false. |
Update(NetworkReplicationHierarchyUpdateResult)
Iterates over all objects and adds them to the replication work.
Declaration
[Unmanaged]
public virtual void Update(NetworkReplicationHierarchyUpdateResult result)
Parameters
NetworkReplicationHierarchyUpdateResult
result
The update results container. |