FAnalyticsEventAttribute | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Runtime > Analytics

References


Module	Analytics
Header	/Engine/Source/Runtime/Analytics/Analytics/Public/AnalyticsEventAttribute.h
Include	#include "AnalyticsEventAttribute.h"

Syntax

struct FAnalyticsEventAttribute

Remarks

Struct to hold key/value pairs that will be sent as attributes along with analytics events. All values are actually strings, but we provide a convenient constructor that relies on ToStringForAnalytics() to convert common types.

Variables

	Type	Name	Description
	const FString	AttrName
	const AttrTypeEnum	AttrType
	const bool	AttrValueBool
	const double	AttrValueNumber
	const FString	AttrValueString

Constructors

	Type	Name	Description
		FAnalyticsEventAttribute ()	Default ctor since we declare a custom ctor.
		FAnalyticsEventAttribute ( const FAnalyticsEventAttribute& RHS )	Reinstate the default copy ctor because that one still works fine.
		FAnalyticsEventAttribute ( FAnalyticsEventAttribute&& RHS )	Hack to allow copy ctor using an rvalue-ref.
		FAnalyticsEventAttribute ( FString InName, ValueType&& InValue )

Destructors

	Type	Name	Description
		~FAnalyticsEventAttribute ()

Functions

Type	Name	Description
const FString &	GetName ()
const FString &	GetValue ()
bool	IsJsonFragment ()
bool	IsValidAttributeName ( const FString& InName )
void	SetValue ( ValueType&& InValue )	Allow setting value for any type that supports LexToString
void	SwitchToJsonFragment ()	Legacy support for old RecordEventJson API. Don't call this directly.
FString	ToString ()	If you need the old AttrValue behavior (i.e. stringify everything), call this function instead.

Operators

Type	Name	Description
FAnalyticsEventAttribute &	operator+ ( const FAnalyticsEventAttribute& RHS )	ALlow aggregation of attributes
FAnalyticsEventAttribute &	operator+= ( const FAnalyticsEventAttribute& RHS )	ALlow aggregation of attributes
FAnalyticsEventAttribute &	operator= ( const FAnalyticsEventAttribute& RHS )	Hack to allow assignment.
FAnalyticsEventAttribute &	operator= ( FAnalyticsEventAttribute&& RHS )	Hack to allow assignment.

Enums

	Type	Name	Description
	AttrTypeEnum

Navigation