FRelationManager

API > API/Runtime > API/Runtime/MassEntity

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

Syntax

struct FRelationManager

Constructors

Name Remarks Include Path Unreal Specifiers

FRelationManager ( FMassEntityManager& EntityManager
)

   MassRelationManager.h  

Structs

Name Remarks
FHierarchyEntitiesContainer  

Functions

Public

Name Remarks Include Path Unreal Specifiers
  MassRelationManager.h  
INLINES. MassRelationManager.h  
Creates valid relation instances of type RelationTypeHandle, binding Subjects and Objects Note that the input arrays can have their order modified by the function, all the relation pairs that are not valid, are moved to the back of the arrays The number of elements in Subjects and Objects must match. MassRelationManager.h  
Creates a relation type handle with RelationType, and calls the other CreateRelationInstances implementation MassRelationManager.h  
  MassRelationManager.h  

bool DestroyRelationInstance ( const FTypeHandle RelationTypeHandle,
const FMassEntityHandle Subject,
const FMassEntityHandle Object
)

   MassRelationManager.h  

void ForEachRelationObject ( const FTypeHandle RelationTypeHandle,
FMassEntityHandle SubjectEntity,
TFunctionRef< void(FMassEntityHandle)> Callback
) const

 Callback-based enumeration of objects for a given subject in a relation. Zero allocation. MassRelationManager.h  

void ForEachRelationSubject ( const FTypeHandle RelationTypeHandle,
FMassEntityHandle ObjectEntity,
TFunctionRef< void(FMassEntityHandle)> Callback
) const

 Callback-based enumeration of subjects for a given object in a relation. Zero allocation. MassRelationManager.h  

const FRelationData & GetRelationDataChecked ( const FTypeHandle RelationTypeHandle
) const

   MassRelationManager.h  

FRelationData & GetRelationDataChecked ( const FTypeHandle RelationTypeHandle
)

   MassRelationManager.h  

void GetRelationEntities ( TConstArrayView< FMassRelationRoleInstanceHandle > RelationEntitiesContainer,
TArray< FMassEntityHandle >& InOutEntityHandles
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationEntities ( TConstArrayView< FMassRelationRoleInstanceHandle > RelationEntitiesContainer
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationObjects ( const FTypeHandle RelationTypeHandle,
const FMassEntityHandle SubjectEntity
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationObjects ( TNotNull< const UScriptStruct* > RelationType,
const FMassEntityHandle SubjectEntity
) const

 Fetch all the entities that are "objects" in instances of the given relation type, where SubjectEntity is the "subject" of the relation MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationSubjects ( TNotNull< const UScriptStruct* > RelationType,
const FMassEntityHandle ObjectEntity
) const

 Fetch all the entities that are "subjects" in instances of the given relation type, where ObjectEntity is the "object" of the relation MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationSubjects ( const FTypeHandle RelationTypeHandle,
const FMassEntityHandle ObjectEntity
) const

   MassRelationManager.h  

FTypeHandle GetRelationTypeHandle ( TNotNull< const UScriptStruct* > RelationType
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRoleEntities ( TConstArrayView< FMassRelationRoleInstanceHandle > RelationEntitiesContainer
) const

   MassRelationManager.h  

void GetRoleEntities ( TConstArrayView< FMassRelationRoleInstanceHandle > RelationEntitiesContainer,
TArray< FMassEntityHandle >& InOutEntityHandles
) const

   MassRelationManager.h  

bool HasRelationObjects ( const FTypeHandle RelationTypeHandle,
FMassEntityHandle SubjectEntity
) const

 Returns true if SubjectEntity has at least one object in this relation type. No allocation. MassRelationManager.h  

bool HasRelationSubjects ( const FTypeHandle RelationTypeHandle,
FMassEntityHandle ObjectEntity
) const

 Returns true if ObjectEntity has at least one subject in this relation type. No allocation. MassRelationManager.h  

bool IsSubjectOfRelation ( const FTypeHandle RelationTypeHandle,
const FMassEntityHandle Subject,
const FMassEntityHandle Object
) const

   MassRelationManager.h  

bool IsSubjectOfRelation ( const FRelationData& RelationDataInstance,
const FMassEntityHandle Subject,
const FMassEntityHandle Object
) const

   MassRelationManager.h  

bool IsSubjectOfRelationRecursive ( const FTypeHandle RelationTypeHandle,
const FMassEntityHandle Subject,
const FMassEntityHandle Object
) const

   MassRelationManager.h  

bool IsSubjectOfRelationRecursive ( const FRelationData& RelationDataInstance,
const FMassEntityHandle Subject,
const FMassEntityHandle Object
) const

   MassRelationManager.h  

void OnRelationTypeRegistered ( const FTypeHandle RegisteredTypeHandle,
const FRelationTypeTraits& RelationTypeTraits
)

   MassRelationManager.h  

Protected

Name Remarks Include Path Unreal Specifiers

FRelationData & CreateRelationData ( const FTypeHandle RelationTypeHandle
)

   MassRelationManager.h  

void GatherHierarchy ( const FRelationData& RelationData,
const FMassEntityHandle SubjectHandle,
FHierarchyEntitiesContainer& SubSubjects,
uint32 Depth
) const

   MassRelationManager.h  

const FRelationData * GetRelationData ( const FTypeHandle RelationTypeHandle
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationObjects ( const FRelationData& RelationData,
const FMassEntityHandle SubjectEntity
) const

   MassRelationManager.h  

TArray< FMassEntityHandle > GetRelationSubjects ( const FRelationData& RelationData,
const FMassEntityHandle ObjectEntity
) const

   MassRelationManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page