1. Epic GamesDeveloper
  3. IEntityStorageInterface

IEntityStorageInterface

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

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 IEntityStorageInterface

Remarks

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

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function int32

Acquire ( TArrayView< FMassEntityHandle > OutEntityHandles
)

  
Public function int32

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

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

ForceRelease ( TConstArrayView< FMassEntityHandle > Handles
)

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

GetArchetype ( int32 Index
)

  
Public function FMassArchetypeData *

GetArchetype ( int32 Index
)

  
Public function Const const TSharedPtr< FMassArchetypeData > &  
Public function TSharedPtr< FMassArchetypeData > &  
Public function 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 Const int32  
Public function Const bool

IsValid ( int32 Index
)

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

IsValidIndex ( int32 Index
)

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

Num ()

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

Release ( TConstArrayView< FMassEntityHandle > Handles
)

  
Public function int32  
Public function void

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

  
Public function void

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

  

Enums

  Type Name Description
Public enum EEntityState    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page