Navigation
API > API/Runtime > API/Runtime/MassEntity
Interface that abstracts the storage system for Mass Entities in the EntityManager This may be temporary until the concurrent mechanism has been vetted for performance
| Name | IEntityStorageInterface |
| Type | class |
| Header File | /Engine/Source/Runtime/MassEntity/Public/MassEntityManagerStorage.h |
| Include Path | #include "MassEntityManagerStorage.h" |
Syntax
class IEntityStorageInterface
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IEntityStorageInterface() |
MassEntityManagerStorage.h |
Enums
Public
| Name | Remarks |
|---|---|
| EEntityState |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 Acquire
(
TArrayView< FMassEntityHandle > OutEntityHandles |
MassEntityManagerStorage.h | ||
int32 Acquire
(
const int32 Count, |
MassEntityManagerStorage.h | ||
FMassEntityHandle AcquireOne() |
Produce a single entity handle | MassEntityManagerStorage.h | |
int32 ComputeFreeSize () |
Returns the number of entities that are free For debug purposes only. | MassEntityManagerStorage.h | |
int32 ForceRelease
(
TConstArrayView< FMassEntityHandle > Handles |
Bypasses Serial Number Check Only use if caller has ensured serial number matches or for debug purposes | MassEntityManagerStorage.h | |
int32 ForceReleaseOne
(
FMassEntityHandle Handle |
MassEntityManagerStorage.h | ||
SIZE_T GetAllocatedSize() |
MassEntityManagerStorage.h | ||
const FMassArchetypeData * GetArchetype
(
int32 Index |
MassEntityManagerStorage.h | ||
FMassArchetypeData * GetArchetype
(
int32 Index |
MassEntityManagerStorage.h | ||
const TSharedPtr< FMassArchetypeData > & GetArchetypeAsShared
(
int32 Index |
MassEntityManagerStorage.h | ||
TSharedPtr< FMassArchetypeData > & GetArchetypeAsShared
(
int32 Index |
MassEntityManagerStorage.h | ||
EEntityState GetEntityState
(
int32 Index |
Returns true if the given entity at index is currently reserved False if free or assigned an archetype | MassEntityManagerStorage.h | |
int32 GetSerialNumber
(
int32 Index |
MassEntityManagerStorage.h | ||
bool IsEntityActive
(
FMassEntityHandle EntityHandle |
MassEntityManagerStorage.h | ||
bool IsValid
(
int32 Index |
Checks if entity at Index is built | MassEntityManagerStorage.h | |
bool IsValidHandle
(
FMassEntityHandle EntityHandle |
Checks if the given handle is valid in the context od this storage, i.e. whether the index is valid and the serial number associated with it matches the handle's | MassEntityManagerStorage.h | |
bool IsValidIndex
(
int32 Index |
Checks if index can be used to access entity data | MassEntityManagerStorage.h | |
int32 Num () |
Returns the number of entities that are not free For debug purposes only. | MassEntityManagerStorage.h | |
int32 Release
(
TConstArrayView< FMassEntityHandle > Handles |
MassEntityManagerStorage.h | ||
int32 ReleaseOne
(
FMassEntityHandle Handles |
MassEntityManagerStorage.h | ||
void SetArchetypeFromShared
(
int32 Index, |
MassEntityManagerStorage.h | ||
void SetArchetypeFromShared
(
int32 Index, |
MassEntityManagerStorage.h |