Navigation
API > API/Editor > API/Editor/EditorToolEvents
Collects editor events we wish to send as a summary that are not critical enough to be in our summary store.
| Name | FEditorUsageAnalyticsSummary |
| Type | class |
| Header File | /Engine/Source/Editor/EditorToolEvents/Public/EditorUsageAnalyticsSummary.h |
| Include Path | #include "EditorUsageAnalyticsSummary.h" |
Syntax
class FEditorUsageAnalyticsSummary : private FNoncopyable
Inheritance Hierarchy
- FNoncopyable → FEditorUsageAnalyticsSummary
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEditorUsageAnalyticsSummary() |
EditorUsageAnalyticsSummary.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FEditorUsageAnalyticsSummary() |
EditorUsageAnalyticsSummary.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bActive | bool | EditorUsageAnalyticsSummary.h | ||
| FocusedWindows | TMap< FString, FFocusedWindowAnalyticData > | EditorUsageAnalyticsSummary.h | ||
| NextUpdateTimeSeconds | double | The next time the session properties should be persisted to disk. | EditorUsageAnalyticsSummary.h | |
| StoreLock | FTransactionallySafeCriticalSection | Slate interaction and shutting down can come from different threads so we need a log for FocusedWindow data. | EditorUsageAnalyticsSummary.h | |
| TimeOfLastUpdate | std::atomic< double > | Time since we last updated our focus stats. | EditorUsageAnalyticsSummary.h | |
| UpdatePeriod | FTimespan | Period we want to wait between focus time updates (some events might lead us to update sooner) | EditorUsageAnalyticsSummary.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FJsonObject > GetSummaryDataAsJsonObject
(
bool bReset |
Get's the current usage summary. If bReset is true, clears out current summary. (useful when collecting summaries per project instead of session) | EditorUsageAnalyticsSummary.h | |
bool IsActive() |
Returns true if start has been called. Makes it so we can still check the summary even if the CVAR to turn it off is true or otherwise disabled. | EditorUsageAnalyticsSummary.h | |
void Shutdown() |
EditorUsageAnalyticsSummary.h | ||
void Start() |
EditorUsageAnalyticsSummary.h |
Public Virtual
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FEditorUsageAnalyticsSummary & Get() |
EditorUsageAnalyticsSummary.h |