Navigation
API > API/Runtime > API/Runtime/Engine
The public interface for the editor's analytics provider singleton.
WARNING: This is an analytics provider instance that is created whenever UE editor is launched. It is intended ONLY for use by Epic Games. This is NOT intended for games to send game-specific telemetry. Create your own provider instance for your game and configure it independently.
It is called FEngineAnalytics for legacy reasons, and is only used for editor telemetry.
| Name | FEngineAnalytics |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/EngineAnalytics.h |
| Include Path | #include "EngineAnalytics.h" |
Syntax
class FEngineAnalytics : private FNoncopyable
Inheritance Hierarchy
- FNoncopyable → FEngineAnalytics
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Analytics | TSharedPtr< IAnalyticsProviderET > | EngineAnalytics.h | |
| bIsInitialized | bool | EngineAnalytics.h | |
| OnInitializeEngineAnalytics | FSimpleMulticastDelegate | A hook for analytics initialization after the SummaryManager is initialized | EngineAnalytics.h |
| OnShutdownEngineAnalytics | FSimpleMulticastDelegate | A hook for analytics shutdown before the SummaryManager is shutdown | EngineAnalytics.h |
| SessionEpicAccountIds | TSet< FString > | EngineAnalytics.h |
Functions
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AppendMachineStats
(
TArray< FAnalyticsEventAttribute >& EventAttributes |
EngineAnalytics.h | ||
static IAnalyticsProviderET & GetProvider () |
Return the provider instance. | EngineAnalytics.h | |
static FAnalyticsSessionSummaryManager & GetSummaryManager() |
This is intended ONLY for use by Epic Games so that plugins can append to the session summary. | EngineAnalytics.h | |
static void Initialize() |
Called to initialize the singleton. | EngineAnalytics.h | |
static bool IsAvailable() |
Helper function to determine if the provider is valid. | EngineAnalytics.h | |
static void LowDriveSpaceDetected() |
EngineAnalytics.h | ||
static void OnEpicAccountIdChanged
(
const FString& EpicAccountId |
EngineAnalytics.h | ||
static void SendMachineInfoForAccount
(
const FString& EpicAccountId |
EngineAnalytics.h | ||
static void Shutdown
(
bool bIsEngineShutdown |
Called to shut down the singleton | EngineAnalytics.h | |
static void Tick
(
float DeltaTime |
EngineAnalytics.h |