UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::Mass::Relations Namespace Reference

Namespaces

namespace  Private
 

Classes

struct  FChildOfRelationTypeInitializer
 
struct  FRelationTypeTraits
 
struct  FRoleTraits
 

Enumerations

enum class  ERemovalPolicy : uint8 {
  CleanUp , Destroy , Splice , Custom ,
  MAX , Default = CleanUp
}
 
enum class  EExternalMappingRequired : uint8 { No , Yes , Default = Yes }
 
enum class  ERelationRole : uint8 { Subject , Object , MAX }
 

Functions

void RegisterChildOfRelation ()
 
FString LexToString (const ERelationRole Value)
 

Variables

FTypeHandle ChildOfHandle
 

Enumeration Type Documentation

◆ EExternalMappingRequired

Enumerator
No 
Yes 
Default 

◆ ERelationRole

Enumerator
Subject 
Object 
MAX 

◆ ERemovalPolicy

Enumerator
CleanUp 

only update the book-keeping

Destroy 

when a given relation gets removed destroy the source entity (eg destroy the child when ChildOf relation gets removed)

Splice 

external code will be called to patch up what remains off the relation

Custom 

the user will provide the observer processor

MAX 
Default 

Function Documentation

◆ LexToString()

FString UE::Mass::Relations::LexToString ( const ERelationRole  Value)
inline

◆ RegisterChildOfRelation()

UE_API void UE::Mass::Relations::RegisterChildOfRelation ( )

Variable Documentation

◆ ChildOfHandle

UE_API FTypeHandle UE::Mass::Relations::ChildOfHandle