FMassRelationRoleInstanceHandle Struct Reference

#include <MassEntityRelations.h>

Classes
struct	FMassRelationRoleInstanceHandleFinder

Public Member Functions
	FMassRelationRoleInstanceHandle ()=default
int32	GetRoleEntityIndex () const
MASSENTITY_API FMassEntityHandle	GetRoleEntityHandle (const FMassEntityManager &EntityManager) const
int32	GetRelationEntityIndex () const
MASSENTITY_API FMassEntityHandle	GetRelationEntityHandle (const FMassEntityManager &EntityManager) const
UE::Mass::Relations::ERelationRole	GetRole () const
FString	DebugGetDescription () const
bool	IsValid () const =delete
bool	operator== (const FMassRelationRoleInstanceHandle &Other) const

Static Public Member Functions
static FMassRelationRoleInstanceHandle	Create (UE::Mass::Relations::ERelationRole Role, const FMassEntityHandle RoleHandle, const FMassEntityHandle RelationEntityHandle)

Static Public Attributes
static constexpr int32	EntityIndexBits = 30
static constexpr int32	EntityIndexMask = (1 << 30) - 1
static constexpr int32	TypeMask = ~EntityIndexMask

Friends
FString	LexToString (const FMassRelationRoleInstanceHandle Handle)

Detailed Description

Constructor & Destructor Documentation

FMassRelationRoleInstanceHandle()

FMassRelationRoleInstanceHandle::FMassRelationRoleInstanceHandle ( )

default

Member Function Documentation

Create()

static FMassRelationRoleInstanceHandle FMassRelationRoleInstanceHandle::Create ( UE::Mass::Relations::ERelationRole  Role, const FMassEntityHandle  RoleHandle, const FMassEntityHandle  RelationEntityHandle  )

inlinestatic

DebugGetDescription()

FString FMassRelationRoleInstanceHandle::DebugGetDescription ( ) const

inline

GetRelationEntityHandle()

FMassEntityHandle FMassRelationRoleInstanceHandle::GetRelationEntityHandle

(

const FMassEntityManager &

EntityManager

)

const

GetRelationEntityIndex()

int32 FMassRelationRoleInstanceHandle::GetRelationEntityIndex ( ) const

inline

GetRole()

UE::Mass::Relations::ERelationRole FMassRelationRoleInstanceHandle::GetRole ( ) const

inline

GetRoleEntityHandle()

FMassEntityHandle FMassRelationRoleInstanceHandle::GetRoleEntityHandle

(

const FMassEntityManager &

EntityManager

)

const

GetRoleEntityIndex()

int32 FMassRelationRoleInstanceHandle::GetRoleEntityIndex ( ) const

inline

IsValid()

bool FMassRelationRoleInstanceHandle::IsValid ( ) const

delete

We're unable to tell if a given relation instance handle is valid just by looking at a handle. Only the RelationManager can answer this question. Use IsSet as first filter

operator==()

bool FMassRelationRoleInstanceHandle::operator== ( const FMassRelationRoleInstanceHandle &  Other ) const

inline

Friends And Related Symbol Documentation

LexToString

FString LexToString ( const FMassRelationRoleInstanceHandle  Handle )

friend

Member Data Documentation

EntityIndexBits

constexpr int32 FMassRelationRoleInstanceHandle::EntityIndexBits = 30

staticconstexpr

EntityIndexMask

constexpr int32 FMassRelationRoleInstanceHandle::EntityIndexMask = (1 << 30) - 1

staticconstexpr

TypeMask

constexpr int32 FMassRelationRoleInstanceHandle::TypeMask = ~EntityIndexMask

staticconstexpr

---

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

• Engine/Source/Runtime/MassEntity/Public/MassEntityRelations.h
• Engine/Source/Runtime/MassEntity/Private/MassEntityRelations.cpp