Search Results for

    Show / Hide Table of Contents

    Class NetworkReplicationGridNode

    Network replication hierarchy node with 3D grid spatialization. Organizes static objects into chunks to improve performance in large worlds.

    Inheritance
    Object
    ScriptingObject
    NetworkReplicationNode
    NetworkReplicationGridNode
    Inherited Members
    ScriptingObject::_gcHandle
    ScriptingObject::_id
    ScriptingObject::_type
    ScriptingObject::CanCast(const ScriptingTypeHandle& from, const ScriptingTypeHandle& to)
    ScriptingObject::CanCast(const MClass* from, const MClass* to)
    ScriptingObject::Cast(ScriptingObject* obj)
    ScriptingObject::ChangeID(const Guid& newId)
    ScriptingObject::CreateManaged()
    ScriptingObject::CreateManagedInternal()
    ScriptingObject::Deleted
    Object::DeleteObject(float timeToLive = 0.0f, bool useGameTime=false)
    Object::DeleteObjectNow()
    ScriptingObject::DestroyManaged()
    Object::Flags
    ScriptingObject::FromInterface(void* interfaceObj, const ScriptingTypeHandle& interfaceType)
    ScriptingObject::FromInterface(T* interfaceObj)
    ScriptingObject::GetClass()
    ScriptingObject::GetID()
    ScriptingObject::GetManagedInstance()
    ScriptingObject::GetOrCreateManagedInstance()
    ScriptingObject::GetType()
    ScriptingObject::GetTypeHandle()
    ScriptingObject::HasManagedInstance()
    ScriptingObject::Is(const ScriptingTypeHandle& type)
    ScriptingObject::Is(const MClass* type)
    ScriptingObject::Is()
    ScriptingObject::IsRegistered()
    ScriptingObject::NewObject(const ScriptingTypeHandle& typeHandle)
    ScriptingObject::NewObject()
    ScriptingObject::OnDeleteObject()
    ScriptingObject::OnManagedInstanceDeleted()
    ScriptingObject::OnScriptingDispose()
    ScriptingObject::RegisterObject()
    ScriptingObject::ScriptingObject(const SpawnParams& params)
    ScriptingObject::SetManagedInstance(MObject* instance)
    NetworkReplicationGridNode
    ScriptingObject::ToInterface(ScriptingObject* obj, const ScriptingTypeHandle& interfaceType)
    ScriptingObject::ToInterface(ScriptingObject* obj)
    ScriptingObject::ToManaged(const ScriptingObject* obj)
    ScriptingObject::ToNative(MObject* obj)
    ScriptingObject::ToString()
    ScriptingObject::UnregisterObject()
    Object::~Object()
    ScriptingObject::~ScriptingObject()
    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
    NetworkReplicationNode.AddObject(NetworkReplicationHierarchyObject)

    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
    NetworkReplicationNode.DirtyObject(ScriptingObject *)

    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
    NetworkReplicationNode.GetObject(ScriptingObject *,NetworkReplicationHierarchyObject &)

    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
    NetworkReplicationNode.RemoveObject(ScriptingObject *)

    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
    NetworkReplicationNode.SetObject(const NetworkReplicationHierarchyObject &)

    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.

    Overrides
    NetworkReplicationNode.Update(NetworkReplicationHierarchyUpdateResult *)
    • Improve this Doc
    • View Source
    In This Article
    Back to top Copyright © 2012-2024 Wojciech Figat