1. Epic GamesDeveloper
  3. UAnalyticsBlueprintLibrary

UAnalyticsBlueprintLibrary

API > API/Plugins > API/Plugins/AnalyticsBlueprintLibrary

   
Name UAnalyticsBlueprintLibrary
Type class
Header File /Engine/Plugins/Runtime/Analytics/AnalyticsBlueprintLibrary/Source/AnalyticsBlueprintLibrary/Classes/AnalyticsBlueprintLibrary.h
Include Path #include "AnalyticsBlueprintLibrary.h"

Syntax

UCLASS (Meta=(ScriptName="AnalyticsLibrary"))  
class UAnalyticsBlueprintLibrary : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UAnalyticsBlueprintLibrary ( const FObjectInitializer& ObjectInitializer
)

   AnalyticsBlueprintLibrary.h  

Functions

Public

Static

Name Remarks Include Path Unreal Specifiers

static void EndSession()

 Ends an analytics session AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void FlushEvents()

 Requests that any cached events be sent immediately AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static FString GetSessionId()

 Gets the current session id from the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static FString GetUserId()

 Gets the current user id from the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static FAnalyticsEventAttr MakeEventAttribute ( const FString& AttributeName,
const FString& AttributeValue
)

 Builds a struct from the attribute name and value AnalyticsBlueprintLibrary.h
  • BlueprintPure
  • Category="Analytics"

static void RecordCurrencyGiven ( const FString& GameCurrencyType,
int32 GameCurrencyAmount
)

 Records an in-game currency was granted by the game with no real-world money being involved AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordCurrencyGivenWithAttributes ( const FString& GameCurrencyType,
int32 GameCurrencyAmount,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records an in-game currency was granted by the game with no real-world money being involved AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordCurrencyPurchase ( const FString& GameCurrencyType,
int32 GameCurrencyAmount,
const FString& RealCurrencyType,
float RealMoneyCost,
const FString& PaymentProvider
)

 Records an in-game currency was purchased using real-world money AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordError ( const FString& Error
)

 Records an error event has happened AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordErrorWithAttributes ( const FString& Error,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records an error event has happened with attributes AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordEvent ( const FString& EventName
)

 Records an event has happened by name without any attributes (an event counter) AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordEventWithAttribute ( const FString& EventName,
const FString& AttributeName,
const FString& AttributeValue
)

 Records an event has happened by name with a single attribute AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordEventWithAttributes ( const FString& EventName,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records an event has happened by name with a single attribute AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordItemPurchase ( const FString& ItemId,
const FString& Currency,
int32 PerItemCost,
int32 ItemQuantity
)

 Records an in-game item was purchased using the specified in-game currency AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordProgress ( const FString& ProgressType,
const FString& ProgressName
)

 Records a user progress event has happened AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordProgressWithAttributes ( const FString& ProgressType,
const FString& ProgressName,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records a user progress event has happened with attributes AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordProgressWithFullHierarchyAndAttributes ( const FString& ProgressType,
const TArray< FString >& ProgressNames,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records a user progress event has happened with a full list of progress hierarchy names and with attributes AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordSimpleCurrencyPurchase ( const FString& GameCurrencyType,
int32 GameCurrencyAmount
)

 Records an in-game currency was purchased using real-world money AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordSimpleCurrencyPurchaseWithAttributes ( const FString& GameCurrencyType,
int32 GameCurrencyAmount,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records an in-game currency was purchased using real-world money AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordSimpleItemPurchase ( const FString& ItemId,
int32 ItemQuantity
)

 Records an in-game item was purchased AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void RecordSimpleItemPurchaseWithAttributes ( const FString& ItemId,
int32 ItemQuantity,
const TArray< FAnalyticsEventAttr >& Attributes
)

 Records an in-game item was purchased with attributes AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetAge ( int32 Age
)

 Sets the user's age (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetBuildInfo ( const FString& BuildInfo
)

 Sets the game's build info (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetGender ( const FString& Gender
)

 Sets the user's gender (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetLocation ( const FString& Location
)

 Sets the user's location (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetSessionId ( const FString& SessionId
)

 Sets the session id (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static void SetUserId ( const FString& UserId
)

 Sets the user id (if supported) on the analytics provider AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static bool StartSession()

 Starts an analytics session without any custom attributes specified AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

static bool StartSessionWithAttributes ( const TArray< FAnalyticsEventAttr >& Attributes
)

 Starts an analytics session with custom attributes specified AnalyticsBlueprintLibrary.h
  • BlueprintCallable
  • Category="Analytics"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page