Skip to content

Events

Summary

MembersDescriptions
public void RALLYHEREINTEGRATION_API CreateCustomDataAttributes(const TOptional< TMap< FString, FString >> & InCustomData,TArray< FAnalyticsEventAttribute > & Attributes)
public TSharedPtr< class IAnalyticsProvider > RALLYHEREINTEGRATION_API AutoCreateAnalyticsProvider()
public FORCEINLINE FJsonFragment JsonValueToFragment(const TSharedPtr< FJsonValue > & InJsonValue)
struct RHStandardEvents::FCorrelationStartEventEvent that is triggered at the start of the application and when we have generated a correlation_id to track events.
struct RHStandardEvents::FCorrelationEndEventThis event is triggered to mark the end of tracking events. Typically triggered when the client gracefully is closed.
struct RHStandardEvents::FClientDeviceEventRecords the first time a user launches an app and when device information changes.
struct RHStandardEvents::FInstanceJoinStartEventThis event is triggered when the player / game client has an instance to connect to and has started the process to connect to it.
struct RHStandardEvents::FInstanceJoinCompleteEventThis event is triggered when the player / game client has attempted to connect to the instance.This event will capture both the success and the failure to connect to an instance.
struct RHStandardEvents::FInstanceLeftEventThis event is triggered when a player / game client has disconnected from the instance.
struct RHStandardEvents::FLoginStartEventThis event is triggered at the start of the client login process.
struct RHStandardEvents::FLoginCompleteEventThis event is triggered when the login process has completed.This event is meant to capture both successful and failed login attempts.
struct RHStandardEvents::FObjectiveProgressEventThis event is meant to be triggered when a player has earned progress on an objective.The RHIntegration Plugin will not automatically trigger this, but this event is something that RallyHere will process and have an understanding of the data.
struct RHStandardEvents::FPlayerGameResultEventThis event is meant to capture high level information about a completed match.The RHIntegration Plugin will not automatically trigger this, but this event is something that RallyHere will process and have an understanding of the data.
struct RHStandardEvents::FPlatformPurchaseEventThis event is triggered when processing of a real money purchase has been completed.
struct RHStandardEvents::FCustomEventThis is a wrapper for providing custom event data.

Members

public void RALLYHEREINTEGRATION_API CreateCustomDataAttributes(const TOptional< TMap< FString, FString >> & InCustomData,TArray< FAnalyticsEventAttribute > & Attributes)

public TSharedPtr< class IAnalyticsProvider > RALLYHEREINTEGRATION_API AutoCreateAnalyticsProvider()

public FORCEINLINE FJsonFragment JsonValueToFragment(const TSharedPtr< FJsonValue > & InJsonValue)

struct RHStandardEvents::FCorrelationStartEvent

Event that is triggered at the start of the application and when we have generated a correlation_id to track events.

rh.correlation_start

Summary

MembersDescriptions
public FString PlatformNameUsed for tracking platform enumerations.List of possible values.
public FString ClientBuildVersionThe build version of the client.
public FString EngineVersionThe version of the engine.
public FString IntegrationPluginVersionThe version of the integration plugin.
public FString ClientTimestampThe client timestamp when the event was triggered.
public TOptional< FString > ServerTimestampThe client’s estimated server timestamp when the event was triggered.
public TOptional< FString > CommandLineArgThe command line arguments passed to the client.
public TOptional< bool > IsEditorWhether the client is running in editor mode.
public TOptional< FString > ModeThe mode the client is running in.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FCorrelationStartEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public FString PlatformName

Used for tracking platform enumerations.List of possible values.


#### `public FString `[`ClientBuildVersion`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a6cc8e387b5bbcba8603e9863b330646e)

The build version of the client.


#### `public FString `[`EngineVersion`](#structRHStandardEvents_1_1FCorrelationStartEvent_1adc9fa712ac009d6a5a4c0bf59baab9f2)

The version of the engine.


#### `public FString `[`IntegrationPluginVersion`](#structRHStandardEvents_1_1FCorrelationStartEvent_1aae577244f7c1ebff56e414a33c13fecb)

The version of the integration plugin.


#### `public FString `[`ClientTimestamp`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a55a8d1162dcd1bd7f15fed4d5bfd2b73)

The client timestamp when the event was triggered.


#### `public TOptional< FString > `[`ServerTimestamp`](#structRHStandardEvents_1_1FCorrelationStartEvent_1ad9506893fe3a9e17b618bcb18627b6f8)

The client’s estimated server timestamp when the event was triggered.


#### `public TOptional< FString > `[`CommandLineArg`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a3747872c0a5f42f5c2bd8f48165b058a)

The command line arguments passed to the client.


#### `public TOptional< bool > `[`IsEditor`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a2dd4d71e29afe5f6ae4f0a5874ace098)

Whether the client is running in editor mode.


#### `public TOptional< FString > `[`Mode`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a44a1e5df276714002007b51441393896)

The mode the client is running in.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a8d0e6c9968c9c4268ccb31d72aea70e2)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FCorrelationStartEvent`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a1a51eff01e7eb9d12b21c31bf06b8070)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FCorrelationStartEvent_1a0ccb1224987fdfcd710ce798dbedf13d)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FCorrelationEndEvent`

This event is triggered to mark the end of tracking events. Typically triggered when the client gracefully is closed.

rh.correlation_end

Summary

MembersDescriptions
public TOptional< FString > ReasonThe reason for the correlation to end.
public TOptional< float > DurationSecondsThe duration of the correlation.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FCorrelationEndEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< FString > Reason

The reason for the correlation to end.


#### `public TOptional< float > `[`DurationSeconds`](#structRHStandardEvents_1_1FCorrelationEndEvent_1a2198feae504ef70955648fe7752b37d7)

The duration of the correlation.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FCorrelationEndEvent_1a2c182c2aafe72419987a26a15e57708b)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FCorrelationEndEvent`](#structRHStandardEvents_1_1FCorrelationEndEvent_1ab67461755e3ea773980869285b599e8d)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FCorrelationEndEvent_1a19410683fa4e5105f754323ce77be689)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FClientDeviceEvent`

Records the first time a user launches an app and when device information changes.

rh.client_device

Summary

MembersDescriptions
public TOptional< FString > CpuTypeThe type of CPU.
public TOptional< int32 > CpuCoresThe number of logical CPU cores.
public TOptional< FString > GpuTypeThe reference of the GPU(brand name and model)
public TOptional< int32 > ScreenHeightMaximum known number of height pixels(dpi)
public TOptional< int32 > ScreenWidthMaximum known number of width pixels(dpi)
public TOptional< int32 > RamTotalSize of the RAM on the device in megabytes.
public TOptional< int32 > RamAvailableSize of the available RAM on the device in megabytes.
public TOptional< FString > IpThis is the IP of the game client.
public TOptional< FString > DeviceTypeThis will be then platform the game client is running on.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FClientDeviceEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< FString > CpuType

The type of CPU.


#### `public TOptional< int32 > `[`CpuCores`](#structRHStandardEvents_1_1FClientDeviceEvent_1a600aefe9173f574976a7b60235cf2daf)

The number of logical CPU cores.


#### `public TOptional< FString > `[`GpuType`](#structRHStandardEvents_1_1FClientDeviceEvent_1a6dd0de7fad58903b5f80f352144a1ef6)

The reference of the GPU(brand name and model)


#### `public TOptional< int32 > `[`ScreenHeight`](#structRHStandardEvents_1_1FClientDeviceEvent_1ad76cec719196daa0ed83f36e873148f4)

Maximum known number of height pixels(dpi)


#### `public TOptional< int32 > `[`ScreenWidth`](#structRHStandardEvents_1_1FClientDeviceEvent_1a3d248cbe9809b22653d10a72f08130a0)

Maximum known number of width pixels(dpi)


#### `public TOptional< int32 > `[`RamTotal`](#structRHStandardEvents_1_1FClientDeviceEvent_1a8df7f359bd078ae6622a98d0e70aa35a)

Size of the RAM on the device in megabytes.


#### `public TOptional< int32 > `[`RamAvailable`](#structRHStandardEvents_1_1FClientDeviceEvent_1ada61fffa384c031f8f39b2db6fab2801)

Size of the available RAM on the device in megabytes.


#### `public TOptional< FString > `[`Ip`](#structRHStandardEvents_1_1FClientDeviceEvent_1a8dbd86970e47d2e6cc456df43f61c92a)

This is the IP of the game client.


#### `public TOptional< FString > `[`DeviceType`](#structRHStandardEvents_1_1FClientDeviceEvent_1a52fbd8a4229809e92327d3e6f83cc4c5)

This will be then platform the game client is running on.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FClientDeviceEvent_1a341236af57be2415969ac60cc296c7c5)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FClientDeviceEvent`](#structRHStandardEvents_1_1FClientDeviceEvent_1ad549fc630bc30c9f77f2d5f1a6c39ac3)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FClientDeviceEvent_1acfb344c95e558432c3a3e07311be7fc9)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FInstanceJoinStartEvent`

This event is triggered when the player / game client has an instance to connect to and has started the process to connect to it.

rh.instance_join_start

Summary

MembersDescriptions
public TOptional< FString > SessionIdThe session_id of the instance the player is attempting to join.
public TOptional< FString > InstanceIdThe instance_id of the instance the player is attempting to join.
public TOptional< FString > ConnectionStringThe connection string of the instance the player is attempting to join.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FInstanceJoinStartEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< FString > SessionId

The session_id of the instance the player is attempting to join.


#### `public TOptional< FString > `[`InstanceId`](#structRHStandardEvents_1_1FInstanceJoinStartEvent_1a1e83a69a7bb5bfe0ceb77535c1d2f185)

The instance_id of the instance the player is attempting to join.


#### `public TOptional< FString > `[`ConnectionString`](#structRHStandardEvents_1_1FInstanceJoinStartEvent_1a133d73e2a9d924f03beb8701a94fa153)

The connection string of the instance the player is attempting to join.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FInstanceJoinStartEvent_1a809a4e3ad455ea11f699db5e96c823c0)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FInstanceJoinStartEvent`](#structRHStandardEvents_1_1FInstanceJoinStartEvent_1a9fe9145048ff3fc4d3c3c951d8a1f2ec)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FInstanceJoinStartEvent_1a410a6489ad2d7531ad7bd5816d9306a3)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FInstanceJoinCompleteEvent`

This event is triggered when the player / game client has attempted to connect to the instance.This event will capture both the success and the failure to connect to an instance.

rh.instnace_join_complete

Summary

MembersDescriptions
public bool IsSuccessWhether or not the join was an overall success.
public TOptional< FString > SessionIdThe session_id of the instance the player is attempting to join.
public TOptional< FString > InstanceIdThe instance_id of the instance the player is attempting to join.
public TOptional< FString > ReasonThe reason for the failure to join the instance.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FInstanceJoinCompleteEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public bool IsSuccess

Whether or not the join was an overall success.


#### `public TOptional< FString > `[`SessionId`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1afe91b49ca38affef3d630953d8fcb112)

The session_id of the instance the player is attempting to join.


#### `public TOptional< FString > `[`InstanceId`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1ab9e632d1a19e316929798e3b252bd71a)

The instance_id of the instance the player is attempting to join.


#### `public TOptional< FString > `[`Reason`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1a8295d75bbfd9a941c64eeb68b8722c6d)

The reason for the failure to join the instance.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1a7a60eeaf37414665063ad1a6386fb40c)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FInstanceJoinCompleteEvent`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1a90fc553eeebc4e89006ed2709011fc10)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FInstanceJoinCompleteEvent_1aef5e96360a6ac8389b5371a78efddf98)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FInstanceLeftEvent`

This event is triggered when a player / game client has disconnected from the instance.

rh.instance_left

Summary

MembersDescriptions
public TOptional< FString > SessionIdThe session_id of the instance the player is leaving.
public TOptional< FString > InstanceIdThe instance_id of the instance the player is leaving.
public TOptional< FString > ReasonThe reason for the player leaving the instance.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FInstanceLeftEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< FString > SessionId

The session_id of the instance the player is leaving.


#### `public TOptional< FString > `[`InstanceId`](#structRHStandardEvents_1_1FInstanceLeftEvent_1ad43fed5658c18978918684d96c785306)

The instance_id of the instance the player is leaving.


#### `public TOptional< FString > `[`Reason`](#structRHStandardEvents_1_1FInstanceLeftEvent_1a686540f637f62130ffc392ede61f09f9)

The reason for the player leaving the instance.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FInstanceLeftEvent_1af42085b7b056b6dd38e169dd0342811e)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FInstanceLeftEvent`](#structRHStandardEvents_1_1FInstanceLeftEvent_1a698bd9d2e86ef8f5956b84286c677ba6)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FInstanceLeftEvent_1acb0af23c65982c32df6644f4b4a82b6f)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FLoginStartEvent`

This event is triggered at the start of the client login process.

rh.login_start

Summary

MembersDescriptions
public TOptional< FString > PlatformDisplayNamePlatform username / gamertag of the player.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FLoginStartEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< FString > PlatformDisplayName

Platform username / gamertag of the player.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FLoginStartEvent_1aaa8c15c1d4484c3ea1a940b5432b6999)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FLoginStartEvent`](#structRHStandardEvents_1_1FLoginStartEvent_1ade639811664eb76689e326042f554bca)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FLoginStartEvent_1a21dac598f0c7d0c9a06f0535d8eab4ac)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FLoginCompleteEvent`

This event is triggered when the login process has completed.This event is meant to capture both successful and failed login attempts.

rh.login_complete

Summary

MembersDescriptions
public FString PlatformUserIdPlatform UserId of the player.
public FString PlatformIdPlatform Id of the player.
public FString StatusThe status of the login attempt.
public TOptional< FString > PlatformDisplayNamePlatform username / gamertag of the player.
public TOptional< FString > PersonIdPersonId of the player.
public TOptional< FString > ReasonThe reason for the failure to login.
public TOptional< float > DurationSecondsThe duration of the login process.
public TOptional< FString > SubmitTimestampThe timestamp when the login process was submitted to the RH API.
public TOptional< FString > PlatformLoginCompleteTimestampThe timestamp when the login process was completed.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FLoginCompleteEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public FString PlatformUserId

Platform UserId of the player.


#### `public FString `[`PlatformId`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a5bc4a30e83be6aa9efee09ca239ee9c4)

Platform Id of the player.


#### `public FString `[`Status`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a450d771307789ec844783fc93aa9d43e)

The status of the login attempt.


#### `public TOptional< FString > `[`PlatformDisplayName`](#structRHStandardEvents_1_1FLoginCompleteEvent_1aa387846cfb5da38f19a8f9fc85f0d1fc)

Platform username / gamertag of the player.


#### `public TOptional< FString > `[`PersonId`](#structRHStandardEvents_1_1FLoginCompleteEvent_1ac4de5a5a09f1ea049638b5a795c84826)

PersonId of the player.


#### `public TOptional< FString > `[`Reason`](#structRHStandardEvents_1_1FLoginCompleteEvent_1afbf4607ea9cf02be776462795cb43675)

The reason for the failure to login.


#### `public TOptional< float > `[`DurationSeconds`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a26ee1029c1a011fb47ec8a15dcf97427)

The duration of the login process.


#### `public TOptional< FString > `[`SubmitTimestamp`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a9bbb4e039316e0d26cfa351c5bdda9ef)

The timestamp when the login process was submitted to the RH API.


#### `public TOptional< FString > `[`PlatformLoginCompleteTimestamp`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a0c48e762565c10bf0f8bc212ac817846)

The timestamp when the login process was completed.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a6505fba3d70c9ddf43416360bc48bbbf)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FLoginCompleteEvent`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a54e374804cb72bc28f8de6152169e08c)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FLoginCompleteEvent_1a13109823a17b2b5a67125d947661caf7)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FObjectiveProgressEvent`

This event is meant to be triggered when a player has earned progress on an objective.The RHIntegration Plugin will not automatically trigger this, but this event is something that RallyHere will process and have an understanding of the data.

rh.objective_progress

Summary

MembersDescriptions
public FString CategoryA “bigger.smaller.smallest.tiny” formatted string.For example, in a UI element specification, this could be “hud.minimap.expandButton”.
public FString StatusGeneric status.
public TOptional< FString > ContextGeneric context, possibly escaped JSON.
public TOptional< FString > VendorIdVendor ID for the order.
public TOptional< FString > LootIdLoot ID for the order.
public TOptional< FString > ItemIdSpecific Item ID.
public TOptional< int32 > StartProgressThe quantity value before the progression event.
public TOptional< int32 > EndProgressThe quantity value after the progression event.
public TOptional< FString > ProviderIdIdentifier for the authentication provider.
public TOptional< FString > OrderRefIdOrder reference ID.
public TOptional< FString > OrderIdOrder identifier.
public TOptional< FString > OrderEntryIdOrder entry identifier.
public TOptional< FString > DescriptionGeneric description string.
public TOptional< FString > SessionIdA SessionID to be associated with this event (ex: for gameplay rewards)
public TOptional< FString > InstanceIdA InstanceId to be associated with this event (ex: for gameplay rewards)
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FObjectiveProgressEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public FString Category

A “bigger.smaller.smallest.tiny” formatted string.For example, in a UI element specification, this could be “hud.minimap.expandButton”.


#### `public FString `[`Status`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a1666afdda05cb4637328a084935e9c9a)

Generic status.


#### `public TOptional< FString > `[`Context`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a5fa44ba551357c5931a544a7acc9f804)

Generic context, possibly escaped JSON.


#### `public TOptional< FString > `[`VendorId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a9c15bd432a7d967ec5bb3b6884e5c0fc)

Vendor ID for the order.


#### `public TOptional< FString > `[`LootId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1ad13f52f80bb9708ae92bcd01d27572db)

Loot ID for the order.


#### `public TOptional< FString > `[`ItemId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1ad4a2b8caf6e7b1a7d214bfb191409d7f)

Specific Item ID.


#### `public TOptional< int32 > `[`StartProgress`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a6a53df5dda366b73a78e53e664e0a69e)

The quantity value before the progression event.


#### `public TOptional< int32 > `[`EndProgress`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a143b405070508d212baa6c53f94c4b2e)

The quantity value after the progression event.


#### `public TOptional< FString > `[`ProviderId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a0a9c7c225a92a2e24ca1c595deb1a901)

Identifier for the authentication provider.


#### `public TOptional< FString > `[`OrderRefId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a44543703ee251c8012f231b98d2776c8)

Order reference ID.


#### `public TOptional< FString > `[`OrderId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1ace08b35c3ed55570033d7b606e04f112)

Order identifier.


#### `public TOptional< FString > `[`OrderEntryId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a3c9c1e2749fc414ed608d672146489be)

Order entry identifier.


#### `public TOptional< FString > `[`Description`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a6a42dfd2f81fdbfb7c60ff14203b075b)

Generic description string.


#### `public TOptional< FString > `[`SessionId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1ac13dff22b34faf109069a6ebbf18cbb9)

A SessionID to be associated with this event (ex: for gameplay rewards)


#### `public TOptional< FString > `[`InstanceId`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a6b0bd7a6a9497aebe4f49967394ac8a3)

A InstanceId to be associated with this event (ex: for gameplay rewards)


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1a9ffc3b2b5472a6ec21830cdc57638356)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FObjectiveProgressEvent`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1ae4ae09439045f64f41c15068bd296729)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FObjectiveProgressEvent_1afc45b87abf3b09ff20d3299ecb6a322e)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FPlayerGameResultEvent`

This event is meant to capture high level information about a completed match.The RHIntegration Plugin will not automatically trigger this, but this event is something that RallyHere will process and have an understanding of the data.

rh.player_game_result

Summary

MembersDescriptions
public TOptional< int32 > PlacementThe placement of the player in the game
public TOptional< FString > GameSessionIdThe session_id of the game
public TOptional< FString > InstanceIdThe instance_id of the game within the session
public TOptional< float > DurationSecondsThe duration of the game in seconds
public TOptional< FString > TeamIdThe team_id of the player
public TOptional< FString > RoundThe round of the game
public TOptional< FString > PartySessionIdThe session_id of the party the player is in
public TOptional< bool > IsAfkKickedWhether the player was kicked for being AFK
public TOptional< bool > WasBackfilledWhether the player was backfilled into the game
public TOptional< FString > PrimaryInputTypeThe primary input type of the player
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FPlayerGameResultEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public TOptional< int32 > Placement

The placement of the player in the game


#### `public TOptional< FString > `[`GameSessionId`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a998cf9acd8bf7ca3a162c62b7989774f)

The session_id of the game


#### `public TOptional< FString > `[`InstanceId`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a3036135c8fde18b3db67538cdf2dbca5)

The instance_id of the game within the session


#### `public TOptional< float > `[`DurationSeconds`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1aede2e3d23874e944f318e87fcb588f3d)

The duration of the game in seconds


#### `public TOptional< FString > `[`TeamId`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1ae1d77a154cb24e4a449552c004ced8c8)

The team_id of the player


#### `public TOptional< FString > `[`Round`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1ae27ed2a3cdae86c14f81c8a80989547d)

The round of the game


#### `public TOptional< FString > `[`PartySessionId`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a3cd4f78c414d84382109f60b78a6034e)

The session_id of the party the player is in


#### `public TOptional< bool > `[`IsAfkKicked`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a678f1a35938b6d7f9aac18c6858f13bf)

Whether the player was kicked for being AFK


#### `public TOptional< bool > `[`WasBackfilled`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a9606cf9d0fb06527326965a10c05ac0c)

Whether the player was backfilled into the game


#### `public TOptional< FString > `[`PrimaryInputType`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1adbe683133ec0c01df96811e54c4c235d)

The primary input type of the player


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a53999f026467c7e844cf0dbe19e36e37)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FPlayerGameResultEvent`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a63ed113be1c84b80b0d193dbf3faead0)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FPlayerGameResultEvent_1a5428c9acaee0b90c784476e272fae149)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FPlatformPurchaseEvent`

This event is triggered when processing of a real money purchase has been completed.

rh.platform_purchase

Summary

MembersDescriptions
public FCheckoutData CheckoutDataThe checkout data for the purchase
public FReceiptData ReceiptDataThe receipt data for the purchase
public FString StateThe state of the purchase
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FPlatformPurchaseEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public FCheckoutData CheckoutData

The checkout data for the purchase


#### `public `[`FReceiptData`](undefined.md#structRHStandardEvents_1_1FPlatformPurchaseEvent_1_1FReceiptData)` `[`ReceiptData`](#structRHStandardEvents_1_1FPlatformPurchaseEvent_1a86b933f5cb29196705c7a72828050f4b)

The receipt data for the purchase


#### `public FString `[`State`](#structRHStandardEvents_1_1FPlatformPurchaseEvent_1aa20e40471f982db8d7544951a49d253c)

The state of the purchase


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FPlatformPurchaseEvent_1ad5022bcbe859ffa72c5b593fa292d395)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FPlatformPurchaseEvent`](#structRHStandardEvents_1_1FPlatformPurchaseEvent_1a1b772cdc5a20dc0eac0f5b71f24531d7)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FPlatformPurchaseEvent_1ac11f111abda67274f03f584fc22912da)`(IAnalyticsProvider * Provider) const`
## struct `RHStandardEvents::FCustomEvent`

This is a wrapper for providing custom event data.

Summary

MembersDescriptions
public FString EventNameName of the event.
public TArray< FAnalyticsEventAttribute > AttributesAttribute list.
public TOptional< TMap< FString, FString > > CustomDatacustom data fields (will be auto-prefixed with custom data prefix)
public inline FCustomEvent()
public inline void EmitTo(IAnalyticsProvider * Provider) const

Members

public FString EventName

Name of the event.


#### `public TArray< FAnalyticsEventAttribute > `[`Attributes`](#structRHStandardEvents_1_1FCustomEvent_1af6f0ea633eef4ceab7a4a985cb57fff0)

Attribute list.


#### `public TOptional< TMap< FString, FString > > `[`CustomData`](#structRHStandardEvents_1_1FCustomEvent_1aa15d1cedc9143c218dc3db2506e32dc7)

custom data fields (will be auto-prefixed with custom data prefix)


#### `public inline `[`FCustomEvent`](#structRHStandardEvents_1_1FCustomEvent_1add4d8214b9316a09b1974046126b6787)`()`
#### `public inline void `[`EmitTo`](#structRHStandardEvents_1_1FCustomEvent_1a9c9fe99fea36643abbf5082ea6c8ce6e)`(IAnalyticsProvider * Provider) const`