1. Epic GamesDeveloper
  3. Analytics

Analytics

API > API/Runtime

   
Name Analytics
Type Runtime
Location /Engine/Source/Runtime/Analytics/Analytics/
Module Build Rules Analytics.Build.cs

Classes

Name Remarks
FAnalytics The public interface for interacting with analytics.
FAnalyticsPropertyStore Implements a fast key/value database to store the metrics gathered to create the session summary event.
FAnalyticsSpan Implementation of an IAnalyticsSpan interface
FAnalyticsTracer Implementation of an IAnalyticsTracer interface
TAnalyticsProperty Utility class to remember the key value type and let the compiler implicitly convert type or fail if such conversion is not possible.

Structs

Name Remarks
FAnalyticsEventAttribute Struct to hold key/value pairs that will be sent as attributes along with analytics events.
FJsonFragment  
FJsonNull  

Interfaces

Name Remarks
IAnalyticsPropertyStore Implements a fast type safe key/value database to store analytics properties collected during a session.
IAnalyticsProvider Generic interface for an analytics provider.
IAnalyticsProviderModule Generic interface for an analytics provider.
IAnalyticsSpan IAnalyticsSpan Interface
IAnalyticsTracer IAnalyticsTracer Interface

Typedefs

Name Type Remarks Include Path
FAnalyticsProviderConfigurationDelegate TBaseDelegate_TwoParams< FString, const FString &, bool > Analytics providers must be configured when created. AnalyticsProviderConfigurationDelegate.h
FThreadId uint32   AnalyticsTracer.h

Enums

Public

Name Remarks
EAnalyticsBuildType Defines the different build types from an analytics perspective.
EAnalyticsRecordEventMode  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const TCHAR * AnalyticsBuildTypeToString ( EAnalyticsBuildType Type
)

 Convert an EAnalyticsBuildType to string. AnalyticsBuildType.h  

decltype(auto) AnalyticsConversion::ToString ( T&& Value
)

   AnalyticsConversion.h  

decltype(auto) AnalyticsConversionToString ( const T& Value
)

 Helpers for converting various common types to strings that analytics providers can consume. AnalyticsConversion.h  
Make sure we have a direct implementation for moving FStrings as we definitely don't want to copy them as the above const-ref template will cause. AnalyticsConversion.h  
  AnalyticsConversion.h  

FString AnalyticsConversionToString ( FStringView Value
)

   AnalyticsConversion.h  
  AnalyticsConversion.h  
  AnalyticsConversion.h  

FString AnalyticsConversionToString ( const TArray< T, AllocatorType >& ValueArray
)

 Array conversion. Creates comma-separated list. AnalyticsConversion.h  

FString AnalyticsConversionToString ( const TArrayView< T >& ValueArray
)

 Array conversion. Creates comma-separated list. AnalyticsConversion.h  

FString AnalyticsConversionToString ( const TMap< KeyType, ValueType, Allocator, KeyFuncs >& ValueMap
)

 Map conversion. AnalyticsConversion.h  

TArray< FAnalyticsEventAttribute, Allocator > & AppendAnalyticsEventAttributeArray ( TArray< FAnalyticsEventAttribute, Allocator >& Attrs,
ArgTypes&&... Args
)

 Helper to append to an array of attributes using a single expression. AnalyticsEventAttribute.h  
Get the analytics build type. AnalyticsBuildType.h  

void ImplMakeAnalyticsEventAttributeArray::AddElement ( TArray< FAnalyticsEventAttribute, Allocator >& Attrs,
const KeyType& Key,
const ValueType& Value
)

 AddElement actually adds an element to the attributes array and is flagged no-inline so the array insert/value conversion code is generated once per type combination. AnalyticsEventAttribute.h  
  AnalyticsEventAttribute.h  

void ImplMakeAnalyticsEventAttributeArray::MakeArray ( TArray< FAnalyticsEventAttribute, Allocator >& Attrs,
KeyType&& Key,
ValueType&& Value,
RemainingArgTypes&&... RemainingArgs
)

 MakeArray is just a helper whose only purpose is to generate a sequence of AddElement calls and is meant to be always inlined. AnalyticsEventAttribute.h  

const TCHAR * LexToString ( FJsonNull
)

   AnalyticsEventAttribute.h  

const TCHAR * LexToString ( const FJsonFragment& Fragment
)

   AnalyticsEventAttribute.h  
  AnalyticsEventAttribute.h  

const TCHAR * LexToString ( EAnalyticsRecordEventMode Mode
)

   Interfaces/IAnalyticsProvider.h  
Helper to create an array of attributes using a single expression. AnalyticsEventAttribute.h  

bool operator! ( FAnalyticsPropertyStore::ETypeCode E
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode operator& ( FAnalyticsPropertyStore::ETypeCode Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode & operator&= ( FAnalyticsPropertyStore::ETypeCode& Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode operator^ ( FAnalyticsPropertyStore::ETypeCode Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode & operator^= ( FAnalyticsPropertyStore::ETypeCode& Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode operator| ( FAnalyticsPropertyStore::ETypeCode Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode & operator|= ( FAnalyticsPropertyStore::ETypeCode& Lhs,
FAnalyticsPropertyStore::ETypeCode Rhs
)

   AnalyticsPropertyStore.h  

FAnalyticsPropertyStore::ETypeCode operator~ ( FAnalyticsPropertyStore::ETypeCode E
)

   AnalyticsPropertyStore.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page