1. Epic GamesDeveloper
  3. FSingleThreadedEntityStorage

FSingleThreadedEntityStorage

This storage backend should be used when the user of MassEntityManager can guarantee that all entity management will be done on a single thread.

API > API/Runtime > API/Runtime/MassEntity

Inheritance Hierarchy

References

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

Syntax

class FSingleThreadedEntityStorage : public UE::Mass::IEntityStorageInterface

Remarks

This storage backend should be used when the user of MassEntityManager can guarantee that all entity management will be done on a single thread.

Functions

  Type Name Description
Public function int32

Acquire ( const int32 Count,
TArray< FMassEntityHandle >& OutEntityHandles
)

  
Public function void  

Overridden from IEntityStorageInterface

  Type Name Description
Public function Virtual int32

Acquire ( TArrayView< FMassEntityHandle > OutEntityHandles
)

  
Public function Virtual FMassEntityHandle  
Public function Virtual Const int32 Returns the number of entities that are free For debug purposes only.
Public function Virtual int32

ForceRelease ( TConstArrayView< FMassEntityHandle > Handles
)

 Bypasses Serial Number Check Only use if caller has ensured serial number matches or for debug purposes
Public function Virtual int32  
Public function Virtual Const SIZE_T  
Public function Virtual Const const FMassArchetypeData *

GetArchetype ( int32 Index
)

  
Public function Virtual FMassArchetypeData *

GetArchetype ( int32 Index
)

  
Public function Virtual Const const TSharedPtr< FMassArchetypeData > &  
Public function Virtual TSharedPtr< FMassArchetypeData > &  
Public function Virtual Const EEntityState

GetEntityState ( int32 Index
)

 Returns true if the given entity at index is currently reserved False if free or assigned an archetype
Public function Virtual Const int32  
Public function Virtual Const bool

IsValid ( int32 Index
)

 Checks if entity at Index is built.
Public function Virtual Const bool

IsValidIndex ( int32 Index
)

 Checks if index can be used to access entity data.
Public function Virtual Const int32

Num ()

 Returns the number of entities that are not free For debug purposes only.
Public function Virtual int32

Release ( TConstArrayView< FMassEntityHandle > Handles
)

  
Public function Virtual int32  
Public function Virtual void

SetArchetypeFromShared ( int32 Index,
TSharedPtr< FMassArchetypeData >&
)

  
Public function Virtual void

SetArchetypeFromShared ( int32 Index,
const TSharedPtr< FMassArchetypeData >&
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page