UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FUObjectMigrationContext Struct Referencefinal

#include <UObjectMigrationContext.h>

Public Member Functions

UE_API bool IsValid () const
 
UE_API EObjectMigrationRecvType GetObjectMigrationRecvType (const UObjectBase *Object) const
 
UE_API EObjectMigrationRecvType GetObjectMigrationRecvType (FRemoteObjectId ObjectId) const
 
UE_API EObjectMigrationSendType GetObjectMigrationSendType (const UObjectBase *Object) const
 
UE_API EObjectMigrationSendType GetObjectMigrationSendType (FRemoteObjectId ObjectId) const
 

Static Public Member Functions

static const FUObjectMigrationContext *const GetCurrentMigrationContext ()
 

Public Attributes

FRemoteObjectId ObjectId
 
FRemoteServerId RemoteServerId
 
FRemoteServerId OwnerServerId
 
FRemoteServerId PhysicsServerId
 
uint32 PhysicsLocalIslandId
 
EObjectMigrationSide MigrationSide = EObjectMigrationSide::Receive
 
FRemoteTransactionId MultiServerCommitRequestId
 

Friends

struct FScopedObjectMigrationContext
 

Detailed Description

Structure that holds context for what we're intending to do during migration

Member Function Documentation

◆ GetCurrentMigrationContext()

static const FUObjectMigrationContext *const FUObjectMigrationContext::GetCurrentMigrationContext ( )
inlinestatic

Gets the current Migration Context if it exists (only exists during actual object migrations)

◆ GetObjectMigrationRecvType() [1/2]

EObjectMigrationRecvType FUObjectMigrationContext::GetObjectMigrationRecvType ( const UObjectBase Object) const

During migration, figure out the role of the object being received

◆ GetObjectMigrationRecvType() [2/2]

EObjectMigrationRecvType FUObjectMigrationContext::GetObjectMigrationRecvType ( FRemoteObjectId  ObjectId) const

◆ GetObjectMigrationSendType() [1/2]

EObjectMigrationSendType FUObjectMigrationContext::GetObjectMigrationSendType ( const UObjectBase Object) const

During migration, figure out the role of the object being sent

◆ GetObjectMigrationSendType() [2/2]

EObjectMigrationSendType FUObjectMigrationContext::GetObjectMigrationSendType ( FRemoteObjectId  ObjectId) const

◆ IsValid()

bool FUObjectMigrationContext::IsValid ( ) const

Are the values of this context valid?

Friends And Related Symbol Documentation

◆ FScopedObjectMigrationContext

Member Data Documentation

◆ MigrationSide

EObjectMigrationSide FUObjectMigrationContext::MigrationSide = EObjectMigrationSide::Receive

Which side of the migration does this context apply to? Sending or Receiving?

◆ MultiServerCommitRequestId

FRemoteTransactionId FUObjectMigrationContext::MultiServerCommitRequestId

If valid, the request id of the multi-server commit

◆ ObjectId

FRemoteObjectId FUObjectMigrationContext::ObjectId

The Object that is being migrated, it may not be the top-level UObject

◆ OwnerServerId

FRemoteServerId FUObjectMigrationContext::OwnerServerId

The (New) Owner of the ObjectId as a result of this migration

◆ PhysicsLocalIslandId

uint32 FUObjectMigrationContext::PhysicsLocalIslandId

The Local Island Index the Object belongs to for Physics

◆ PhysicsServerId

FRemoteServerId FUObjectMigrationContext::PhysicsServerId

The Server that this Object's Physics reside on

◆ RemoteServerId

FRemoteServerId FUObjectMigrationContext::RemoteServerId

The ServerId on the other side of the migration


The documentation for this struct was generated from the following files: