Navigation
API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/FAnalytics
References
| Module | Analytics |
| Header | /Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h |
| Include | #include "Analytics.h" |
Syntax
struct ConfigFromIni
Remarks
A common way of configuring is from Inis, so this class supports that notion directly by providing a configuration class with a method suitable to be used as an FAnalyticsProviderConfigurationDelegate that reads values from the specified ini and section (based on the BuildType). Also provides a default location to store a provider name, accessed via GetDefaultProviderModuleName().
Variables
| Type | Name | Description | |
|---|---|---|---|
| FString | IniName | Ini file name to find the config values. | |
| FString | SectionName | Section name in the Ini file in which to find the keys. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Create a config using the default values: IniName - GEngineIni SectionName (Development) = AnalyticsDevelopment SectionName (Debug) = AnalyticsDebug SectionName (Test) = AnalyticsTest SectionName (Release) = Analytics | |||
ConfigFromIni
(
EAnalyticsBuildType InBuildType |
Create a config AS IF the BuildType matches the one passed in. | ||
ConfigFromIni
(
const FString& InIniName, |
Create a config, specifying the Ini name and a single section name for all build types. | ||
| Create a config, specifying the Ini name and the section name for each build type. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| FName | Reads the ProviderModuleName key from the Analytics section of GEngineIni, which is the default, preferred location to look for the analytics provider name. | ||
| FString | Method that can be bound to an FAnalyticsProviderConfigurationDelegate. | ||
| void | SetSectionNameByBuildType
(
EAnalyticsBuildType InBuildType |
Allows setting the INI section name based on the build type passed in. |