1. Epic GamesDeveloper
  3. FMassDebugger

FMassDebugger

API > API/Runtime > API/Runtime/MassEntity

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

Syntax

struct FMassDebugger

Structs

Name Remarks
FEnvironment  

Constants

Name Type Remarks Include Path
ActiveEnvironments TArray< FEnvironment >   MassDebugger.h
CommandNames TArray< FName >   MassDebugger.h
EntityManagerRegistrationLock UE::FTransactionallySafeMutex   MassDebugger.h
FragmentsByName TMap< FName, const UScriptStruct * >   MassDebugger.h
OnBreakpointsChangedDelegate FOnBreakpointsChanged   MassDebugger.h
OnDebugEvent FOnDebugEvent   MassDebugger.h
OnEntityManagerDeinitialized FOnMassEntityManagerEvent   MassDebugger.h
OnEntityManagerInitialized FOnMassEntityManagerEvent   MassDebugger.h
OnEntitySelectedDelegate FOnEntitySelected   MassDebugger.h
OnProcessorProviderRegistered FOnEnvironmentEvent   MassDebugger.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

DECLARE_TS_MULTICAST_DELEGATE ( FOnBreakpointsChanged
)

   MassDebugger.h  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FOnEnvironmentEvent,
const FEnvironment&
)

   MassDebugger.h  

DECLARE_TS_MULTICAST_DELEGATE_OneParam ( FOnMassEntityManagerEvent,
const FMassEntityManager&
)

   MassDebugger.h  

DECLARE_TS_MULTICAST_DELEGATE_ThreeParams ( FOnDebugEvent,
const FName,
FConstStructView,
const EMassDebugMessageSeverity
)

   MassDebugger.h  

DECLARE_TS_MULTICAST_DELEGATE_TwoParams ( FOnEntitySelected,
const FMassEntityManager&,
const FMassEntityHandle
)

   MassDebugger.h  

Static

Name Remarks Include Path Unreal Specifiers

static void BreakOnFragmentWriteForSelectedEntity ( FName FragmentName
)

 Sets a write breakpoint for the specified fragment on the selcected entity MassDebugger.h  

static void ClearAllBreakpoints()

 Clears all breakpoints in all environments. MassDebugger.h  

static void ClearAllEntityBreakpoints ( const FMassEntityManager& EntityManager,
FMassEntityHandle Entity
)

 Clears all breakpoints set for a given entity. MassDebugger.h  

static void ClearAllFragmentWriteBreak ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType
)

 Clears all write breakpoints set for a given fragment type. MassDebugger.h  

static void ClearAllProcessorBreakpoints ( const FMassEntityManager& EntityManager,
const UMassProcessor* Processor
)

 Clears all breakpoints set for a given processor. MassDebugger.h  

static void ClearFragmentWriteBreak ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity
)

 Clears a fragment write breakpoint for a given fragment type and entity. MassDebugger.h  

static void ClearProcessorBreakpoint ( const FMassEntityManager& EntityManager,
const UMassProcessor* Processor,
FMassEntityHandle Entity
)

 Clears a breakpoint triggered on processor execute for an entity. MassDebugger.h  

static UE::Mass::Debug::FBreakpoint & CreateBreakpoint ( const FMassEntityManager& EntityManager
)

 Create a default-constructed breakpoint MassDebugger.h  

static void DebugEvent ( const FName EventName,
FConstStructView Payload,
const EMassDebugMessageSeverity SeverityOverride
)

   MassDebugger.h  

static void DebugEvent ( TArgs&&... InArgs
)

   MassDebugger.h  

static bool DoesArchetypeMatchRequirements ( const FMassArchetypeHandle& ArchetypeHandle,
const FMassFragmentRequirements& Requirements,
FOutputDevice& OutputDevice
)

 Determines whether given Archetype matches given Requirements. MassDebugger.h  

static void EnumerateChunks ( const FMassArchetypeData& Archetype,
TFunctionRef< void(const FMassArchetypeChunk&)> Fn
)

   MassDebugger.h  

static UE::Mass::Debug::FBreakpoint * FindBreakpoint ( const FMassEntityManager& EntityManager,
UE::Mass::Debug::FBreakpointHandle Handle
)

 Find a breakpoint by Handle. Returns the pointer to the Breakpoint, or nullptr if none found. MassDebugger.h  

static FEnvironment * FindEnvironmentForEntityManager ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static void ForEachArchetype ( const FMassEntityManager& EntityManager,
const UE::Mass::Debug::FArchetypeFunction& Function
)

   MassDebugger.h  

static FEnvironment * GetActiveEnvironment ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static FEnvironment & GetActiveEnvironmentChecked ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static TArray< FMassArchetypeHandle > GetAllArchetypes ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static const FMassArchetypeCompositionDescriptor & GetArchetypeComposition ( const FMassArchetypeHandle& ArchetypeHandle
)

   MassDebugger.h  

static const FMassArchetypeData * GetArchetypeData ( const FMassArchetypeHandle& ArchetypeHandle
)

   MassDebugger.h  

static const TConstArrayView< FName > GetArchetypeDebugNames ( const FMassArchetypeHandle& ArchetypeHandle
)

   MassDebugger.h  

static void GetArchetypeEntityStats ( const FMassArchetypeHandle& ArchetypeHandle,
UE::Mass::Debug::FArchetypeStats& OutStats
)

   MassDebugger.h  
  MassDebugger.h  
  MassDebugger.h  

static uint64 GetArchetypeTraceID ( const FMassArchetypeData& ArchetypeData
)

   MassDebugger.h  

static uint64 GetArchetypeTraceID ( const FMassArchetypeHandle& ArchetypeHandle
)

   MassDebugger.h  

static TArray< UE::Mass::Debug::FBreakpoint > & GetBreakpoints ( const FMassEntityManager& EntityManager
)

 Get all the breakpoints for a given environment. MassDebugger.h  

static bool GetConstSharedFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity,
TSharedPtr< FStructOnScope >& OutStructData
)

 Finds the const shared fragment data of the specified type in the entity data. MassDebugger.h  

static TSharedPtr< FStructOnScope > GetConstSharedFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity
)

 Finds the const shared fragment data of the specified type in the entity data. MassDebugger.h  

static TArray< FMassEntityHandle > GetEntitiesMatchingQuery ( const FMassEntityManager& EntityManager,
const FMassEntityQuery& Query
)

   MassDebugger.h  

static TArray< FMassEntityHandle > GetEntitiesOfArchetype ( const FMassArchetypeHandle& ArchetypeHandle
)

   MassDebugger.h  

static TConstArrayView< FMassEntityHandle > GetEntitiesViewOfArchetype ( const FMassArchetypeData& ArchetypeData,
const FMassArchetypeChunk& Chunk
)

   MassDebugger.h  

static TConstArrayView< FEnvironment > GetEnvironments()

   MassDebugger.h  

static bool GetFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity,
TSharedPtr< FStructOnScope >& OutStructData
)

 Finds the fragment data of the specified type in the entity data. Returns false if not found. MassDebugger.h  

static TSharedPtr< FStructOnScope > GetFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity
)

 Finds the fragment data of the specified type in the entity data. Returns nullptr if not found. MassDebugger.h  

static const UScriptStruct * GetFragmentTypeFromName ( FName FragmentName
)

 Gets the UScriptStruct type for fragment of the specified name. MassDebugger.h  

static FMassEntityHandle GetHighlightedEntity ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static TConstArrayView< TObjectPtr< UMassProcessor > > GetHostedProcessors ( const UMassCompositeProcessor& GraphOwner
)

   MassDebugger.h  

static TConstArrayView< UMassCompositeProcessor::FDependencyNode > GetProcessingGraph ( const UMassCompositeProcessor& GraphOwner
)

   MassDebugger.h  

static TConstArrayView< FMassEntityQuery * > GetProcessorQueries ( const UMassProcessor& Processor
)

   MassDebugger.h  

static void GetQueryExecutionRequirements ( const FMassEntityQuery& Query,
FMassExecutionRequirements& OutExecutionRequirements
)

   MassDebugger.h  

static UE::Mass::Debug::FQueryRequirementsView GetQueryRequirements ( const FMassEntityQuery& Query
)

   MassDebugger.h  

static FString GetRequirementsDescription ( const FMassFragmentRequirements& Requirements
)

   MassDebugger.h  

static FMassEntityHandle GetSelectedEntity ( const FMassEntityManager& EntityManager
)

   MassDebugger.h  

static bool GetSharedFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity,
TSharedPtr< FStructOnScope >& OutStructData
)

 Finds the shared fragment data of the specified type in the entity data. MassDebugger.h  

static TSharedPtr< FStructOnScope > GetSharedFragmentData ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType,
FMassEntityHandle Entity
)

 Finds the shared fragment data of the specified type in the entity data. MassDebugger.h  

static const FMassArchetypeSharedFragmentValues & GetSharedFragmentValues ( const FMassEntityManager& EntityManager,
FMassEntityHandle Entity
)

 Get the shared fragment value container for this entity MassDebugger.h  

static FString GetSingleRequirementDescription ( const FMassFragmentRequirementDescription& Requirement
)

   MassDebugger.h  

static TConstArrayView< FMassEntityQuery * > GetUpToDateProcessorQueries ( const FMassEntityManager& EntityManager,
UMassProcessor& Processor
)

 Fetches all queries registered for given Processor. MassDebugger.h  

static bool HasAnyFragmentWriteBreakpoints ( const FMassEntityManager& EntityManager,
const UScriptStruct* FragmentType
)

 Checks if there are any breakpoints set for writing a fragment for any entity Use FragmentType = nullptr (default) to check for ANY fragment types. MassDebugger.h  

static bool HasAnyProcessorBreakpoints ( const FMassEntityManager& EntityManager,
const UMassProcessor* Processor
)

 Checks if a processor has any breakpoints set for any entity. MassDebugger.h  

static void HighlightEntity ( const FMassEntityManager& EntityManager,
const FMassEntityHandle EntityHandle
)

   MassDebugger.h  

static bool IsEntityManagerInitialized ( const FMassEntityManager& EntityManager
)

 Confirms that the initialization state of the EntityManager is Initialized. MassDebugger.h  

static void OutputArchetypeDescription ( FOutputDevice& Ar,
const FMassArchetypeHandle& Archetype
)

   MassDebugger.h  

static void OutputEntityDescription ( FOutputDevice& Ar,
const FMassEntityManager& EntityManager,
const int32 EntityIndex,
const TCHAR* InPrefix
)

   MassDebugger.h  

static void OutputEntityDescription ( FOutputDevice& Ar,
const FMassEntityManager& EntityManager,
const FMassEntityHandle Entity,
const TCHAR* InPrefix
)

   MassDebugger.h  

static void RefreshBreakpoints()

 Refresh breakpoint flags after changes to breakpoint instances. MassDebugger.h  

static int32 RegisterEntityManager ( FMassEntityManager& EntityManager
)

 Registers given EntityManager with the debugger, creating a new entry in ActiveEnvironments. MassDebugger.h  

static void RegisterProcessorDataProvider ( FName ProviderName,
const TSharedRef< FMassEntityManager >& EntityManager,
const UE::Mass::Debug::FProcessorProviderFunction& ProviderFunction
)

 Registers the given ProviderFunction with the existing FEnvironment associated with the provided EntityManager. MassDebugger.h  

static void RemoveBreakpoint ( UE::Mass::Debug::FBreakpointHandle Handle
)

 Remove a single breakpoint by Id MassDebugger.h  

static void SelectEntity ( const FMassEntityManager& EntityManager,
const FMassEntityHandle EntityHandle
)

   MassDebugger.h  

static void SetBreakpointEnabled ( UE::Mass::Debug::FBreakpointHandle Handle,
bool bEnable
)

 Enable or Disable a breakpoint with a given Id. MassDebugger.h  

static void SetFragmentWriteBreakForSelectedEntity ( const FMassEntityManager& EntityManager,
TNotNull< const UScriptStruct* > FragmentType
)

 Sets or removes a break before a write to a given fragment on whichever entity is selected at the time. MassDebugger.h  

static void SetFragmentWriteBreakpoint ( const FMassEntityManager& EntityManager,
TNotNull< const UScriptStruct* > FragmentType,
FMassEntityHandle Entity
)

 Sets a break to be triggered for a processor that's about to write a given fragment on an entity. MassDebugger.h  

static void SetProcessorBreakpoint ( const FMassEntityManager& EntityManager,
TNotNull< const UMassProcessor* >,
FMassEntityHandle Entity
)

 Sets a break to be triggered on processor execute for an entity. MassDebugger.h  
Checks if a break should be triggered for a processor that's about to write a given fragment on an entity. MassDebugger.h  
Checks if a processor should break on execute for a given entity. MassDebugger.h  

static void ShutdownDebugger()

 Destroy all debug environments and shutdown cleanly. MassDebugger.h  

static void UnregisterEntityManager ( FMassEntityManager& EntityManager
)

   MassDebugger.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page