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.

Variables

Name Description

Public variable

const FString

 

AttrName

Public variable

const AttrTypeE...

 

AttrType

Public variable

const bool

 

AttrValueBool

Public variable

const double

 

AttrValueNumber

Public variable

const FString

 

AttrValueString

Constructors

Name Description

Public function

FAnalyticsEventAttribute()

Default ctor since we declare a custom ctor.

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    FJsonFragment&& Fragment
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    ValueType&& InValue
)

Helper constructor to make an attribute from a name/value pair by forwarding through LexToString and AnalyticsConversionToString.

Public function

FAnalyticsEventAttribute

(
    const FAnalyticsEventAttribute& RH...
)

Reinstate the default copy ctor because that one still works fine.

Public function

FAnalyticsEventAttribute

(
    FAnalyticsEventAttribute&& RHS
)

Hack to allow copy ctor using an rvalue-ref.

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    FJsonNull
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    double InValue
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    float InValue
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    int32 InValue
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    uint32 InValue
)

Public function

FAnalyticsEventAttribute

(
    NameType&& InName,
    bool InValue
)

Functions

Name Description

Public function Const

FString

 

ToString()

If you need the old AttrValue behavior (i.e. stringify everything), call this function instead.

Operators

Name Description

Public function

FAnalyticsEv...

 

operator=

(
    const FAnalyticsEventAttribute& RH...
)

Hack to allow assignment.

Public function

FAnalyticsEv...

 

operator=

(
    FAnalyticsEventAttribute&& RHS
)

Hack to allow assignment.

Enums

Name

Description

Public enum

AttrTypeEnum

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback