API reference
API reference
Select your platform
No SDKs available
No versions available

FOvrSupplementaryMetric Struct

This is a supplemental piece of data that is used for a single write to leaderboard entries. This metric is used for tiebreaker scenarios. You can make such an entry by using Leaderboard_WriteEntryWithSupplementaryMetric()

Constructors

FOvrSupplementaryMetric ()
This is the default constructor for the struct, which initializes the ovrSupplementaryMetricHandle and TOvrMessageHandlePtr to their default values.
Signature
FOvrSupplementaryMetric::FOvrSupplementaryMetric()
FOvrSupplementaryMetric ( OvrHandle , MessageHandlePtr )
Copying values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
FOvrSupplementaryMetric::FOvrSupplementaryMetric(ovrSupplementaryMetricHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters

Fields

ID : FOvrId
The ID of the leaderboard that this supplementary metric belongs to. This is the unique value for every FOvrLeaderboard.
Signature
FOvrId FOvrSupplementaryMetric::ID
Metric : int64
This is the metric that is used to determine tiebreaks.
Signature
int64 FOvrSupplementaryMetric::Metric

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrSupplementaryMetric::Clear()
Returns
void
Update ( OvrHandle , MessageHandlePtr )
Updating values from an OVR handle to the array, and the originating message to prevent the handle from being freed.
Signature
void FOvrSupplementaryMetric::Update(ovrSupplementaryMetricHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
Returns
void