Navigation
API > API/Runtime > API/Runtime/Analytics
The public interface for interacting with analytics. The basic usage is to call CreateAnalyticsProvider and supply a configuration delegate. Specific analytics providers may choose to provide strongly-typed factory methods for configuration, in which case you are free to call that directly if you know exactly what provider you will be using. This class merely facilitates loosely bound provider configuration so the provider itself can be configured purely via config.
BuildType methods exist as a common way for an analytics provider to configure itself for debug/development/playtest/release scenarios. Again, you can choose to ignore this info and provide a generic configuration delegate that does anything it wants.
To create an analytics provider using all the system defaults, simply call the static GetDefaultConfiguredProvider().
| Name | FAnalytics |
| Type | class |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h |
| Include Path | #include "Analytics.h" |
Syntax
class FAnalytics : public IModuleInterface
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FAnalytics() |
Module functionality. | Analytics.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FAnalytics() |
Analytics.h |
Structs
| Name | Remarks |
|---|---|
| ConfigFromIni | Configuration helper classes and methods. |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< IAnalyticsProvider > CreateAnalyticsProvider
(
const FName& ProviderModuleName, |
Provider Factory functions. | Analytics.h | |
virtual TSharedPtr< IAnalyticsTracer > CreateAnalyticsTracer() |
Analytics.h | ||
virtual FString GetConfigValueFromIni
(
const FString& IniName, |
Helper for reading configuration values from an INI file (which will be a common scenario). | Analytics.h | |
virtual TSharedPtr< IAnalyticsProvider > GetDefaultConfiguredProvider () |
Creates an instance of the default configured analytics provider. | Analytics.h | |
virtual void WriteConfigValueToIni
(
const FString& IniName, |
Helper for writing configuration values from to an INI file (which will be a common scenario). | Analytics.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FAnalytics & Get () |
Singleton-like access to this module's interface. | Analytics.h | |
static bool IsAvailable () |
Checks to see if this module is loaded and ready. | Analytics.h |