Class NetworkReplicationGridNode
Network replication hierarchy node with 3D grid spatialization. Organizes static objects into chunks to improve performance in large worlds.
Inherited Members
Assembly: FlaxEngine.dll
File: Engine/Networking/NetworkReplicationHierarchy.h
Syntax
public class NetworkReplicationGridNode : public NetworkReplicationNode
Fields
CellSize
Size of the grid cell (in world units). Used to chunk the space for separate nodes.
Declaration
public float CellSize = 10000.0f
Field Value
float
|
Methods
AddObject(NetworkReplicationHierarchyObject obj)
Adds an object into the hierarchy.
Declaration
public virtual void AddObject(NetworkReplicationHierarchyObject obj) override
Parameters
NetworkReplicationHierarchyObject
obj
The object to add. |
Overrides
DirtyObject(ScriptingObject* obj)
Force replicates the object during the next update. Resets any internal tracking state to force the synchronization.
Declaration
public virtual bool DirtyObject(ScriptingObject* obj) override
Parameters
ScriptingObject
obj
The object to update. |
Returns
bool
True on successful update, otherwise false. |
Overrides
GetObject(ScriptingObject* obj, NetworkReplicationHierarchyObject& result)
Gets object from the hierarchy.
Declaration
public virtual bool GetObject(ScriptingObject* obj, NetworkReplicationHierarchyObject& result) override
Parameters
ScriptingObject
obj
The object to get. |
NetworkReplicationHierarchyObject
result
The hierarchy object to retrieve. |
Returns
bool
True on successful retrieval, otherwise false. |
Overrides
RemoveObject(ScriptingObject* obj)
Removes object from the hierarchy.
Declaration
public virtual bool RemoveObject(ScriptingObject* obj) override
Parameters
ScriptingObject
obj
The object to remove. |
Returns
bool
True on successful removal, otherwise false. |
Overrides
SetObject(const NetworkReplicationHierarchyObject& value)
Sets object properties in the hierarchy. Can be used to modify replication settings at runtime.
Declaration
public virtual bool SetObject(const NetworkReplicationHierarchyObject& value) override
Parameters
NetworkReplicationHierarchyObject
value
The object data to update. |
Returns
bool
True on successful update, otherwise false (eg, if specific object has not been added to this node). |
Overrides
Update(NetworkReplicationHierarchyUpdateResult* result)
Iterates over all objects and adds them to the replication work.
Declaration
public virtual void Update(NetworkReplicationHierarchyUpdateResult* result) override
Parameters
NetworkReplicationHierarchyUpdateResult
result
The update results container. |