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

FOvrChallenge Struct

Challenges leverage FOvrDestination and Group Presence to create shareable links that allow players to compete directly based on score.
Challenges can be ranked by highest or lowest scores within a time period. Any application that uses Leaderboards gets Challenges for free. It appears in the Scoreboards UI. Players can create Challenges and send invites through the Challenges app.

Constructors

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

Fields

An enum that specifies if this challenge was created by a user (EOvrChallengeCreationType::UserCreated) or the app developer (EOvrChallengeCreationType::DeveloperCreated).
Signature
EOvrChallengeCreationType FOvrChallenge::CreationType
Description : FString
A displayable string of the challenge's description.
Signature
FString FOvrChallenge::Description
EndDate : FDateTime
The timestamp when this challenge ends. You can retrieve this field from the response of the challenge creation request.
Signature
FDateTime FOvrChallenge::EndDate
ID : FOvrId
The ID of the challenge. This is an unique string that the application will refer to this challenge in your app.
Signature
FOvrId FOvrChallenge::ID
InvitedUsers : FOvrUserPages
Users that are invited to this challenge.
Signature
FOvrUserPages FOvrChallenge::InvitedUsers
Leaderboard : FOvrLeaderboard
The FOvrLeaderboard associated with this challenge. You can retrieve the leaderboard ID from the response of the challenge creation request.
Signature
FOvrLeaderboard FOvrChallenge::Leaderboard
Participants : FOvrUserPages
Users that have participated in this challenge.
Signature
FOvrUserPages FOvrChallenge::Participants
StartDate : FDateTime
The timestamp when this challenge begins. You can retrieve this field from the response of the challenge creation request.
Signature
FDateTime FOvrChallenge::StartDate
Title : FString
A displayable string of the challenge's title.
Signature
FString FOvrChallenge::Title
An enum that specifies who can see and participate in this challenge.
EOvrChallengeVisibility::InviteOnly - Only those invited can participate in it. Everyone can see it.
EOvrChallengeVisibility::Public - Everyone can participate and see this challenge.
EOvrChallengeVisibility::Private - Only those invited can participate and see this challenge.
Signature
EOvrChallengeVisibility FOvrChallenge::Visibility

Member Functions

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