Navigation
API > API/Runtime > API/Runtime/Analytics > API/Runtime/Analytics/FAnalytics
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().
| Name | ConfigFromIni |
| Type | struct |
| Header File | /Engine/Source/Runtime/Analytics/Analytics/Public/Analytics.h |
| Include Path | #include "Analytics.h" |
Syntax
struct ConfigFromIni
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Create a config using the default values: IniName - GEngineIni SectionName (Development) = AnalyticsDevelopment SectionName (Debug) = AnalyticsDebug SectionName (Test) = AnalyticsTest SectionName (Release) = Analytics | Analytics.h | ||
ConfigFromIni
(
EAnalyticsBuildType InBuildType |
Create a config AS IF the BuildType matches the one passed in. | Analytics.h | |
ConfigFromIni
(
const FString& InIniName, |
Create a config, specifying the Ini name and a single section name for all build types. | Analytics.h | |
ConfigFromIni
(
const FString& InIniName, |
Create a config, specifying the Ini name and the section name for each build type. | Analytics.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| IniName | FString | Ini file name to find the config values. | Analytics.h | |
| SectionName | FString | Section name in the Ini file in which to find the keys. | Analytics.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString GetValue
(
const FString& KeyName, |
Method that can be bound to an FAnalyticsProviderConfigurationDelegate. | Analytics.h | |
void SetSectionNameByBuildType
(
EAnalyticsBuildType InBuildType |
Allows setting the INI section name based on the build type passed in. | Analytics.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FName GetDefaultProviderModuleName () |
Reads the ProviderModuleName key from the Analytics section of GEngineIni, which is the default, preferred location to look for the analytics provider name. | Analytics.h |