UMassCompositeProcessor

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MassEntity

Header

/Engine/Plugins/Runtime/MassEntity/Source/MassEntity/Public/MassProcessor.h

Include

#include "MassProcessor.h"

Syntax

UCLASS()
class UMassCompositeProcessor : public UMassProcessor

Variables

Name Description

Protected variable

bool

 

bHasOffThreadSubGroups

Protected variable

bool

 

bRunInSeparateThread

Protected variable UProperty Category visibleanywhere

FMassRuntimePip...

 

ChildPipeline

Protected variable

TArray< FProces...

 

CompletionStatus

Protected variable UProperty

FName

 

GroupName

Group name that will be used when resolving processor dependencies and grouping

Protected variable

TArray< FDepend...

 

ProcessingFlatGraph

Constructors

Name Description

Public function

UMassCompositeProcessor()

Functions

Name Description

Public function

void

 

AddGroupedProcessor

(
    FName RequestedGroupName,
    UMassProcessor& SubProcessor
)

Adds SubProcessor to an appropriately named group.

Protected function Virtual

void

 

ConfigureQueries()

Public function Virtual

void

 

CopyAndSort

(
    const FMassProcessingPhaseConfig& ...,
    const FString& DependencyGraphFile...
)

Protected function Virtual

void

 

Execute

(
    UMassEntitySubsystem& EntitySubsys...,
    FMassExecutionContext& Context
)

Protected function

UMassComposi...

 

FindOrAddGroupProcessor

(
    FName RequestedGroupName,
    FString* OutRemainingGroupName
)

RequestedGroupName can indicate a multi-level group name, like so: A.B.C We need to extract the highest-level group name ('A' in the example), and see if it already exists.

Public function Const

FName

 

GetGroupName()

Public function Const

bool

 

IsEmpty()

Protected function

int32

 

Populate

(
    TArray< FProcessorDependencySolver:...,
    const int32 StartIndex
)

Called recursively to add processors and composite processors to ChildPipeline based on ProcessorsAndGroups

Public function

void

 

SetChildProcessors

(
    TArray< UMassProcessor* >&& I...
)

Public function

void

 

SetGroupName

(
    FName NewName
)

Overridden from UMassProcessor

Name Description

Public function Virtual Const

void

 

DebugOutputDescription

(
    FOutputDevice& Ar,
    int32 Indent
)

Public function Virtual

FGraphEventR...

 

DispatchProcessorTasks

(
    UMassEntitySubsystem& EntitySubsys...,
    FMassExecutionContext& ExecutionCo...,
    const FGraphEventArray& Prerequisi...
)

Public function Virtual Const

FString

 

GetProcessorName()

Public function Virtual

void

 

Initialize

(
    UObject& Owner
)

Public function Virtual

void

 

SetProcessingPhase

(
    EMassProcessingPhase Phase
)

Classes

Name

Description

Protected struct

FProcessorCompletion