AActor::IsMigrationRoot

function Engine Since 5.4

#include "GameFramework/Actor.h"

Access: public Specifiers: virtualoverride

Description

Returns true if this actor is the root object of a Remote Object Handle migration operation — meaning the engine will migrate this actor (and its subobjects) as a unit when transferring between server processes.

Caveats & Gotchas

• Like PostMigrate, this method is only available when UE_WITH_REMOTE_OBJECT_HANDLE is defined. It is part of Unreal's experimental server-mesh / multi-server architecture and is not relevant to standard single-server projects.
• Returning true here causes the engine to treat all subobjects of this actor as part of the same migration group. Returning the wrong value can cause partial migrations that leave dangling cross-object references.

Signature

ENGINE_API virtual bool IsMigrationRoot() const override;

Return Type

bool

Example

Mark a specialized actor as migration root C++

bool AMyNetActor::IsMigrationRoot() const
{
    // This actor owns all the state that must migrate atomically
    return true;
}

Version History

Introduced in: 5.4

Version	Status	Notes
5.6	stable	—

Feedback

Was this helpful?