1. Epic GamesDeveloper
  3. FRelationTypeTraits

FRelationTypeTraits

API > API/Runtime > API/Runtime/MassEntity

   
Name FRelationTypeTraits
Type struct
Header File /Engine/Source/Runtime/MassEntity/Public/MassEntityRelations.h
Include Path #include "MassEntityRelations.h"

Syntax

struct FRelationTypeTraits

Constructors

Name Remarks Include Path Unreal Specifiers

FRelationTypeTraits ( TNotNull< const UScriptStruct* > InRelationTagType
)

   MassEntityRelations.h  
  MassEntityRelations.h  

FRelationTypeTraits ( const FRelationTypeTraits& Other,
TNotNull< const UScriptStruct* > NewRelationTagType
)

   MassEntityRelations.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bCreateRelationEntitiesInHierarchy bool Whether to use hierarchical archetype groups for the relation entities Set this to true of you want to do any data calculations with data stored in the relation entities, and them being processed in hierarchy order being a requirements MassEntityRelations.h  
bHierarchical bool   MassEntityRelations.h  
ObjectEntityDestructionObserverClass TWeakObjectPtr< UClass >   MassEntityRelations.h  
RegisteredGroupType FArchetypeGroupType   MassEntityRelations.h  
RegisterObserversDelegate TFunction< bool(FMassEntityManager &)> Is set, gets called upon type's registration to register appropriate observers. MassEntityRelations.h  
RelationEntityCreationObserverClass TWeakObjectPtr< UClass > Processor classes to be instantiated when the relation type gets registered. MassEntityRelations.h  
RelationEntityDestructionObserverClass TWeakObjectPtr< UClass >   MassEntityRelations.h  
RelationFragmentType TNotNull< const UScriptStruct * > The fragment type that will be automatically added to each relation entity created to represent relation instances MassEntityRelations.h  
RelationName FName   MassEntityRelations.h  
RoleTraits TStaticArray< FRoleTraits, static_cast< uint8 >(ERelationRole::MAX)>   MassEntityRelations.h  
SubjectEntityDestructionObserverClass TWeakObjectPtr< UClass >   MassEntityRelations.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
DebugInFix FString   MassEntityRelations.h  
RelationTagType TNotNull< const UScriptStruct * > Can only be set during creation since we use the same type to create UE::Mass::FTypeHandle for the relation type MassEntityRelations.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FString DebugDescribeRelation ( FMassEntityHandle A,
FMassEntityHandle B
) const

   MassEntityRelations.h  

FName GetFName()

   MassEntityRelations.h  

TNotNull< const UScriptStruct * > GetRelationTagType()

   MassEntityRelations.h  

bool IsValid()

 Checks whether the traits are configured properly. MassEntityRelations.h  

void SetDebugInFix ( FString&& InFix
)

   MassEntityRelations.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page