Navigation
API > API/Runtime > API/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.
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Default ctor since we declare a custom ctor. | |||
FAnalyticsEventAttribute
(
const FAnalyticsEventAttribute& RHS |
Reinstate the default copy ctor because that one still works fine. | ||
| Hack to allow copy ctor using an rvalue-ref. | |||
FAnalyticsEventAttribute
(
FString InName, |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| const FString & | GetName () |
||
| const FString & | GetValue () |
||
| bool | |||
| bool | IsValidAttributeName
(
const FString& InName |
||
| void | SetValue
(
ValueType&& InValue |
Allow setting value for any type that supports LexToString |
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 |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| const FString | AttrName | This property has been deprecated, use GetName() instead | |
| const AttrTypeEnum | 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
| Type | Name | Description | |
|---|---|---|---|
| void | 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 |