FTrackedActivity | Unreal Engine 5.4 Documentation

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

Inheritance Hierarchy

TSharedFromThis
FTrackedActivity

References


Module	Core
Header	/Engine/Source/Runtime/Core/Public/Misc/TrackedActivity.h
Include	#include "Misc/TrackedActivity.h"

Syntax

class FTrackedActivity : public TSharedFromThis< FTrackedActivity >

Remarks

Tracked Activity is used to be able to visualize on a semi-high level what is going on in the process. It is very useful when wanting to show the status of online, or if the runtime is waiting on loading something When new console is enabled tracked activities show at the bottom of the window under the log Tracked Activities can be created/updated/destroyed on multiple threads

Constructors

	Type	Name	Description
		FTrackedActivity ( const TCHAR* Name, const TCHAR* Status, ELight Light, EType Type, int32 SortValue )	Ctor

Destructors

	Type	Name	Description
		~FTrackedActivity ()	Dtor

Functions

Type	Name	Description
FTrackedActivity &	GetEngineActivity ()	Process Engine Activity.
FTrackedActivity &	GetIOActivity ()	I/O Activity.Shows current I / O operation.If plugin / game have their own I / O, scopes will need to be manually added
void	Pop ()
uint32	Push ( const TCHAR* Status, bool bShowParent, ELight Light )	Pushes new status on to tracked activity, will require a pop to get back to previous status ShowParent can be used to make sure Status of parent is visible in front of status of pushed scope.
void	RegisterEventListener ( TUniqueFunction< void(EEventEvent, const FInfo&Info)>&& Func, uint32 MaxDepth )	Register listener that can track adds, removes and changes when they happen.
void	TraverseActivities ( const TFunction< void(const FInfo&Info)>& Func )	Traverses all FTrackedActivities in the order they were added.
void	Update ( const TCHAR* Status, uint32 Index )	Updates status. If Index is ~0u entry at top of stack will be updated (which is the one showing)
void	Update ( ELight Light, uint32 Index )
void	Update ( const TCHAR* Status, ELight Light, uint32 Index )

Classes

	Type	Name	Description
	FInfo

Enums

	Type	Name	Description
	EEvent	Enum used for Event listener to identify type of activity change
	EType	Enum to specify status type of activity In the new console, 'Activity' will make sure tracked activity appears to the left of the window 'Info' appears to the right and use less width.

Typedefs

Name	Description
ELight

Navigation