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

FOvrChallengeOptions Struct

The Challenge Option is a parameter that can be passed in the UOvrRequestsBlueprintLibrary::Challenges_GetList() method to retrieve a list of challenges that match the specified options. The FOvrChallengeOptions parameter allows you to specify the criteria for the challenges you want to retrieve, such as the viewer filter, the visibility, or the date range.

Fields

The description of the challenge is a detailed and informative text that provides a comprehensive overview of the challenge's objectives, rules, and requirements, which can be retrieved with field FOvrChallenge::Description.
The challenge end date is the timestamp when this challenge ends, which can be retrieved using field FOvrChallenge::EndDate.
This option indicates whether to include challenges that are currently active in the search results. By default, this is set to true, meaning that only active challenges will be returned.
This option indicates whether to include challenges that have not yet started in the search results. By default, this is set to false, meaning that only active will be returned.
This option indicates whether to include challenges that have already ended in the search results. By default, this is set to false, meaning that only active will be returned.
Optional: Only find challenges belonging to this leaderboard. This filter allows you to narrow down the search results to only include challenges that are associated with a specific leaderboard.
The challenge start date is the timestamp when this challenge begins, which can be retrieved using field FOvrChallenge::StartDate.
The title of the challenge is a descriptive label that provides a concise summary of the challenge's purpose and objectives, which can be retrieved with field FOvrChallenge::Title.
An enum that specifies what filter to apply to the list of returned challenges.Returns all public (EOvrChallengeVisibility::Public) and invite-only (EOvrChallengeVisibility::InviteOnly) FOvrChallenge in which the user is a participant or invitee. Excludes private (EOvrChallengeVisibility::Private) challenges.EOvrChallengeViewerFilter::Participating - Returns challenges the user is participating in.EOvrChallengeViewerFilter::Invited - Returns challenges the user is invited to.EOvrChallengeViewerFilter::ParticipatingOrInvited - Returns challenges the user is either participating in or invited to.
The challenge visibility setting specifies who can see and participate in this challenge, which be retrieved with field FOvrChallenge::Visibility. There are three visibility levels: EOvrChallengeVisibility::Public, EOvrChallengeVisibility::InviteOnly and EOvrChallengeVisibility::Private.

Member Functions

FOvrChallengeOptions ( )
Did you find this page helpful?
Thumbs up icon
Thumbs down icon