className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
3
36
code
stringlengths
0
11.4k
variables
listlengths
0
395
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, uint32 Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, uint64 Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, float Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, double Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, bool Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [FDateTime](API\Runtime\Core\Misc\FDateTime) & Value )
[]
IAnalyticsPropertyStore::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [FString](API\Runtime\Core\Containers\FString) & Value, uint32 CharCountCapacityHint )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Updates an exiting value. The operation is atomic from the caller perspective. The function reads the actual value and invoke UpdateFn callback with the actual value. The callback can update the actual value or decline the operation. If the key is not found, the callback is not invoked. One of the following code
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(int32 &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(uint32 &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(uint64 &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(int64 &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(float &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(double &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([FString](API\Runtime\Core\Containers\FString) &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(bool &)> & UpdateFn )
[]
IAnalyticsPropertyStore::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( const [FString](API\Runtime\Core\Containers\FString) & Key, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool([FDateTime](API\Runtime\Core\Misc\FDateTime) &)> & UpdateFn )
[]
IAnalyticsPropertyStore::VisitAll
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Iterates the keys currently stored and invokes the visitor function for each key, converting the value to its string representation.
Analytics
void VisitAll ( const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< void([FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) &&)> & VisitFn ) const
[]
IAnalyticsPropertyStore::~IAnalyticsPropertyStore
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
virtual ~IAnalyticsPropertyStore()
[]
IAnalyticsPropertyStore
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Implements a fast type safe key/value database to store analytics properties collected during a session.
Analytics
class IAnalyticsPropertyStore
[]
IAnalyticsProvider::EndSession
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Ends the session. Usually no need to call explicitly, as the provider should do this for you when the instance is destroyed.
Analytics
void EndSession()
[]
IAnalyticsProvider::FlushEvents
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support explicitly sending any cached events. In which case this method does nothing.
Analytics
void FlushEvents()
[]
IAnalyticsProvider::GetSessionID
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Gets the opaque session identifier string for the provider.
Analytics
[FString](API\Runtime\Core\Containers\FString) GetSessionID() const
[]
IAnalyticsProvider::GetUserID
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Gset the current UserID. Use -ANALYTICSUSERID=command line to force the provider to use a specific UserID for this run.
Analytics
[FString](API\Runtime\Core\Containers\FString) GetUserID() const
[]
IAnalyticsProvider::RecordCurrencyGiven
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support currency events. In this case this method is equivalent to sending a regular event with name "Currency Given".
Analytics
virtual void RecordCurrencyGiven ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int GameCurrencyAmount )
[]
IAnalyticsProvider::RecordCurrencyGiven
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support currency events. In this case this method is equivalent to sending a regular event with name "Currency Given".
Analytics
virtual void RecordCurrencyGiven ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int GameCurrencyAmount, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::RecordCurrencyPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support item purchase events. In this case this method is equivalent to sending a regular event with name "Item Purchase".
Analytics
virtual void RecordCurrencyPurchase ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int GameCurrencyAmount )
[]
IAnalyticsProvider::RecordCurrencyPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support currency events. In this case this method is equivalent to sending a regular event with name "Currency Purchase".
Analytics
virtual void RecordCurrencyPurchase ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int GameCurrencyAmount, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::RecordCurrencyPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support currency events. In this case this method is equivalent to sending a regular event with name "Currency Purchase".
Analytics
virtual void RecordCurrencyPurchase ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int GameCurrencyAmount, const [FString](API\Runtime\Core\Containers\FString) & RealCurrencyType, float RealMoneyCost, const [FString](API\Runtime\Core\Containers\FString) & PaymentProvider )
[]
IAnalyticsProvider::RecordError
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support all events. In this case this method is equivalent to sending a regular event with name "Game Error".
Analytics
virtual void RecordError ( const [FString](API\Runtime\Core\Containers\FString) & Error )
[]
IAnalyticsProvider::RecordError
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support all events. In this case this method is equivalent to sending a regular event with name "Game Error".
Analytics
virtual void RecordError ( const [FString](API\Runtime\Core\Containers\FString) & Error, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::RecordEvent
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Overload for RecordEvent that takes no parameters
Analytics
void RecordEvent ( const [FString](API\Runtime\Core\Containers\FString) & EventName )
[]
IAnalyticsProvider::RecordEvent
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Records a named event with an array of attributes
Analytics
void RecordEvent ( const [FString](API\Runtime\Core\Containers\FString) & EventName, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & Attributes )
[]
IAnalyticsProvider::RecordEvent
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Overload for RecordEvent that takes a single attribute
Analytics
void RecordEvent ( const [FString](API\Runtime\Core\Containers\FString) & EventName, const [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) & Attribute )
[]
IAnalyticsProvider::RecordEvent
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Overload for RecordEvent that takes a single name/value pair
Analytics
void RecordEvent ( const [FString](API\Runtime\Core\Containers\FString) & EventName, const [FString](API\Runtime\Core\Containers\FString) & ParamName, const [FString](API\Runtime\Core\Containers\FString) & ParamValue )
[]
IAnalyticsProvider::RecordItemPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support item purchase events. In this case this method is equivalent to sending a regular event with name "Item Purchase".
Analytics
void RecordItemPurchase ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, int ItemQuantity )
[]
IAnalyticsProvider::RecordItemPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support item purchase events. In this case this method is equivalent to sending a regular event with name "Item Purchase".
Analytics
virtual void RecordItemPurchase ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, int ItemQuantity, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::RecordItemPurchase
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support item purchase events. In this case this method is equivalent to sending a regular event with name "Item Purchase".
Analytics
virtual void RecordItemPurchase ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, const [FString](API\Runtime\Core\Containers\FString) & Currency, int PerItemCost, int ItemQuantity )
[]
IAnalyticsProvider::RecordProgress
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support all events. In this case this method is equivalent to sending a regular event with name "Progression".
Analytics
virtual void RecordProgress ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [FString](API\Runtime\Core\Containers\FString) & ProgressHierarchy )
[]
IAnalyticsProvider::RecordProgress
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support all events. In this case this method is equivalent to sending a regular event with name "Progression".
Analytics
virtual void RecordProgress ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ProgressHierarchy, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::RecordProgress
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Note that not all providers support all events. In this case this method is equivalent to sending a regular event with name "Progression".
Analytics
virtual void RecordProgress ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [FString](API\Runtime\Core\Containers\FString) & ProgressHierarchy, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & EventAttrs )
[]
IAnalyticsProvider::SetAge
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Sets the location the game believes the user is playing in as part of the session
Analytics
virtual void SetAge ( const int32 InAge )
[]
IAnalyticsProvider::SetBuildInfo
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Sets a user defined string as the build information/version for the session
Analytics
virtual void SetBuildInfo ( const [FString](API\Runtime\Core\Containers\FString) & InBuildInfo )
[]
IAnalyticsProvider::SetGender
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Sets the gender the game believes the user is as part of the session
Analytics
virtual void SetGender ( const [FString](API\Runtime\Core\Containers\FString) & InGender )
[]
IAnalyticsProvider::SetLocation
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Sets the location the game believes the user is playing in as part of the session
Analytics
virtual void SetLocation ( const [FString](API\Runtime\Core\Containers\FString) & InLocation )
[]
IAnalyticsProvider::SetSessionID
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Sets the session ID of the analytics session. This is not something you normally have to do, except for circumstances where you need to send events on behalf of another user (like a dedicated server sending events for the connected clients).
Analytics
bool SetSessionID ( const [FString](API\Runtime\Core\Containers\FString) & InSessionID )
[]
IAnalyticsProvider::SetUserID
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Set the UserID for use with analytics. Some providers require a unique ID to be provided when supplying events, and some providers create their own. If you are using a provider that requires you to supply the ID, use this method to set it.
Analytics
void SetUserID ( const [FString](API\Runtime\Core\Containers\FString) & InUserID )
[]
IAnalyticsProvider::StartSession
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Starts a session. It's technically legal to send events without starting a session. The use case is for backends and dedicated servers to send events on behalf of a user without technically affecting the session length of the local player. Local players log in and start/end the session, but remote players simply call SetUserID and start sending events, which is legal and analytics providers should gracefully handle this. Repeated calls to this method will be ignored. true if the session started successfully.
Analytics
bool StartSession()
[]
IAnalyticsProvider::StartSession
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Starts a session. See parameterless-version for contract details.
Analytics
bool StartSession ( const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) > & Attributes )
[]
IAnalyticsProvider::StartSession
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Overload for StartSession that takes a single name/value pair
Analytics
bool StartSession ( const [FString](API\Runtime\Core\Containers\FString) & ParamName, const [FString](API\Runtime\Core\Containers\FString) & ParamValue )
[]
IAnalyticsProvider::StartSession
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Overload for StartSession that takes a single attribute
Analytics
bool StartSession ( const [FAnalyticsEventAttribute](API\Runtime\Analytics\FAnalyticsEventAttribute) & Attribute )
[]
IAnalyticsProvider::~IAnalyticsProvider
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
Analytics
virtual ~IAnalyticsProvider()
[]
IAnalyticsProvider
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProvider.h
There are several other methods to record specific types of events. They were added for legacy reasons to support specific third party implementations. Derived classes generally do not have to worry about them.
Analytics
class IAnalyticsProvider
[]
IAnalyticsProviderModule::CreateAnalyticsProvider
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProviderModule.h
Analytics
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IAnalyticsProvider](API\Runtime\Analytics\Interfaces\IAnalyticsProvider) > CreateAnalyticsProvider ( const FAnalyticsProviderConfigurationDelegate & GetConfigValue ) const
[]
IAnalyticsProviderModule
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsProviderModule.h
Generic interface for an analytics provider. Other modules can define more and register them with this module.
Analytics
class IAnalyticsProviderModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
TAnalyticsProperty::Get
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[IAnalyticsPropertyStore::EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Get ( [IAnalyticsPropertyStore](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore) * Store, T & OutValue ) const
[]
TAnalyticsProperty::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[IAnalyticsPropertyStore::EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( [IAnalyticsPropertyStore](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore) * Store, const T & Value ) const
[]
TAnalyticsProperty::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[IAnalyticsPropertyStore::EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Set ( [IAnalyticsPropertyStore](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore) * Store, const T & Value, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(const T *, const T &)> & ConditionFn ) const
[]
TAnalyticsProperty::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
[IAnalyticsPropertyStore::EStatusCode](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore\EStatusCode) Update ( [IAnalyticsPropertyStore](API\Runtime\Analytics\Interfaces\IAnalyticsPropertyStore) * Store, const [TFunction](API\Runtime\Core\GenericPlatform\TFunction)< bool(T &InOutValue)> & UpdateFn ) const
[]
TAnalyticsProperty::TAnalyticsProperty
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
TAnalyticsProperty ( const TCHAR * InKey )
[]
TAnalyticsProperty
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
TAnalyticsProperty< FString >
Analytics
template<typename T> class TAnalyticsProperty
[ { "type": "constFString", "name": "Key", "description": "" } ]
TAnalyticsProperty< FString >::Get
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
IAnalyticsPropertyStore::EStatusCode Get &40; IAnalyticsPropertyStore &42; Store, FString & OutValue &41; const
[]
TAnalyticsProperty< FString >::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
IAnalyticsPropertyStore::EStatusCode Set &40; IAnalyticsPropertyStore &42; Store, const FString & Value, uint32 CharCountCapacityHint &41; const
[]
TAnalyticsProperty< FString >::Set
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
IAnalyticsPropertyStore::EStatusCode Set &40; IAnalyticsPropertyStore &42; Store, const FString & Value, const TFunction< bool(const FString &42;, const FString &)> & ConditionFn &41; const
[]
TAnalyticsProperty< FString >::TAnalyticsProperty
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
TAnalyticsProperty &40; const TCHAR &42; InKey &41;
[]
TAnalyticsProperty< FString >::Update
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Analytics
IAnalyticsPropertyStore::EStatusCode Update &40; IAnalyticsPropertyStore &42; Store, const TFunction< bool(FString &InOutValue)> & UpdateFn &41; const
[]
TAnalyticsProperty< FString >
/Engine/Source/Runtime/Analytics/Analytics/Public/Interfaces/IAnalyticsPropertyStore.h
Specialization forFStringbecause the caller can specifies a capacity when adding a string.
Analytics
template<> class TAnalyticsProperty< FString >
[ { "type": "constFString", "name": "Key", "description": "" } ]
FAnalyticsBlueprintLibraryModule::Get
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Public/AnalyticsBlueprintLibraryModule.h
Singleton-like access to this module's interface. This is just for convenience! Beware of calling this during the shutdown phase, though. Your module might have been unloaded already. Returns singleton instance, loading the module on demand if needed
AnalyticsBlueprintLibrary
static [FAnalyticsBlueprintLibraryModule](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsBlueprintLibraryModule) & Get()
[]
FAnalyticsBlueprintLibraryModule
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Public/AnalyticsBlueprintLibraryModule.h
The public interface to this module
AnalyticsBlueprintLibrary
class FAnalyticsBlueprintLibraryModule : public [IModuleInterface](API\Runtime\Core\Modules\IModuleInterface)
[]
FAnalyticsEventAttr
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Blueprint accessible version of the analytics event struct
AnalyticsBlueprintLibrary
[USTRUCT](Programming/UnrealArchitecture/Reference/Structs)([BlueprintType](Programming/UnrealArchitecture/Reference/Structs/Specifiers/BlueprintType)) struct FAnalyticsEventAttr
[ { "type": "FString", "name": "Name", "description": "" }, { "type": "FString", "name": "Value", "description": "" } ]
UAnalyticsBlueprintLibrary::EndSession
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Ends an analytics session
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void EndSession()
[]
UAnalyticsBlueprintLibrary::FlushEvents
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Requests that any cached events be sent immediately
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void FlushEvents()
[]
UAnalyticsBlueprintLibrary::GetSessionId
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Gets the current session id from the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static [FString](API\Runtime\Core\Containers\FString) GetSessionId()
[]
UAnalyticsBlueprintLibrary::GetUserId
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Gets the current user id from the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static [FString](API\Runtime\Core\Containers\FString) GetUserId()
[]
UAnalyticsBlueprintLibrary::MakeEventAttribute
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Builds a struct from the attribute name and value
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintPure, Category="Analytics") static [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) MakeEventAttribute ( const [FString](API\Runtime\Core\Containers\FString) & AttributeName, const [FString](API\Runtime\Core\Containers\FString) & AttributeValue )
[]
UAnalyticsBlueprintLibrary::RecordCurrencyGiven
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game currency was granted by the game with no real-world money being involved
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordCurrencyGiven ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int32 GameCurrencyAmount )
[]
UAnalyticsBlueprintLibrary::RecordCurrencyPurchase
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game currency was purchased using real-world money
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordCurrencyPurchase ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int32 GameCurrencyAmount, const [FString](API\Runtime\Core\Containers\FString) & RealCurrencyType, float RealMoneyCost, const [FString](API\Runtime\Core\Containers\FString) & PaymentProvider )
[]
UAnalyticsBlueprintLibrary::RecordCurrencyGivenWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game currency was granted by the game with no real-world money being involved
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordCurrencyGivenWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int32 GameCurrencyAmount, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordError
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an error event has happened
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordError ( const [FString](API\Runtime\Core\Containers\FString) & Error )
[]
UAnalyticsBlueprintLibrary::RecordErrorWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an error event has happened with attributes
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordErrorWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & Error, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordEvent
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an event has happened by name without any attributes (an event counter)
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordEvent ( const [FString](API\Runtime\Core\Containers\FString) & EventName )
[]
UAnalyticsBlueprintLibrary::RecordEventWithAttribute
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an event has happened by name with a single attribute
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordEventWithAttribute ( const [FString](API\Runtime\Core\Containers\FString) & EventName, const [FString](API\Runtime\Core\Containers\FString) & AttributeName, const [FString](API\Runtime\Core\Containers\FString) & AttributeValue )
[]
UAnalyticsBlueprintLibrary::RecordEventWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an event has happened by name with a single attribute
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordEventWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & EventName, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordItemPurchase
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game item was purchased using the specified in-game currency
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordItemPurchase ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, const [FString](API\Runtime\Core\Containers\FString) & Currency, int32 PerItemCost, int32 ItemQuantity )
[]
UAnalyticsBlueprintLibrary::RecordProgress
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records a user progress event has happened
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordProgress ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [FString](API\Runtime\Core\Containers\FString) & ProgressName )
[]
UAnalyticsBlueprintLibrary::RecordProgressWithFullHierarchyAndAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records a user progress event has happened with a full list of progress hierarchy names and with attributes
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordProgressWithFullHierarchyAndAttributes ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [TArray](API\Runtime\Core\Containers\TArray)< [FString](API\Runtime\Core\Containers\FString) > & ProgressNames, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordProgressWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records a user progress event has happened with attributes
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordProgressWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & ProgressType, const [FString](API\Runtime\Core\Containers\FString) & ProgressName, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordSimpleCurrencyPurchase
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game currency was purchased using real-world money
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordSimpleCurrencyPurchase ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int32 GameCurrencyAmount )
[]
UAnalyticsBlueprintLibrary::RecordSimpleItemPurchase
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game item was purchased
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordSimpleItemPurchase ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, int32 ItemQuantity )
[]
UAnalyticsBlueprintLibrary::RecordSimpleCurrencyPurchaseWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game currency was purchased using real-world money
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordSimpleCurrencyPurchaseWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & GameCurrencyType, int32 GameCurrencyAmount, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::RecordSimpleItemPurchaseWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Records an in-game item was purchased with attributes
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void RecordSimpleItemPurchaseWithAttributes ( const [FString](API\Runtime\Core\Containers\FString) & ItemId, int32 ItemQuantity, const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::SetAge
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the user's age (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetAge ( int32 Age )
[]
UAnalyticsBlueprintLibrary::SetBuildInfo
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the game's build info (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetBuildInfo ( const [FString](API\Runtime\Core\Containers\FString) & BuildInfo )
[]
UAnalyticsBlueprintLibrary::SetGender
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the user's gender (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetGender ( const [FString](API\Runtime\Core\Containers\FString) & Gender )
[]
UAnalyticsBlueprintLibrary::SetLocation
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the user's location (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetLocation ( const [FString](API\Runtime\Core\Containers\FString) & Location )
[]
UAnalyticsBlueprintLibrary::SetSessionId
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the session id (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetSessionId ( const [FString](API\Runtime\Core\Containers\FString) & SessionId )
[]
UAnalyticsBlueprintLibrary::SetUserId
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Sets the user id (if supported) on the analytics provider
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static void SetUserId ( const [FString](API\Runtime\Core\Containers\FString) & UserId )
[]
UAnalyticsBlueprintLibrary::StartSessionWithAttributes
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Starts an analytics session with custom attributes specified
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static bool StartSessionWithAttributes ( const [TArray](API\Runtime\Core\Containers\TArray)< [FAnalyticsEventAttr](API\Plugins\AnalyticsBlueprintLibrary\FAnalyticsEventAttr) > & Attributes )
[]
UAnalyticsBlueprintLibrary::StartSession
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Starts an analytics session without any custom attributes specified
AnalyticsBlueprintLibrary
[UFUNCTION](Programming/UnrealArchitecture/Reference/Functions)(BlueprintCallable, Category="Analytics") static bool StartSession()
[]
UAnalyticsBlueprintLibrary::UAnalyticsBlueprintLibrary
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
AnalyticsBlueprintLibrary
UAnalyticsBlueprintLibrary ( const [FObjectInitializer](API\Runtime\CoreUObject\UObject\FObjectInitializer) & ObjectInitializer )
[]
UAnalyticsBlueprintLibrary
/Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
AnalyticsBlueprintLibrary
[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Meta=(ScriptName="AnalyticsLibrary")) class UAnalyticsBlueprintLibrary : public [UBlueprintFunctionLibrary](API\Runtime\Engine\Kismet\UBlueprintFunctionLibrary)
[]