UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
FMassEntityHandle Struct Reference

#include <MassEntityHandle.h>

Public Member Functions

 FMassEntityHandle ()=default
 
 FMassEntityHandle (const int32 InIndex, const int32 InSerialNumber)
 
bool operator== (const FMassEntityHandle Other) const
 
bool operator!= (const FMassEntityHandle Other) const
 
bool operator< (const FMassEntityHandle Other) const
 
bool IsSet () const
 
bool IsValid () const
 
void Reset ()
 
uint64 AsNumber () const
 
FString DebugGetDescription () const
 

Static Public Member Functions

static FMassEntityHandle FromNumber (uint64 Value)
 

Public Attributes

int32 Index = 0
 
int32 SerialNumber = 0
 

Friends

uint32 GetTypeHash (const FMassEntityHandle Entity)
 
FString LexToString (const FMassEntityHandle Entity)
 

Detailed Description

A handle to a Mass entity. An entity is used in conjunction with the FMassEntityManager for the current world and can contain lightweight fragments.

Constructor & Destructor Documentation

◆ FMassEntityHandle() [1/2]

FMassEntityHandle::FMassEntityHandle ( )
default

◆ FMassEntityHandle() [2/2]

FMassEntityHandle::FMassEntityHandle ( const int32  InIndex,
const int32  InSerialNumber 
)
inline

Member Function Documentation

◆ AsNumber()

uint64 FMassEntityHandle::AsNumber ( ) const
inline

Allows the entity handle to be shared anonymously.

◆ DebugGetDescription()

FString FMassEntityHandle::DebugGetDescription ( ) const
inline

◆ FromNumber()

static FMassEntityHandle FMassEntityHandle::FromNumber ( uint64  Value)
inlinestatic

Reconstruct the entity handle from an anonymously shared integer.

◆ IsSet()

bool FMassEntityHandle::IsSet ( ) const
inline

Note that this function is merely checking if Index and SerialNumber are set. There's no way to validate if these indicate a valid entity in an EntitySubsystem without asking the system.

◆ IsValid()

bool FMassEntityHandle::IsValid ( ) const
inline

◆ operator!=()

bool FMassEntityHandle::operator!= ( const FMassEntityHandle  Other) const
inline

◆ operator<()

bool FMassEntityHandle::operator< ( const FMassEntityHandle  Other) const
inline

Has meaning only for sorting purposes

◆ operator==()

bool FMassEntityHandle::operator== ( const FMassEntityHandle  Other) const
inline

◆ Reset()

void FMassEntityHandle::Reset ( )
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FMassEntityHandle  Entity)
friend

◆ LexToString

FString LexToString ( const FMassEntityHandle  Entity)
friend

Member Data Documentation

◆ Index

int32 FMassEntityHandle::Index = 0

◆ SerialNumber

int32 FMassEntityHandle::SerialNumber = 0
The documentation for this struct was generated from the following file: