1. Epic GamesDeveloper
  3. MassEntity

MassEntity

API > API/Runtime

Classes

  Type Name Description
Public struct FArchetypeStats    
Public class FConcurrentEntityStorage This storage backend allows for entities to be concurrently reserved.  
Public struct FInitializationState    
Public struct FMassArchetypeChunkIterator The type used to iterate over given archetype's chunks, be it full, continuous chunks or sparse subchunks.  
Public struct FMassArchetypeCompositionDescriptor The type summarily describing a composition of an entity or an archetype.  
Public struct FMassArchetypeCreationParams    
Public struct FMassArchetypeEntityCollection A struct that converts an arbitrary array of entities of given Archetype into a sequence of continuous entity chunks.  
Public struct FMassArchetypeEntityCollectionWithPayload    
Public struct FMassArchetypeHandle An opaque handle to an archetype.  
Public struct FMassArchetypeSharedFragmentValues Wrapper for const and non-const shared fragment containers that tracks which struct types it holds (via a FMassSharedFragmentBitSet).  
Public struct FMassBatchedCommand    
Public struct FMassBatchedEntityCommand    
Public struct UStruct FMassChunkFragment    
Public struct FMassCommandAddFragmentInstances    
Public struct FMassCommandAddFragmentsInternal    
Public struct FMassCommandAddTagsInternal    
Public struct FMassCommandBuffer    
Public struct FMassCommandBuildEntity    
Public struct FMassCommandBuildEntityWithSharedFragments Note: that TSharedFragmentValues is always expected to be FMassArchetypeSharedFragmentValues, but is declared as template's param to maintain uniform command adding interface via FMassCommandBuffer.PushCommand.  
Public struct FMassCommandChangeTags    
Public struct FMassCommandDestroyEntities    
Public struct FMassCommandRemoveFragmentsInternal    
Public struct FMassCommandRemoveTagsInternal    
Public struct FMassCommandSwapTagsInternal    
Public struct UStruct FMassConstSharedFragment    
Public struct FMassDebugger    
Public struct FMassDeferredCommand    
Public struct UStruct FMassEntityHandle A handle to a lightweight entity.  
Public struct FMassEntityManager The type responsible for hosting Entities managing Archetypes.  
Public struct FMassEntityManager_InitParams_Concurrent Initialization parameters to configure MassEntityManager to concurrently reserve entities Only supported in editor builds.  
Public struct FMassEntityManager_InitParams_SingleThreaded Initialization parameters to configure MassEntityManager to reserve entities only single threaded Supported in all build configurations  
Public struct UStruct FMassEntityObserverClassesMap A wrapper type for a TMap to support having array-of-maps UPROPERTY members in UMassObserverRegistry  
Public struct UStruct FMassEntityQuery FMassEntityQuery is a structure that is used to trigger calculations on cached set of valid archetypes as described by requirements.  
Public struct UStruct FMassEntityView The type representing a single entity in a single archetype.  
Public struct FMassExecutionContext    
Public struct FMassExecutionRequirements    
Public struct UStruct FMassFragment This is the base class for all lightweight fragments.  
Public struct FMassFragmentRequirementDescription    
Public struct UStruct FMassFragmentRequirements FMassFragmentRequirements is a structure that describes properties required of an archetype that's a subject of calculations.  
Public struct UStruct FMassGenericDebugEvent    
Public struct FMassGenericPayloadView Note that this is a view and is valid only as long as the source data is valid.  
Public struct FMassGenericPayloadViewSlice Used to indicate a specific slice of a preexisting FMassGenericPayloadView, it's essentially an access pattern Note: accessing content generates copies of FStructArrayViews stored (still cheap, those are just views).  
Public struct UStruct FMassObserverManager A type that encapsulates logic related to notifying interested parties of entity composition changes.  
Public struct UStruct FMassObserversMap A wrapper type for a TMap to support having array-of-maps UPROPERTY members in FMassObserverManager  
Public struct FMassPhaseProcessorConfigurationHelper    
Public struct UStruct BlueprintType FMassProcessingContext    
Public struct FMassProcessingPhase    
Public struct UStruct FMassProcessingPhaseConfig    
Public struct FMassProcessingPhaseManager MassProcessingPhaseManager owns separate FMassProcessingPhase instances for every ETickingGroup.  
Public struct UStruct FMassProcessorClassCollection A wrapper type for a TArray to support having map-of-arrays UPROPERTY members in FMassEntityObserverClassesMap  
Public struct FMassProcessorDependencySolver    
Public struct UStruct FMassProcessorExecutionOrder    
Public struct FMassProcessorOrderInfo    
Public struct FMassQueryRequirementIndicesMapping    
Public struct FMassRawEntityInChunkData    
Public struct UStruct FMassRuntimePipeline Runtime-usable array of MassProcessor copies  
Public struct UStruct FMassSharedFragment    
Public struct FMassSubsystemAccess    
Public struct UStruct FMassSubsystemRequirements FMassSubsystemRequirements is a structure that declares runtime subsystem access type given calculations require.  
Public struct UStruct FMassTag This is the base class for types that will only be tested for presence/absence, i.e. Tags.  
Public struct UStruct FProcessorAuxDataBase    
Public class 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.  
Public class 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  
Public struct TMassExecutionAccess    
Public struct TMassExternalSubsystemTraits Traits describing how a given piece of code can be used by Mass.  
Public struct TMassSharedFragmentTraits Shared Fragments' traits.  
Public struct TMultiArray The type hosts a statically-typed collection of TArrays, where each TArray is strongly-typed (i.e. it contains instances of given structs rather than structs wrapped up in FInstancedStruct).  
Public struct TMultiTypeList A statically-typed list of of related types.  
Public class UClass UMassCompositeProcessor    
Public class UClass Config defaultconfig, displayname UMassEntitySettings Implements the settings for MassEntity plugin  
Public class UClass UMassEntitySubsystem The sole responsibility of this world subsystem class is to host the default instance of FMassEntityManager for a given UWorld.  
Public class UClass Abstract Config collapsecategories, defaultconfig UMassModuleSettings A common parrent for Mass's per-module settings.  
Public class UClass Abstract UMassObserverProcessor    
Public class UClass UMassObserverRegistry    
Public class UClass Abstract Config collapsecategories, configdonotcheckdefaults, defaultconfig, editinlinenew UMassProcessor    
Public class UClass AutoExpandCategories Config defaultconfig, displayname UMassSettings    
Public class UClass Abstract UMassSubsystemBase The sole responsibility of this world subsystem class is to serve functionality common to all Mass-related UWorldSubsystem-based subsystems, like whether the subsystems should get created at all.  
Public class UClass Abstract UMassTickableSubsystemBase The sole responsibility of this tickable world subsystem class is to serve functionality common to all Mass-related UTickableWorldSubsystem-based subsystems, like whether the subsystems should get created at all.  

Typedefs

Name Description
FMassChunkConditionFunction  
FMassCommandAddFragments  
FMassCommandAddTag  
FMassCommandAddTags  
FMassCommandRemoveFragments  
FMassCommandRemoveTag  
FMassCommandRemoveTags  
FMassCommandSwapTags  
FMassDeferredAddCommand  
FMassDeferredChangeCompositionCommand  
FMassDeferredCreateCommand  
FMassDeferredDestroyCommand  
FMassDeferredRemoveCommand  
FMassDeferredSetCommand  
FMassEntityManagerStorageInitParams  
FMassExecuteFunction  
FMassFragmentIndicesMapping  

Enums

  Type Name Description
Public enum EMassCommandCheckTime    
Public enum UEnum EMassCommandOperationType Enum used by MassBatchCommands to declare their "type".  
Public enum EMassExecutionContextType    
Public enum UEnum EMassFragmentAccess    
Public enum UEnum EMassFragmentPresence    
Public enum UEnum EMassObservedOperation    
Public enum UEnum EMassProcessingPhase    
Public enum EProcessorCompletionStatus    
Public enum UEnum meta EProcessorExecutionFlags    

Functions

  Type Name Description
Public function  

DECLARE_CLASSTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassExternalSubsystemBitSet,
USubsystem
)

  
Public function  

DECLARE_STRUCTTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassFragmentBitSet,
FMassFragment
)

  
Public function  

DECLARE_STRUCTTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassTagBitSet,
FMassTag
)

  
Public function  

DECLARE_STRUCTTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassChunkFragmentBitSet,
FMassChunkFragment
)

  
Public function  

DECLARE_STRUCTTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassSharedFragmentBitSet,
FMassSharedFragment
)

  
Public function  

DECLARE_STRUCTTYPEBITSET_EXPORTED ( MASSENTITY_API,
FMassConstSharedFragmentBitSet,
FMassConstSharedFragment
)

  
Public function    
Public function T * Every TMassExternalSubsystemTraits specialization needs to implement the following.
Public function T *

FMassExternalSubsystemTraits::GetInstance ( const UWorld* World,
const TSubclassOf< UWorldSubsystem > SubsystemClass
)

  
Public function void

UE::Mass::Utils::AbstractSort ( const int32 NumElements,
TPred&& Predicate,
TSwap&& SwapFunctor
)

 AbstractSort is a sorting function that only needs to know how many items there are, how to compare items at individual locations - where location is in [0, NumElements) - and how to swap two elements at given locations.
Public function BitSetType  
Public function FMassFragmentBitSet  
Public function FMassTagBitSet  
Public function EProcessorExecutionFlags  

Variables

  Type Name Description
Public variable uint32 MAX  
Public variable uint32 Read  
Public variable   STATCAT_Advanced  
Public variable uint32 Write  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page