FConcurrentEntityStorage | Unreal Engine 5.5 Documentation

API > API/Runtime > API/Runtime/MassEntity

Inheritance Hierarchy

IEntityStorageInterface
FConcurrentEntityStorage

References


Module	MassEntity
Header	/Engine/Source/Runtime/MassEntity/Public/MassEntityManagerStorage.h
Include	#include "MassEntityManagerStorage.h"

Syntax

class FConcurrentEntityStorage : public UE::Mass::IEntityStorageInterface

Remarks

This storage backend allows for entities to be concurrently reserved. Reserved entities can also be concurrently freed. Creation of entities (ie. assignment of an archetype and addition of data into chunks) cannot be done concurrently with this implementation.

Destructors

	Type	Name	Description
		~FConcurrentEntityStorage ()

Functions

	Type	Name	Description
	int32	Acquire ( const int32 Count, TArray< FMassEntityHandle >& OutEntityHandles )
	void	Initialize ( const FMassEntityManager_InitParams_Concurrent& InInitializationParams )

Overridden from IEntityStorageInterface

Type	Name	Description
int32	Acquire ( TArrayView< FMassEntityHandle > OutEntityHandles )
FMassEntityHandle	AcquireOne ()
int32	ComputeFreeSize ()	Returns the number of entities that are free For debug purposes only.
int32	ForceRelease ( TConstArrayView< FMassEntityHandle > Handles )	Bypasses Serial Number Check Only use if caller has ensured serial number matches or for debug purposes
int32	ForceReleaseOne ( FMassEntityHandle Handle )
SIZE_T	GetAllocatedSize ()
const FMassArchetypeData *	GetArchetype ( int32 Index )
FMassArchetypeData *	GetArchetype ( int32 Index )
const TSharedPtr< FMassArchetypeData > &	GetArchetypeAsShared ( int32 Index )
TSharedPtr< FMassArchetypeData > &	GetArchetypeAsShared ( int32 Index )
EEntityState	GetEntityState ( int32 Index )	Returns true if the given entity at index is currently reserved False if free or assigned an archetype
int32	GetSerialNumber ( int32 Index )
bool	IsValid ( int32 Index )	Checks if entity at Index is built.
bool	IsValidIndex ( int32 Index )	Checks if index can be used to access entity data.
int32	Num ()	Returns the number of entities that are not free For debug purposes only.
int32	Release ( TConstArrayView< FMassEntityHandle > Handles )
int32	ReleaseOne ( FMassEntityHandle Handle )
void	SetArchetypeFromShared ( int32 Index, TSharedPtr< FMassArchetypeData >& Archetype )
void	SetArchetypeFromShared ( int32 Index, const TSharedPtr< FMassArchetypeData >& Archetype )

Navigation