Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Analytics > FAnalyticsEventAttribute

Light Theme

Dark Theme

FAnalyticsEventAttribute

Struct to hold key/value pairs that will be sent as attributes along with analytics events.

Windows

MacOS

Linux

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.

Constructors

	Name	Description
	FAnalyticsEventAttribute()	Default ctor since we declare a custom ctor.
	FAnalyticsEventAttribute ( const FAnalyticsEventAttribute& RH... )	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

	Name	Description
	~FAnalyticsEventAttribute()

Functions

	Name	Description
const FStrin...	GetName()
const FStrin...	GetValue()
bool	IsJsonFragment()
bool	IsValidAttributeName ( const FString& InName )
void	SetValue ( ValueType&& InValue )	Allow setting value for any type that supports LexToString

Operators

		Name	Description
	FAnalyticsEv...	operator= ( const FAnalyticsEventAttribute& RH... )	Hack to allow assignment.
	FAnalyticsEv...	operator= ( FAnalyticsEventAttribute&& RHS )	Hack to allow assignment.

Enums

	Name	Description
	AttrTypeEnum

Deprecated Variables

	Name	Description
const FString	AttrName	This property has been deprecated, use GetName() instead
const AttrTypeE...	AttrType	This property has been deprecated, use IsJsonFragment or GetValue instead
const bool	AttrValueBool	This property has been deprecated, use GetValue() instead. You cannot recover the original non-string value anymore
const double	AttrValueNumber	This property has been deprecated, use GetValue() instead. You cannot recover the original non-string value anymore
const FString	AttrValueString	This property has been deprecated, use GetValue() instead

Deprecated Functions

		Name	Description
	void	SwitchToJsonFragment()	This property is used to support the deprecated APIs, construct Json values using FJsonFragment instead
	FString	ToString()	This property has been deprecated, use GetValue() instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss