Class Leaderboard

• Defined in File Leaderboard.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.Leaderboard : xbe.sdk.EntityBase

Describes a single leaderboard.

REQUIRES: Leaderboard Services

Public Functions

Leaderboard ()

Leaderboard (Object obj)

Properties

string Name { get; set; }

The unique name of the leaderboard.

string Description { get; set; }

Textual description of the leaderboard.

string Icon { get; set; }

The icon to display when representing the leaderboard.

Guid ProductUid { get; set; }

The uid of the product that this leaderboard is associated with.

REQUIRES: Leaderboard Services Studio.

string RankingSchedule { get; set; }

The cron-tab like schedule that will rank the leaderboard records. Setting to undefined will rank all records in real-time.Make sure to use a staggered schedule when also setting a value for resetSchedule to prevent from trying to rank the leaderboard at the same time the reset operation is occurring.

string ResetSchedule { get; set; }

The cron-tab like schedule that will reset all leaderboard records. Setting to undefined will retain all records indefinitely.Make sure to use a staggered schedule when also setting a value for rankingSchedule to prevent from trying to reset the leaderboard at the same time the ranking operation is occurring.

string Sort { get; set; }

The direction to sort the leaderboard record set. SORT_ASCENDING will sort from records from lowest to highest score, SORT_DESCENDING sorts from highest to lowest score.

string SortBy { get; set; }

The name of the leaderboard stat that records will be sorted by. Default is score.

string UpdateMethod { get; set; }

The method that will be used to accept new leaderboard records submissions. Default is BEST.

Public Static Functions

new Leaderboard Parse (string json)

Parses the given JSON encoded string into a new Leaderboard instance.

Param json:

Return:

Public Static Attributes

const string SORT_ASCENDING = "ASC"

Sort records from lowest to highest score.

const string SORT_DESCENDING = "DESC"

Sorts records from highest to lowest score.

const string BEST_SCORE = "BEST"

Accepts the best score submitted.

const string FIRST_SCORE = "FIRST"

Accepts only the first score submitted.

const string LAST_SCORE = "LAST"

Accepts the most recent score submitted.

const string SCORE = "score"

Default Sort By property.