Navigation
Unreal Engine C++ API Reference > Runtime > Analytics
Inheritance Hierarchy
- IModuleInterface
- FAnalytics
References
Module | Analytics |
Header | /Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h |
Include | #include "Analytics.h" |
Syntax
class FAnalytics : public IModuleInterface
Remarks
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().
Constructors
Type | Name | Description | |
---|---|---|---|
![]() |
FAnalytics () |
Module functionality. |
Destructors
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
~FAnalytics () |
Functions
Type | Name | Description | |
---|---|---|---|
![]() ![]() |
TSharedPtr< IAnalyticsProvider > | CreateAnalyticsProvider
(
const FName& ProviderModuleName, |
Provider Factory functions. |
![]() ![]() |
FAnalytics & | Get () |
Singleton-like access to this module's interface. |
![]() ![]() |
FString | GetConfigValueFromIni
(
const FString& IniName, |
Helper for reading configuration values from an INI file (which will be a common scenario). |
![]() ![]() |
TSharedPtr< IAnalyticsProvider > | Creates an instance of the default configured analytics provider. | |
![]() ![]() |
bool | IsAvailable () |
Checks to see if this module is loaded and ready. |
![]() ![]() |
void | WriteConfigValueToIni
(
const FString& IniName, |
Helper for writing configuration values from to an INI file (which will be a common scenario). |
Classes
Type | Name | Description | |
---|---|---|---|
![]() |
ConfigFromIni | Configuration helper classes and methods. |