Navigation
API > API/Runtime > API/Runtime/MassEntity
A handle to a Mass entity. An entity is used in conjunction with the FMassEntityManager for the current world and can contain lightweight fragments.
| Name | FMassEntityHandle |
| Type | struct |
| Header File | /Engine/Source/Runtime/MassEntity/Public/MassEntityHandle.h |
| Include Path | #include "MassEntityHandle.h" |
Syntax
USTRUCT ()
struct FMassEntityHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| MassEntityHandle.h | |||
FMassEntityHandle
(
const int32 InIndex, |
MassEntityHandle.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Index | int32 | MassEntityHandle.h |
|
|
| SerialNumber | int32 | MassEntityHandle.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
uint64 AsNumber() |
Allows the entity handle to be shared anonymously. | MassEntityHandle.h | |
FString DebugGetDescription() |
MassEntityHandle.h | ||
bool IsSet () |
Note that this function is merely checking if Index and SerialNumber are set. | MassEntityHandle.h | |
bool IsValid() |
MassEntityHandle.h | ||
void Reset() |
MassEntityHandle.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FMassEntityHandle FromNumber
(
uint64 Value |
Reconstruct the entity handle from an anonymously shared integer. | MassEntityHandle.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FMassEntityHandle Other |
MassEntityHandle.h | ||
bool operator==
(
const FMassEntityHandle Other |
MassEntityHandle.h |