1. Epic GamesDeveloper
  3. FMassRuntimePipeline

FMassRuntimePipeline

Runtime-usable array of MassProcessor copies

API > API/Runtime > API/Runtime/MassEntity

Runtime-usable array of MassProcessor copies

   
Name FMassRuntimePipeline
Type struct
Header File /Engine/Source/Runtime/MassEntity/Public/MassProcessingTypes.h
Include Path #include "MassProcessingTypes.h"

Syntax

USTRUCT ()  
struct FMassRuntimePipeline

Constructors

Name Remarks Include Path Unreal Specifiers
Inlines. MassProcessingTypes.h  

FMassRuntimePipeline ( TConstArrayView< TObjectPtr< UMassProcessor > > SeedProcessors,
EProcessorExecutionFlags WorldExecutionFlags
)

   MassProcessingTypes.h  

FMassRuntimePipeline ( TConstArrayView< UMassProcessor* > SeedProcessors,
EProcessorExecutionFlags WorldExecutionFlags
)

   MassProcessingTypes.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ExecutionFlags EProcessorExecutionFlags   MassProcessingTypes.h  
Processors TArray< TObjectPtr< UMassProcessor > >   MassProcessingTypes.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AppendOrOverrideRuntimeProcessorCopies ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner
)

 Creates a runtime instance of every processors in the given InProcessors array. MassProcessingTypes.h  

void AppendProcessor ( UMassProcessor& InProcessor
)

 Adds InProcessor(s) to Processors without any additional checks MassProcessingTypes.h  

void AppendProcessor ( TSubclassOf< UMassProcessor > ProcessorClass,
UObject& InOwner
)

 Creates an instance of ProcessorClass and adds it to Processors without any additional checks MassProcessingTypes.h  

void AppendProcessors ( TArray< TObjectPtr< UMassProcessor > >&& InProcessors
)

   MassProcessingTypes.h  
  MassProcessingTypes.h  

bool AppendUniqueProcessor ( UMassProcessor& Processor
)

   MassProcessingTypes.h  

void AppendUniqueRuntimeProcessorCopies ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner,
const TSharedRef< FMassEntityManager >& EntityManager
)

 Creates a runtime instance of every processors in the given array if there's no processor of that class in Processors already. MassProcessingTypes.h  

void AppendUniqueRuntimeProcessorCopies ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner
)

   MassProcessingTypes.h  

void CreateFromArray ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner
)

 Creates runtime copies of UMassProcessors given in InProcessors input parameter, using InOwner as new UMassProcessors' outer. MassProcessingTypes.h  

UMassCompositeProcessor * FindTopLevelGroupByName ( const FName GroupName
)

 Goes through Processor looking for a UMassCompositeProcessor instance which GroupName matches the one given as the parameter MassProcessingTypes.h  

TArrayView< TObjectPtr< UMassProcessor > > GetMutableProcessors()

   MassProcessingTypes.h  

TConstArrayView< TObjectPtr< UMassProcessor > > GetProcessors()

   MassProcessingTypes.h  

TConstArrayView< UMassProcessor * > GetProcessorsView()

   MassProcessingTypes.h  

bool HasProcessorOfExactClass ( TSubclassOf< UMassProcessor > InClass
) const

   MassProcessingTypes.h  

void Initialize ( UObject& Owner
)

 DEPRECATED. MassProcessingTypes.h  

void Initialize ( UObject& Owner,
const TSharedRef< FMassEntityManager >& EntityManager
)

   MassProcessingTypes.h  

void InitializeFromArray ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner,
const TSharedRef< FMassEntityManager >& EntityManager
)

 Calls CreateFromArray and calls Initialize on all processors afterwards. MassProcessingTypes.h  

void InitializeFromArray ( TConstArrayView< const UMassProcessor* > InProcessors,
UObject& InOwner
)

   MassProcessingTypes.h  

void InitializeFromClassArray ( TConstArrayView< TSubclassOf< UMassProcessor > > InProcessorClasses,
UObject& InOwner,
const TSharedRef< FMassEntityManager >& EntityManager
)

 Creates runtime instances of UMassProcessors for each processor class given via InProcessorClasses. MassProcessingTypes.h  

void InitializeFromClassArray ( TConstArrayView< TSubclassOf< UMassProcessor > > InProcessorClasses,
UObject& InOwner
)

   MassProcessingTypes.h  

bool IsEmpty()

   MassProcessingTypes.h  
Returns Processors array using move semantics. MassProcessingTypes.h  

int32 Num()

   MassProcessingTypes.h  

bool RemoveProcessor ( const UMassProcessor& InProcessor
)

   MassProcessingTypes.h  

void Reset()

   MassProcessingTypes.h  

void SetProcessors ( TArrayView< UMassProcessor* > InProcessors
)

 Copies the given array over to this FMassRuntimePipeline instance. MassProcessingTypes.h  

void SetProcessors ( TArray< TObjectPtr< UMassProcessor > >&& InProcessors
)

 Directly moves the contents of given array to the Processors member array. MassProcessingTypes.h  

void SetProcessors ( TArray< UMassProcessor* >&& InProcessors
)

   MassProcessingTypes.h  

void SortByExecutionPriority()

 Sorts processors aggregates in Processors array so that the ones with higher ExecutionPriority are executed first The function will also remove nullptrs, if any, before sorting. MassProcessingTypes.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page