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

FOvrLeaderboard Struct

Leaderboards provide a way for a game to keep track of players and their scores in relation to other. The leaderboard object contains information about this leaderboard ID, API name and destination. Lean more about leaderboard on our website.

Constructors

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

Fields

ApiName : FString
The API name of this leaderboard. This is a unique string that your application will refer to this leaderboard in your app code.
Signature
FString FOvrLeaderboard::ApiName
Destination : FOvrDestination
An optional deep link FOvrDestination, which means when a user clicks on the leaderboard, they will be taken to this in-app destination.
Signature
FOvrDestination FOvrLeaderboard::Destination
ID : FOvrId
The generated GUID of this leaderboard.
Signature
FOvrId FOvrLeaderboard::ID

Member Functions

Clear ()
Setting all values to their defaults, effectively clearing the struct.
Signature
void FOvrLeaderboard::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 FOvrLeaderboard::Update(ovrLeaderboardHandle OvrHandle, TOvrMessageHandlePtr MessageHandlePtr)
Parameters
OvrHandle: ovrLeaderboardHandle
MessageHandlePtr: TOvrMessageHandlePtr
Returns
void