1. Epic GamesDeveloper
  3. FTrackedActivity

FTrackedActivity

Tracked Activity is used to be able to visualize on a semi-high level what is going on in the process.

API > API/Runtime > API/Runtime/Core

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

   
Name FTrackedActivity
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/TrackedActivity.h
Include Path #include "Misc/TrackedActivity.h"

Syntax

class FTrackedActivity : public TSharedFromThis< FTrackedActivity >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers
  Misc/TrackedActivity.h  

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

 Ctor Misc/TrackedActivity.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FTrackedActivity()

 Dtor Misc/TrackedActivity.h  

Structs

Name Remarks
FInfo  

Enums

Public

Name Remarks
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 Type Remarks Include Path
ELight ETrackedActivityLight   Misc/TrackedActivity.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Internal void *   Misc/TrackedActivity.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Pop()

   Misc/TrackedActivity.h  

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. Misc/TrackedActivity.h  

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) Misc/TrackedActivity.h  

void Update ( ELight Light,
uint32 Index
)

   Misc/TrackedActivity.h  

void Update ( const TCHAR* Status,
ELight Light,
uint32 Index
)

   Misc/TrackedActivity.h  

Static

Name Remarks Include Path Unreal Specifiers
Process Engine Activity. Misc/TrackedActivity.h  

static 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 Misc/TrackedActivity.h  

static void RegisterEventListener ( TUniqueFunction< void(EEventEvent, const FInfo&Info)>&& Func,
uint32 MaxDepth
)

 Register listener that can track adds, removes and changes when they happen. Misc/TrackedActivity.h  

static void TraverseActivities ( const TFunction< void(const FInfo&Info)>& Func
)

 Traverses all FTrackedActivities in the order they were added. Misc/TrackedActivity.h  

static void UnregisterEventListener()

   Misc/TrackedActivity.h  

Operators

Name Remarks Include Path Unreal Specifiers

FTrackedActivity & operator= ( const FTrackedActivity& O
)

   Misc/TrackedActivity.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page