UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UMassProcessor Class Reference

#include <MassProcessor.h>

+ Inheritance diagram for UMassProcessor:

Public Member Functions

UE_API UMassProcessor ()
 
UE_API UMassProcessor (const FObjectInitializer &ObjectInitializer)
 
bool IsInitialized () const
 
UE_API void CallInitialize (const TNotNull< UObject * > Owner, const TSharedRef< FMassEntityManager > &EntityManager)
 
virtual UE_API FGraphEventRef DispatchProcessorTasks (const TSharedPtr< FMassEntityManager > &EntityManager, FMassExecutionContext &ExecutionContext, const FGraphEventArray &Prerequisites=FGraphEventArray())
 
EProcessorExecutionFlags GetExecutionFlags () const
 
bool ShouldExecute (const EProcessorExecutionFlags CurrentExecutionFlags) const
 
UE_API void CallExecute (FMassEntityManager &EntityManager, FMassExecutionContext &Context)
 
bool ShouldAllowMultipleInstances () const
 
void DebugOutputDescription (FOutputDevice &Ar) const
 
virtual UE_API void DebugOutputDescription (FOutputDevice &Ar, int32 Indent) const
 
virtual UE_API FString GetProcessorName () const
 
virtual UE_API bool ShouldAllowQueryBasedPruning (const bool bRuntimeMode=true) const
 
virtual UE_API EMassProcessingPhase GetProcessingPhase () const
 
virtual UE_API void SetProcessingPhase (EMassProcessingPhase Phase)
 
bool DoesRequireGameThreadExecution () const
 
const FMassProcessorExecutionOrderGetExecutionOrder () const
 
virtual UE_API void ExportRequirements (FMassExecutionRequirements &OutRequirements) const
 
const FMassSubsystemRequirementsGetProcessorRequirements () const
 
int16 GetExecutionPriority () const
 
void SetExecutionPriority (const int16 NewExecutionPriority)
 
UE_API void RegisterQuery (FMassEntityQuery &Query)
 
void MarkAsDynamic ()
 
bool IsDynamic () const
 
void MakeActive ()
 
void MakeOneShot ()
 
void MakeInactive ()
 
bool IsActive () const
 
bool ShouldAutoAddToGlobalList () const
 
UE_API void SetShouldAutoRegisterWithGlobalList (const bool bAutoRegister)
 
UE_API void GetArchetypesMatchingOwnedQueries (const FMassEntityManager &EntityManager, TArray< FMassArchetypeHandle > &OutArchetype)
 
UE_API bool DoesAnyArchetypeMatchOwnedQueries (const FMassEntityManager &EntityManager)
 
int32 GetOwnedQueriesNum () const
 
virtual UE_API void Initialize (UObject &Owner) final
 
virtual void ConfigureQueries () final
 
- Public Member Functions inherited from UObject
COREUOBJECT_API UObject ()
 
COREUOBJECT_API UObject (const FObjectInitializer &ObjectInitializer)
 
COREUOBJECT_API UObject (EStaticConstructor, EObjectFlags InFlags)
 
COREUOBJECT_API UObject (FVTableHelper &Helper)
 
COREUOBJECT_API UObjectCreateDefaultSubobject (FName SubobjectFName, UClass *ReturnType, UClass *ClassToCreateByDefault, bool bIsRequired, bool bIsTransient)
 
template<class TReturnType >
TReturnTypeCreateEditorOnlyDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
template<class TReturnType , class TClassToConstructByDefault >
TReturnTypeCreateOptionalDefaultSubobject (FName SubobjectName, bool bTransient=false)
 
COREUOBJECT_API void GetDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects)
 
COREUOBJECT_API UObjectGetDefaultSubobjectByName (FName ToFind)
 
virtual COREUOBJECT_API void PostReinitProperties ()
 
virtual void PostCDOContruct ()
 
virtual COREUOBJECT_API void PreSaveRoot (FObjectPreSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PostSaveRoot (FObjectPostSaveRootContext ObjectSaveContext)
 
virtual COREUOBJECT_API void PreSave (FObjectPreSaveContext SaveContext)
 
virtual COREUOBJECT_API void CollectSaveOverrides (FObjectCollectSaveOverridesContext SaveContext)
 
UE_FORCEINLINE_HINT bool Modify (bool bAlwaysMarkDirty=true)
 
UE_FORCEINLINE_HINT bool IsCapturingAsRootObjectForTransaction () const
 
virtual bool ResolveSubobject (const TCHAR *SubObjectPath, UObject *&OutObject, bool bLoadIfExists)
 
virtual bool IsReadyForAsyncPostLoad () const
 
virtual COREUOBJECT_API void PostLoad ()
 
virtual COREUOBJECT_API void PostLoadSubobjects (FObjectInstancingGraph *OuterInstanceGraph)
 
virtual COREUOBJECT_API void BeginDestroy ()
 
virtual bool IsReadyForFinishDestroy ()
 
virtual COREUOBJECT_API void FinishDestroy ()
 
virtual COREUOBJECT_API void Serialize (FArchive &Ar)
 
virtual COREUOBJECT_API void Serialize (FStructuredArchive::FRecord Record)
 
virtual void ShutdownAfterError ()
 
virtual void PostInterpChange (FProperty *PropertyThatChanged)
 
virtual COREUOBJECT_API void PostRename (UObject *OldOuter, const FName OldName)
 
virtual void PreDuplicate (FObjectDuplicationParameters &DupParams)
 
virtual void PostDuplicate (bool bDuplicateForPIE)
 
virtual void PostDuplicate (EDuplicateMode::Type DuplicateMode)
 
virtual COREUOBJECT_API bool NeedsLoadForClient () const
 
virtual COREUOBJECT_API bool NeedsLoadForServer () const
 
virtual COREUOBJECT_API bool NeedsLoadForTargetPlatform (const class ITargetPlatform *TargetPlatform) const
 
virtual bool NeedsLoadForEditorGame () const
 
virtual bool IsEditorOnly () const
 
virtual bool HasNonEditorOnlyReferences () const
 
virtual bool IsPostLoadThreadSafe () const
 
virtual COREUOBJECT_API bool IsDestructionThreadSafe () const
 
virtual COREUOBJECT_API void GetPreloadDependencies (TArray< UObject * > &OutDeps)
 
virtual void GetPrestreamPackages (TArray< UObject * > &OutPrestream)
 
virtual void ExportCustomProperties (FOutputDevice &Out, uint32 Indent)
 
virtual void ImportCustomProperties (const TCHAR *SourceText, FFeedbackContext *Warn)
 
virtual void PostEditImport ()
 
virtual void PostReloadConfig (class FProperty *PropertyThatWasLoaded)
 
virtual COREUOBJECT_API bool Rename (const TCHAR *NewName=nullptr, UObject *NewOuter=nullptr, ERenameFlags Flags=REN_None)
 
virtual FString GetDesc ()
 
COREUOBJECT_API UScriptStructGetSparseClassDataStruct () const
 
virtual bool GetNativePropertyValues (TMap< FString, FString > &out_PropertyValues, uint32 ExportFlags=0) const
 
virtual COREUOBJECT_API void GetResourceSizeEx (FResourceSizeEx &CumulativeResourceSize)
 
SIZE_T GetResourceSizeBytes (EResourceSizeMode::Type Mode)
 
virtual FName GetExporterName (void)
 
COREUOBJECT_API void CallAddReferencedObjects (FReferenceCollector &Collector)
 
virtual FRestoreForUObjectOverwriteGetRestoreForUObjectOverwrite ()
 
virtual bool AreNativePropertiesIdenticalTo (UObject *Other) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context) const
 
virtual COREUOBJECT_API void GetAssetRegistryTags (TArray< FAssetRegistryTag > &OutTags) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetData &Out) const
 
COREUOBJECT_API void GetAssetRegistryTags (FAssetRegistryTagsContext Context, FAssetData &Out) const
 
virtual COREUOBJECT_API bool IsAsset () const
 
virtual COREUOBJECT_API FPrimaryAssetId GetPrimaryAssetId () const
 
virtual COREUOBJECT_API bool IsLocalizedResource () const
 
virtual COREUOBJECT_API bool IsSafeForRootSet () const
 
virtual COREUOBJECT_API void TagSubobjects (EObjectFlags NewFlags)
 
virtual COREUOBJECT_API void GetLifetimeReplicatedProps (TArray< class FLifetimeProperty > &OutLifetimeProps) const
 
virtual COREUOBJECT_API void GetReplicatedCustomConditionState (FCustomPropertyConditionState &OutActiveState) const
 
virtual COREUOBJECT_API void RegisterReplicationFragments (UE::Net::FFragmentRegistrationContext &Context, UE::Net::EFragmentRegistrationFlags RegistrationFlags)
 
virtual COREUOBJECT_API bool IsNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsFullNameStableForNetworking () const
 
virtual COREUOBJECT_API bool IsSupportedForNetworking () const
 
virtual void GetSubobjectsWithStableNamesForNetworking (TArray< UObject * > &ObjList)
 
virtual COREUOBJECT_API void PreNetReceive ()
 
virtual COREUOBJECT_API void PostNetReceive ()
 
virtual void PostRepNotifies ()
 
virtual COREUOBJECT_API void PreDestroyFromReplication ()
 
COREUOBJECT_API bool IsSelected () const
 
COREUOBJECT_API void SerializeScriptProperties (FArchive &Ar) const
 
COREUOBJECT_API void SerializeScriptProperties (FStructuredArchive::FSlot Slot) const
 
COREUOBJECT_API void ReinitializeProperties (UObject *SourceObject=NULL, struct FObjectInstancingGraph *InstanceGraph=NULL)
 
COREUOBJECT_API FString GetDetailedInfo () const
 
COREUOBJECT_API bool ConditionalBeginDestroy ()
 
COREUOBJECT_API bool ConditionalFinishDestroy ()
 
COREUOBJECT_API void ConditionalPostLoad ()
 
COREUOBJECT_API void ConditionalPreload ()
 
COREUOBJECT_API void ConditionalPostLoadSubobjects (struct FObjectInstancingGraph *OuterInstanceGraph=NULL)
 
bool IsBasedOnArchetype (const UObject *const SomeObject) const
 
COREUOBJECT_API UFunctionFindFunction (FName InName) const
 
COREUOBJECT_API UFunctionFindFunctionChecked (FName InName) const
 
virtual COREUOBJECT_API void BuildSubobjectMapping (UObject *OtherObject, TMap< UObject *, UObject * > &ObjectMapping) const
 
COREUOBJECT_API void CollectDefaultSubobjects (TArray< UObject * > &OutDefaultSubobjects, bool bIncludeNestedSubobjects=false) const
 
COREUOBJECT_API bool CheckDefaultSubobjects (bool bForceCheck=false) const
 
COREUOBJECT_API void SaveConfig (uint64 RequiredPropertyFlags=CPF_Config, const TCHAR *Filename=nullptr, FConfigCacheIni *Config=GConfig, bool bAllowCopyToDefaultObject=true)
 
COREUOBJECT_API void SaveConfig (const FSaveConfigContext &Context)
 
COREUOBJECT_API void UpdateDefaultConfigFile (const FString &SpecificFileLocation="")
 
COREUOBJECT_API bool TryUpdateDefaultConfigFile (const FString &SpecificFileLocation="", bool bWarnIfFail=true)
 
COREUOBJECT_API void UpdateGlobalUserConfigFile ()
 
COREUOBJECT_API void UpdateProjectUserConfigFile ()
 
COREUOBJECT_API void UpdateSinglePropertyInConfigFile (const FProperty *InProperty, const FString &InConfigIniName)
 
COREUOBJECT_API FString GetDefaultConfigFilename () const
 
COREUOBJECT_API FString GetGlobalUserConfigFilename () const
 
COREUOBJECT_API FString GetProjectUserConfigFilename () const
 
virtual const TCHARGetConfigOverridePlatform () const
 
virtual void OverrideConfigSection (FString &SectionName)
 
virtual void OverridePerObjectConfigSection (FString &SectionName)
 
COREUOBJECT_API void LoadConfig (UClass *ConfigClass=nullptr, const TCHAR *Filename=nullptr, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=nullptr, TArray< UE::ConfigAccessTracking::FConfigAccessData > *OutAccessedKeys=nullptr)
 
COREUOBJECT_API void ReloadConfig (UClass *ConfigClass=NULL, const TCHAR *Filename=NULL, uint32 PropagationFlags=UE::LCPF_None, class FProperty *PropertyToLoad=NULL)
 
COREUOBJECT_API void ParseParms (const TCHAR *Parms)
 
COREUOBJECT_API void OutputReferencers (FOutputDevice &Ar, FReferencerInformationList *Referencers=NULL)
 
COREUOBJECT_API void RetrieveReferencers (TArray< FReferencerInformation > *OutInternalReferencers, TArray< FReferencerInformation > *OutExternalReferencers)
 
COREUOBJECT_API void SetLinker (FLinkerLoad *LinkerLoad, int32 LinkerIndex, bool bShouldDetachExisting=true, bool bSilenceLogs=false)
 
COREUOBJECT_API UObjectGetArchetype () const
 
COREUOBJECT_API void GetArchetypeInstances (TArray< UObject * > &Instances)
 
COREUOBJECT_API void InstanceSubobjectTemplates (struct FObjectInstancingGraph *InstanceGraph=NULL)
 
template<class T >
bool Implements () const
 
virtual COREUOBJECT_API void ProcessEvent (UFunction *Function, void *Parms)
 
virtual int32 GetFunctionCallspace (UFunction *Function, FFrame *Stack)
 
virtual bool CallRemoteFunction (UFunction *Function, void *Parms, struct FOutParmRec *OutParms, FFrame *Stack)
 
COREUOBJECT_API bool CallFunctionByNameWithArguments (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor, bool bForceCallWithNonExec=false)
 
COREUOBJECT_API void CallFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
 DECLARE_FUNCTION (ProcessInternal)
 
virtual bool ProcessConsoleExec (const TCHAR *Cmd, FOutputDevice &Ar, UObject *Executor)
 
COREUOBJECT_API void SkipFunction (FFrame &Stack, RESULT_DECL, UFunction *Function)
 
virtual UClassRegenerateClass (UClass *ClassToRegenerate, UObject *PreviousCDO)
 
COREUOBJECT_API bool IsInBlueprint () const
 
COREUOBJECT_API void DestroyNonNativeProperties ()
 
virtual void MarkAsEditorOnlySubobject ()
 
COREUOBJECT_API void AbortInsideMemberFunction () const
 
 DECLARE_FUNCTION (execUndefined)
 
 DECLARE_FUNCTION (execLocalVariable)
 
 DECLARE_FUNCTION (execInstanceVariable)
 
 DECLARE_FUNCTION (execDefaultVariable)
 
 DECLARE_FUNCTION (execLocalOutVariable)
 
 DECLARE_FUNCTION (execInterfaceVariable)
 
 DECLARE_FUNCTION (execClassSparseDataVariable)
 
 DECLARE_FUNCTION (execInterfaceContext)
 
 DECLARE_FUNCTION (execArrayElement)
 
 DECLARE_FUNCTION (execBoolVariable)
 
 DECLARE_FUNCTION (execClassDefaultVariable)
 
 DECLARE_FUNCTION (execEndFunctionParms)
 
 DECLARE_FUNCTION (execNothing)
 
 DECLARE_FUNCTION (execNothingInt32)
 
 DECLARE_FUNCTION (execNothingOp4a)
 
 DECLARE_FUNCTION (execBreakpoint)
 
 DECLARE_FUNCTION (execTracepoint)
 
 DECLARE_FUNCTION (execWireTracepoint)
 
 DECLARE_FUNCTION (execInstrumentation)
 
 DECLARE_FUNCTION (execEndOfScript)
 
 DECLARE_FUNCTION (execReturnNothing)
 
 DECLARE_FUNCTION (execEmptyParmValue)
 
 DECLARE_FUNCTION (execJump)
 
 DECLARE_FUNCTION (execJumpIfNot)
 
 DECLARE_FUNCTION (execAssert)
 
 DECLARE_FUNCTION (execPushExecutionFlow)
 
 DECLARE_FUNCTION (execPopExecutionFlow)
 
 DECLARE_FUNCTION (execComputedJump)
 
 DECLARE_FUNCTION (execPopExecutionFlowIfNot)
 
 DECLARE_FUNCTION (execLet)
 
 DECLARE_FUNCTION (execLetObj)
 
 DECLARE_FUNCTION (execLetWeakObjPtr)
 
 DECLARE_FUNCTION (execLetBool)
 
 DECLARE_FUNCTION (execLetDelegate)
 
 DECLARE_FUNCTION (execLetMulticastDelegate)
 
 DECLARE_FUNCTION (execAddMulticastDelegate)
 
 DECLARE_FUNCTION (execClearMulticastDelegate)
 
 DECLARE_FUNCTION (execEatReturnValue)
 
 DECLARE_FUNCTION (execRemoveMulticastDelegate)
 
 DECLARE_FUNCTION (execSelf)
 
 DECLARE_FUNCTION (execContext)
 
 DECLARE_FUNCTION (execContext_FailSilent)
 
 DECLARE_FUNCTION (execStructMemberContext)
 
 DECLARE_FUNCTION (execVirtualFunction)
 
 DECLARE_FUNCTION (execFinalFunction)
 
 DECLARE_FUNCTION (execLocalVirtualFunction)
 
 DECLARE_FUNCTION (execLocalFinalFunction)
 
 DECLARE_FUNCTION (execStructCmpEq)
 
 DECLARE_FUNCTION (execStructCmpNe)
 
 DECLARE_FUNCTION (execStructMember)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execNotEqual_DelegateDelegate)
 
 DECLARE_FUNCTION (execEqualEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execNotEqual_DelegateFunction)
 
 DECLARE_FUNCTION (execIntConst)
 
 DECLARE_FUNCTION (execInt64Const)
 
 DECLARE_FUNCTION (execUInt64Const)
 
 DECLARE_FUNCTION (execSkipOffsetConst)
 
 DECLARE_FUNCTION (execFloatConst)
 
 DECLARE_FUNCTION (execDoubleConst)
 
 DECLARE_FUNCTION (execStringConst)
 
 DECLARE_FUNCTION (execUnicodeStringConst)
 
 DECLARE_FUNCTION (execTextConst)
 
 DECLARE_FUNCTION (execPropertyConst)
 
 DECLARE_FUNCTION (execObjectConst)
 
 DECLARE_FUNCTION (execSoftObjectConst)
 
 DECLARE_FUNCTION (execFieldPathConst)
 
 DECLARE_FUNCTION (execInstanceDelegate)
 
 DECLARE_FUNCTION (execNameConst)
 
 DECLARE_FUNCTION (execByteConst)
 
 DECLARE_FUNCTION (execIntZero)
 
 DECLARE_FUNCTION (execIntOne)
 
 DECLARE_FUNCTION (execTrue)
 
 DECLARE_FUNCTION (execFalse)
 
 DECLARE_FUNCTION (execNoObject)
 
 DECLARE_FUNCTION (execNullInterface)
 
 DECLARE_FUNCTION (execIntConstByte)
 
 DECLARE_FUNCTION (execRotationConst)
 
 DECLARE_FUNCTION (execVectorConst)
 
 DECLARE_FUNCTION (execVector3fConst)
 
 DECLARE_FUNCTION (execTransformConst)
 
 DECLARE_FUNCTION (execStructConst)
 
 DECLARE_FUNCTION (execSetArray)
 
 DECLARE_FUNCTION (execSetSet)
 
 DECLARE_FUNCTION (execSetMap)
 
 DECLARE_FUNCTION (execArrayConst)
 
 DECLARE_FUNCTION (execSetConst)
 
 DECLARE_FUNCTION (execMapConst)
 
 DECLARE_FUNCTION (execBitFieldConst)
 
 DECLARE_FUNCTION (execNew)
 
 DECLARE_FUNCTION (execClassContext)
 
 DECLARE_FUNCTION (execNativeParm)
 
 DECLARE_FUNCTION (execCast)
 
 DECLARE_FUNCTION (execDynamicCast)
 
 DECLARE_FUNCTION (execMetaCast)
 
 DECLARE_FUNCTION (execInterfaceCast)
 
 DECLARE_FUNCTION (execDoubleToFloatCast)
 
 DECLARE_FUNCTION (execFloatToDoubleCast)
 
 DECLARE_FUNCTION (execObjectToBool)
 
 DECLARE_FUNCTION (execInterfaceToBool)
 
 DECLARE_FUNCTION (execObjectToInterface)
 
 DECLARE_FUNCTION (execInterfaceToInterface)
 
 DECLARE_FUNCTION (execInterfaceToObject)
 
 DECLARE_FUNCTION (execGetDynArrayElement)
 
 DECLARE_FUNCTION (execSetDynArrayElement)
 
 DECLARE_FUNCTION (execGetDynArrayLength)
 
 DECLARE_FUNCTION (execSetDynArrayLength)
 
 DECLARE_FUNCTION (execDynArrayInsert)
 
 DECLARE_FUNCTION (execDynArrayRemove)
 
 DECLARE_FUNCTION (execDynArrayFind)
 
 DECLARE_FUNCTION (execDynArrayFindStruct)
 
 DECLARE_FUNCTION (execDynArrayAdd)
 
 DECLARE_FUNCTION (execDynArrayAddItem)
 
 DECLARE_FUNCTION (execDynArrayInsertItem)
 
 DECLARE_FUNCTION (execDynArrayRemoveItem)
 
 DECLARE_FUNCTION (execDynArraySort)
 
 DECLARE_FUNCTION (execBindDelegate)
 
 DECLARE_FUNCTION (execCallMulticastDelegate)
 
 DECLARE_FUNCTION (execLetValueOnPersistentFrame)
 
 DECLARE_FUNCTION (execCallMathFunction)
 
 DECLARE_FUNCTION (execSwitchValue)
 
 DECLARE_FUNCTION (execArrayGetByRef)
 
 DECLARE_FUNCTION (execAutoRtfmTransact)
 
 DECLARE_FUNCTION (execAutoRtfmStopTransact)
 
 DECLARE_FUNCTION (execAutoRtfmAbortIfNot)
 
void ExecuteUbergraph (int32 EntryPoint)
 
virtual void ValidateGeneratedRepEnums (const TArray< struct FRepRecord > &ClassReps) const
 
virtual uint64 GetNetPushIdDynamic () const
 
- Public Member Functions inherited from UObjectBaseUtility
 UObjectBaseUtility ()
 
 UObjectBaseUtility (EObjectFlags InFlags)
 
void SetFlags (EObjectFlags NewFlags)
 
void ClearFlags (EObjectFlags FlagsToClear)
 
bool HasAnyFlags (EObjectFlags FlagsToCheck) const
 
bool HasAllFlags (EObjectFlags FlagsToCheck) const
 
UE_FORCEINLINE_HINT EObjectFlags GetMaskedFlags (EObjectFlags Mask=RF_AllFlags) const
 
UE_FORCEINLINE_HINT void Mark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT void UnMark (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAnyMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT bool HasAllMarks (EObjectMark Marks) const
 
UE_FORCEINLINE_HINT EObjectMark GetAllMarks () const
 
void MarkAsGarbage ()
 
void ClearGarbage ()
 
UE_FORCEINLINE_HINT void AddToRoot ()
 
UE_FORCEINLINE_HINT void RemoveFromRoot ()
 
UE_FORCEINLINE_HINT bool IsRooted () const
 
UE_FORCEINLINE_HINT int32 GetRefCount () const
 
bool ThisThreadAtomicallyClearedRFUnreachable ()
 
UE_FORCEINLINE_HINT bool IsUnreachable () const
 
UE_FORCEINLINE_HINT bool IsNative () const
 
void SetInternalFlags (EInternalObjectFlags FlagsToSet) const
 
UE_FORCEINLINE_HINT EInternalObjectFlags GetInternalFlags () const
 
UE_FORCEINLINE_HINT bool HasAnyInternalFlags (EInternalObjectFlags FlagsToCheck) const
 
void ClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
bool AtomicallyClearInternalFlags (EInternalObjectFlags FlagsToClear) const
 
COREUOBJECT_API FString GetFullName (const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (const UObject *StopOuter, FString &ResultString, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API void GetFullName (FStringBuilderBase &ResultString, const UObject *StopOuter=NULL, EObjectFullNameFlags Flags=EObjectFullNameFlags::None) const
 
COREUOBJECT_API FString GetPathName (const UObject *StopOuter=NULL) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FString &ResultString) const
 
COREUOBJECT_API void GetPathName (const UObject *StopOuter, FStringBuilderBase &ResultString) const
 
virtual bool CanBeClusterRoot () const
 
virtual COREUOBJECT_API bool CanBeInCluster () const
 
virtual COREUOBJECT_API void CreateCluster ()
 
virtual void OnClusterMarkedAsPendingKill ()
 
COREUOBJECT_API void AddToCluster (UObjectBaseUtility *ClusterRootOrObjectFromCluster, bool bAddAsMutableObject=false)
 
COREUOBJECT_API FString GetFullGroupName (bool bStartWithOuter) const
 
UE_FORCEINLINE_HINT FString GetName () const
 
UE_FORCEINLINE_HINT void GetName (FString &ResultString) const
 
UE_FORCEINLINE_HINT void AppendName (FString &ResultString) const
 
COREUOBJECT_API bool IsPackageExternal () const
 
COREUOBJECT_API void DetachExternalPackage ()
 
COREUOBJECT_API void ReattachExternalPackage ()
 
COREUOBJECT_API UObjectGetOutermostObject () const
 
COREUOBJECT_API UPackageGetPackage () const
 
UE_INTERNAL virtual COREUOBJECT_API UE::Core::FVersePath GetVersePath () const
 
COREUOBJECT_API UPackageGetOutermost () const
 
COREUOBJECT_API bool MarkPackageDirty () const
 
COREUOBJECT_API bool IsTemplate (EObjectFlags TemplateTypes=RF_ArchetypeObject|RF_ClassDefaultObject) const
 
COREUOBJECT_API UObjectGetTypedOuter (UClass *Target) const
 
template<typename T >
T * GetTypedOuter () const
 
template<typename InterfaceClassType >
InterfaceClassTypeGetImplementingOuter () const
 
COREUOBJECT_API UObjectBaseUtilityGetImplementingOuterObject (const UClass *InInterfaceClass) const
 
COREUOBJECT_API bool IsIn (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsIn (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInOuter (const UObject *SomeOuter) const
 
COREUOBJECT_API bool IsInPackage (const UPackage *SomePackage) const
 
COREUOBJECT_API bool IsInA (const UClass *SomeBaseClass) const
 
COREUOBJECT_API bool RootPackageHasAnyFlags (uint32 CheckFlagMask) const
 
template<typename OtherClassType >
bool IsA (OtherClassType SomeBase) const
 
template<class T >
bool IsA () const
 
COREUOBJECT_API const UClassFindNearestCommonBaseClass (const UClass *TestClass) const
 
COREUOBJECT_API voidGetInterfaceAddress (UClass *InterfaceClass)
 
COREUOBJECT_API voidGetNativeInterfaceAddress (UClass *InterfaceClass)
 
const voidGetNativeInterfaceAddress (UClass *InterfaceClass) const
 
COREUOBJECT_API bool IsTemplateForSubobjects (EObjectFlags TemplateTypes=RF_ClassDefaultObject|RF_DefaultSubObject|RF_InheritableComponentTemplate) const
 
COREUOBJECT_API bool IsDefaultSubobject () const
 
COREUOBJECT_API class FLinkerLoadGetLinker () const
 
COREUOBJECT_API int32 GetLinkerIndex () const
 
COREUOBJECT_API FPackageFileVersion GetLinkerUEVersion () const
 
int32 GetLinkerUE4Version () const
 
COREUOBJECT_API int32 GetLinkerLicenseeUEVersion () const
 
int32 GetLinkerLicenseeUE4Version () const
 
COREUOBJECT_API int32 GetLinkerCustomVersion (FGuid CustomVersionKey) const
 
UE_FORCEINLINE_HINT bool operator< (const UObjectBaseUtility &Other) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
- Public Member Functions inherited from UObjectBase
COREUOBJECT_API UObjectBase (UClass *InClass, EObjectFlags InFlags, EInternalObjectFlags InInternalFlags, UObject *InOuter, FName InName, int32 InInternalIndex=-1, int32 InSerialNumber=0, FRemoteObjectId InRemoteId=FRemoteObjectId())
 
virtual COREUOBJECT_API ~UObjectBase ()
 
COREUOBJECT_API bool IsValidLowLevel () const
 
COREUOBJECT_API bool IsValidLowLevelFast (bool bRecursive=true) const
 
FORCEINLINE uint32 GetUniqueID () const
 
FORCEINLINE UClassGetClass () const
 
FORCEINLINE UObjectGetOuter () const
 
FORCEINLINE FName GetFName () const
 
virtual COREUOBJECT_API FName GetFNameForStatID () const
 
COREUOBJECT_API UPackageGetExternalPackage () const
 
COREUOBJECT_API void SetExternalPackage (UPackage *InPackage)
 
COREUOBJECT_API UPackageGetExternalPackageInternal () const
 
COREUOBJECT_API void MarkAsReachable () const
 
COREUOBJECT_API void AddRef () const
 
COREUOBJECT_API void ReleaseRef () const
 
FORCEINLINE EObjectFlags GetFlags () const
 
FORCENOINLINE void AtomicallySetFlags (EObjectFlags FlagsToAdd)
 
FORCENOINLINE void AtomicallyClearFlags (EObjectFlags FlagsToClear)
 

Protected Member Functions

virtual UE_API void InitializeInternal (UObject &Owner, const TSharedRef< FMassEntityManager > &EntityManager)
 
virtual UE_API void ConfigureQueries (const TSharedRef< FMassEntityManager > &EntityManager)
 
virtual UE_API void PostInitProperties () override
 
virtual UE_API void Execute (FMassEntityManager &EntityManager, FMassExecutionContext &Context)
 
- Protected Member Functions inherited from UObject
virtual FString GetDetailedInfoInternal () const
 
COREUOBJECT_API bool CanCheckDefaultSubObjects (bool bForceCheck, bool &bResult) const
 
virtual COREUOBJECT_API bool CheckDefaultSubobjectsInternal () const
 
- Protected Member Functions inherited from UObjectBase
 UObjectBase ()
 
COREUOBJECT_API UObjectBase (EObjectFlags InFlags)
 
COREUOBJECT_API void LowLevelRename (FName NewName, UObject *NewOuter=NULL)
 
virtual void RegisterDependencies ()
 
COREUOBJECT_API void Register (class UClass *(*StaticClassFn)(), const TCHAR *PackageName, const TCHAR *Name)
 
COREUOBJECT_API void Register (const TCHAR *PackageName, const TCHAR *Name)
 
virtual COREUOBJECT_API void DeferredRegister (UClass *UClassStaticClass, const TCHAR *PackageName, const TCHAR *Name)
 
FORCEINLINE void SetFlagsTo (EObjectFlags NewFlags)
 

Protected Attributes

FMassProcessorExecutionOrder ExecutionOrder
 
EMassProcessingPhase ProcessingPhase = EMassProcessingPhase::PrePhysics
 
uint8 ExecutionFlags
 
uint8 bAutoRegisterWithProcessingPhases: 1 = true
 
uint8 bAllowMultipleInstances: 1 = false
 
uint8 bRequiresGameThreadExecution: 1 = false
 
int16 ExecutionPriority = 0
 
EMassQueryBasedPruning QueryBasedPruning = EMassQueryBasedPruning::Default
 
friend UMassCompositeProcessor
 
friend FMassDebugger
 
FMassSubsystemRequirements ProcessorRequirements
 
TSharedPtr< UE::Mass::FQueryExecutorAutoExecuteQuery
 

Additional Inherited Members

- Public Types inherited from UObject
enum class  ENetFields_Private { NETFIELD_REP_START = 0 , NETFIELD_REP_END = -1 }
 
typedef UObject WithinClass
 
- Static Public Member Functions inherited from UObject
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedServer (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API void UpdateClassesExcludedFromDedicatedClient (const TArray< FString > &InClassNames, const TArray< FString > &InModulesNames)
 
static COREUOBJECT_API bool CanCreateInCurrentContext (UObject *Template)
 
static COREUOBJECT_API void AddReferencedObjects (UObject *InThis, FReferenceCollector &Collector)
 
static COREUOBJECT_API const FNameSourceFileTagName ()
 
static COREUOBJECT_API UObjectGetArchetypeFromRequiredInfo (const UClass *Class, const UObject *Outer, FName Name, EObjectFlags ObjectFlags)
 
- Static Public Member Functions inherited from UObjectBaseUtility
static bool IsGarbageEliminationEnabled ()
 
static bool IsPendingKillEnabled ()
 
static void SetGarbageEliminationEnabled (bool bEnabled)
 
static COREUOBJECT_API void ReloadObjectsFromModifiedConfigSections (const class FConfigModificationTracker *ChangeTracker)
 
- Static Public Member Functions inherited from UObjectBase
static COREUOBJECT_API FString RemoveClassPrefix (const TCHAR *ClassName)
 
static void PrefetchClass (UObject *Object)
 
static void PrefetchOuter (UObject *Object)
 

Constructor & Destructor Documentation

◆ UMassProcessor() [1/2]

UMassProcessor::UMassProcessor ( )

◆ UMassProcessor() [2/2]

UMassProcessor::UMassProcessor ( const FObjectInitializer ObjectInitializer)
explicit

Member Function Documentation

◆ CallExecute()

void UMassProcessor::CallExecute ( FMassEntityManager EntityManager,
FMassExecutionContext Context 
)

◆ CallInitialize()

void UMassProcessor::CallInitialize ( const TNotNull< UObject * >  Owner,
const TSharedRef< FMassEntityManager > &  EntityManager 
)

Calls InitializeInternal and handles initialization bookkeeping.

◆ ConfigureQueries() [1/2]

virtual void UMassProcessor::ConfigureQueries ( )
inlinefinalvirtual

◆ ConfigureQueries() [2/2]

void UMassProcessor::ConfigureQueries ( const TSharedRef< FMassEntityManager > &  EntityManager)
protectedvirtual

Called internally during processor's initialization so that child classes configure their owned queries with requirements. This function is called before the processor gets considered by Mass dependency solver, and the requirement information stored in queries is crucial for that process.

Reimplemented in UMassCompositeProcessor, UMassRelationObserver, and UMassRelationRoleDestruction.

◆ DebugOutputDescription() [1/2]

void UMassProcessor::DebugOutputDescription ( FOutputDevice Ar) const
inline

◆ DebugOutputDescription() [2/2]

void UMassProcessor::DebugOutputDescription ( FOutputDevice Ar,
int32  Indent 
) const
virtual

Reimplemented in UMassCompositeProcessor.

◆ DispatchProcessorTasks()

FGraphEventRef UMassProcessor::DispatchProcessorTasks ( const TSharedPtr< FMassEntityManager > &  EntityManager,
FMassExecutionContext ExecutionContext,
const FGraphEventArray Prerequisites = FGraphEventArray() 
)
virtual

Reimplemented in UMassCompositeProcessor.

◆ DoesAnyArchetypeMatchOwnedQueries()

bool UMassProcessor::DoesAnyArchetypeMatchOwnedQueries ( const FMassEntityManager EntityManager)

◆ DoesRequireGameThreadExecution()

bool UMassProcessor::DoesRequireGameThreadExecution ( ) const
inline

◆ Execute()

void UMassProcessor::Execute ( FMassEntityManager EntityManager,
FMassExecutionContext Context 
)
protectedvirtual

Called during the processing phase to which this processor is registered. Default implementation requires that AutoExecuteQuery is populated with a QueryExecutor.

Reimplemented in UMassCompositeProcessor, UMassRelationEntityCreation, UMassRelationEntityGuardDog, UMassRelationEntityDestruction, UMassRelationRoleDestruction, and UMassChildOfRelationEntityCreation.

◆ ExportRequirements()

void UMassProcessor::ExportRequirements ( FMassExecutionRequirements OutRequirements) const
virtual

By default, fetches requirements declared entity queries registered via RegisterQuery. Processors can override this function to supply additional requirements

◆ GetArchetypesMatchingOwnedQueries()

void UMassProcessor::GetArchetypesMatchingOwnedQueries ( const FMassEntityManager EntityManager,
TArray< FMassArchetypeHandle > &  OutArchetype 
)

◆ GetExecutionFlags()

EProcessorExecutionFlags UMassProcessor::GetExecutionFlags ( ) const
inline

◆ GetExecutionOrder()

const FMassProcessorExecutionOrder & UMassProcessor::GetExecutionOrder ( ) const
inline

◆ GetExecutionPriority()

int16 UMassProcessor::GetExecutionPriority ( ) const
inline
Returns
the current value of ExecutionPriority
See also
SetExecutionPriority
ExecutionPriority

◆ GetOwnedQueriesNum()

int32 UMassProcessor::GetOwnedQueriesNum ( ) const
inline

◆ GetProcessingPhase()

EMassProcessingPhase UMassProcessor::GetProcessingPhase ( ) const
virtual

◆ GetProcessorName()

FString UMassProcessor::GetProcessorName ( ) const
virtual

Reimplemented in UMassCompositeProcessor.

◆ GetProcessorRequirements()

const FMassSubsystemRequirements & UMassProcessor::GetProcessorRequirements ( ) const
inline

◆ Initialize()

void UMassProcessor::Initialize ( UObject Owner)
finalvirtual

◆ InitializeInternal()

void UMassProcessor::InitializeInternal ( UObject Owner,
const TSharedRef< FMassEntityManager > &  EntityManager 
)
protectedvirtual

Called to initialize the processor's internal state. Override to perform custom steps.

Reimplemented in UMassRelationObserver, and UMassCompositeProcessor.

◆ IsActive()

bool UMassProcessor::IsActive ( ) const
inline

◆ IsDynamic()

bool UMassProcessor::IsDynamic ( ) const
inline

◆ IsInitialized()

bool UMassProcessor::IsInitialized ( ) const
inline

◆ MakeActive()

void UMassProcessor::MakeActive ( )
inline

Marks processor as "Active" (

See also
ActivationState for details). If called during Mass processing the call will take effect next phase.

◆ MakeInactive()

void UMassProcessor::MakeInactive ( )
inline

Deactivate the processor, it will no longer execute its Execute function.

◆ MakeOneShot()

void UMassProcessor::MakeOneShot ( )
inline

Marks processor as "One Shot" (

See also
ActivationState for details). If called during Mass processing the call will take effect next phase. The processor will auto-disable after execution.

◆ MarkAsDynamic()

void UMassProcessor::MarkAsDynamic ( )
inline

◆ PostInitProperties()

void UMassProcessor::PostInitProperties ( )
overrideprotectedvirtual

Called after the C++ constructor and after the properties have been initialized, including those loaded from config. This is called before any serialization or other setup has happened.

Reimplemented from UObject.

Reimplemented in UMassObserverProcessor.

◆ RegisterQuery()

void UMassProcessor::RegisterQuery ( FMassEntityQuery Query)

Adds Query to RegisteredQueries list. Query is required to be a member variable of this processor. Not meeting this requirement will cause check failure and the query won't be registered.

◆ SetExecutionPriority()

void UMassProcessor::SetExecutionPriority ( const int16  NewExecutionPriority)
inline

Sets new ExecutionPriority for this processor. The change will take effect the next time the processing graph is built Note that at this point this operation does not cause processing graph rebuilding, so this function should be used before processor's initialization or as part of code that will cause processing graph rebuilding anyway.

See also
ExecutionPriority

◆ SetProcessingPhase()

void UMassProcessor::SetProcessingPhase ( EMassProcessingPhase  Phase)
virtual

Reimplemented in UMassCompositeProcessor.

◆ SetShouldAutoRegisterWithGlobalList()

void UMassProcessor::SetShouldAutoRegisterWithGlobalList ( const bool  bAutoRegister)

Sets bAutoRegisterWithProcessingPhases. Setting it to true will result in this processor class being always instantiated to be automatically evaluated every frame.

See also
FMassProcessingPhaseManager Note that calling this function is only valid on CDOs. Calling it on a regular instance will fail an ensure and have no other effect, i.e. CDO's value won't change

◆ ShouldAllowMultipleInstances()

bool UMassProcessor::ShouldAllowMultipleInstances ( ) const
inline

Controls whether there can be multiple instances of a given class in a single FMassRuntimePipeline and during dependency solving.

◆ ShouldAllowQueryBasedPruning()

bool UMassProcessor::ShouldAllowQueryBasedPruning ( const bool  bRuntimeMode = true) const
virtual

Indicates whether this processor can ever be pruned while considered for a phase processing graph. A processor can get pruned if none of its registered queries interact with archetypes instantiated at the moment of graph building. This can also happen for special processors that don't register any queries - if that's the case override this function to return an appropriate value or use QueryBasedPruning to configure the expected behavior. By default, the processor will be the subject of pruning when bRuntimeMode == true.

Parameters
bRuntimeModeindicates whether the pruning is being done for game runtime (true) or editor-time presentation (false)

◆ ShouldAutoAddToGlobalList()

bool UMassProcessor::ShouldAutoAddToGlobalList ( ) const
inline

◆ ShouldExecute()

bool UMassProcessor::ShouldExecute ( const EProcessorExecutionFlags  CurrentExecutionFlags) const
inline

Whether this processor should execute according the CurrentExecutionFlags parameters

Member Data Documentation

◆ AutoExecuteQuery

TSharedPtr<UE::Mass::FQueryExecutor> UMassProcessor::AutoExecuteQuery
protected

A QueryExecutor that can optionally be run in lieu of overriding the Execute function.

◆ bAllowMultipleInstances

uint8 UMassProcessor::bAllowMultipleInstances
protected

Meant as a class property, make sure to set it in subclass' constructor. Controls whether there can be multiple instances of a given class in a single FMassRuntimePipeline and during dependency solving.

◆ bAutoRegisterWithProcessingPhases

uint8 UMassProcessor::bAutoRegisterWithProcessingPhases
protected

Configures whether this processor should be automatically included in the global list of processors executed every tick (see ProcessingPhase and ExecutionOrder).

◆ bRequiresGameThreadExecution

uint8 UMassProcessor::bRequiresGameThreadExecution
protected

◆ ExecutionFlags

uint8 UMassProcessor::ExecutionFlags
protected

Whether this processor should be executed on StandAlone or Server or Client

◆ ExecutionOrder

FMassProcessorExecutionOrder UMassProcessor::ExecutionOrder
protected

Configures when this given processor can be executed in relation to other processors and processing groups, within its processing phase.

◆ ExecutionPriority

int16 UMassProcessor::ExecutionPriority = 0
protected

Denoted how important it is for this processor to be executed as soon as possible within a processing graph. The larger the number the higher the priority. It's used in two ways:

  • used when sorting nodes that otherwise seem similar in terms of "which processor to pick for execution next"
  • affects the priority of the dependencies - if this super-important processor is waiting for processor A and B, then A and B become super important as well.

◆ FMassDebugger

friend UMassProcessor::FMassDebugger
protected

◆ ProcessingPhase

EMassProcessingPhase UMassProcessor::ProcessingPhase = EMassProcessingPhase::PrePhysics
protected

Processing phase this processor will be automatically run as part of. Needs to be set before the processor gets registered with MassProcessingPhaseManager, otherwise it will have no effect. This property is usually read via a given class's CDO, so it's recommended to set it in the constructor.

◆ ProcessorRequirements

FMassSubsystemRequirements UMassProcessor::ProcessorRequirements
protected

A query representing elements this processor is accessing in Execute function outside of query execution

◆ QueryBasedPruning

EMassQueryBasedPruning UMassProcessor::QueryBasedPruning = EMassQueryBasedPruning::Default
protected

Determines whether given processor wants to be pruned from the execution graph when there are no archetypes matching its requirements. Defaults to EMassQueryBasedPruning::Prune,

See also
EMassQueryBasedPruning

◆ UMassCompositeProcessor

friend UMassProcessor::UMassCompositeProcessor
protected

The documentation for this class was generated from the following files: