1. Epic GamesDeveloper
  3. UMassProcessor

UMassProcessor

API > API/Runtime > API/Runtime/MassEntity

Inheritance Hierarchy

References

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

Syntax

UCLASS (Abstract, EditInlineNew, CollapseCategories, Config=Mass, defaultconfig,  
       ConfigDoNotCheckDefaults)  
class UMassProcessor : public UObject

Variables

  Type Name Description
Protected variable uint8: 1 = false bAllowMultipleInstances Meant as a class property, make sure to set it in subclass' constructor.
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = true bAutoRegisterWithProcessingPhases Configures whether this processor should be automatically included in the global list of processors executed every tick (see ProcessingPhase and ExecutionOrder).
Protected variable UProperty Config uint8: 1 = true bCanShowUpInSettings Used to permanently remove a given processor class from PipeSetting's listing.
Protected variable UProperty Category, EditDefaultsOnly Config uint8: 1 = false bRequiresGameThreadExecution  
Protected variable UProperty Category, EditAnywhere, Meta Config uint8 ExecutionFlags Whether this processor should be executed on StandAlone or Server or Client
Protected variable UProperty Category, EditDefaultsOnly Config FMassProcessorExecutionOrder ExecutionOrder Configures when this given processor can be executed in relation to other processors and processing groups, within its processing phase.
Protected variable friend FMassDebugger  
Protected variable UProperty Category, EditDefaultsOnly Config EMassProcessingPhase ProcessingPhase Processing phase this processor will be automatically run as part of.
Protected variable FMassSubsystemRequirements ProcessorRequirements A query representing elements this processor is accessing in Execute function outside of query execution
Protected variable friend UMassCompositeProcessor  

Constructors

  Type Name Description
Public function    
Public function  

UMassProcessor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function void  
Public function Virtual Const void

DebugOutputDescription ( FOutputDevice& Ar,
int32 Indent
)

  
Public function Const void

DebugOutputDescription ( FOutputDevice& Ar
)

  
Public function Virtual FGraphEventRef

DispatchProcessorTasks ( const TSharedPtr< FMassEntityManager >& EntityManager,
FMassExecutionContext& ExecutionContext,
const FGraphEventArray& Prerequisites
)

  
Public function bool  
Public function Const bool  
Public function Virtual Const void By default, fetches requirements declared entity queries registered via RegisterQuery.
Public function void  
Public function Const EProcessorExecutionFlags  
Public function Const const FMassProcessorExecutionOrder &  
Public function Virtual Const EMassProcessingPhase  
Public function Virtual Const FString  
Public function Const const FMassSubsystemRequirements &  
Public function Virtual void

Initialize ( UObject& Owner
)

 Called to initialize the processor.
Public function Const bool  
Public function Const bool UMassProcessor inlines.
Public function void  
Protected function Virtual void virtual ConfigureQueries() PURE_VIRTUAL(UMassProcessor void  
Public function void Adds Query to RegisteredQueries list.
Public function Virtual void  
Public function void

SetShouldAutoRegisterWithGlobalList ( const bool bAutoRegister
)

 Sets bAutoRegisterWithProcessingPhases.
Public function Const bool Controls whether there can be multiple instances of a given class in a single FMassRuntimePipeline and during dependency solving.
Public function Virtual Const bool

ShouldAllowQueryBasedPruning ( const bool bRuntimeMode
)

 Ordering functions.
Public function Const bool  
Public function Const bool

ShouldExecute ( const EProcessorExecutionFlags CurrentExecutionFlags
)

 Whether this processor should execute according the CurrentExecutionFlags parameters
Public function Const bool  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page