1. Epic GamesDeveloper
  3. MassEntity

MassEntity

API > API/Plugins

Classes

  Type Name Description
Public struct FArchetypeStats    
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 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    
Public struct FMassBatchedCommand    
Public struct FMassBatchedEntityCommand    
Public struct UStruct FMassChunkFragment    
Public struct FMassChunkFragmentBitSetStructTrackerWrapper    
Public struct FMassCommandAddFragmentInstances    
Public struct FMassCommandAddFragmentsInternal    
Public struct FMassCommandAddTagInternal    
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 FMassCommandRemoveTagInternal    
Public struct FMassCommandSwapTagsInternal    
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 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 FMassExternalSubsystemBitSetStructTrackerWrapper    
Public struct UStruct FMassFragment This is the base class for all lightweight fragments.  
Public struct FMassFragmentBitSetStructTrackerWrapper    
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 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 FMassRequirementAccessDetector    
Public struct UStruct FMassRuntimePipeline Runtime-usable array of MassProcessor copies  
Public struct UStruct FMassSharedFragment    
Public struct FMassSharedFragmentBitSetStructTrackerWrapper    
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 FMassTagBitSetStructTrackerWrapper    
Public struct UStruct FProcessorAuxDataBase    
Public struct FQueryRequirementsView    
Public class IMassEntityModule The public interface to this module.  
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    

Typedefs

Name Description
FMassChunkConditionFunction  
FMassChunkFragmentBitSet  
FMassCommandAddFragments  
FMassCommandAddTag  
FMassCommandRemoveFragments  
FMassCommandSwapTags  
FMassDeferredAddCommand  
FMassDeferredChangeCompositionCommand  
FMassDeferredCreateCommand  
FMassDeferredDestroyCommand  
FMassDeferredRemoveCommand  
FMassDeferredSetCommand  
FMassExecuteFunction  
FMassExternalSubsystemBitSet  
FMassFragmentBitSet  
FMassFragmentIndicesMapping  
FMassSharedFragmentBitSet  
FMassTagBitSet  

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 T * FMassExternalSubsystemTraits::GetInstance has been marked as deprecated. Use FMassSubsystemAccess::FetchSubsystemInstance instead.
Public function T * FMassExternalSubsystemTraits::GetInstance has been marked as deprecated. Use FMassSubsystemAccess::FetchSubsystemInstance instead.
Public function constexpr bool  
Public function constexpr EProcessorExecutionFlags  
Public function EProcessorExecutionFlags &  
Public function constexpr EProcessorExecutionFlags  
Public function EProcessorExecutionFlags &  
Public function constexpr EProcessorExecutionFlags  
Public function EProcessorExecutionFlags &  
Public function constexpr EProcessorExecutionFlags  
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 This function is deprecated. Please use the properly spelled GetProcessorExecutionFlagsForWorld instead.

Variables

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page