s&box docs

public class Sandbox.Services.Leaderboards.Board

Broader workflow and conceptual references connected to this API.

Constructors

Showing 1 constructors

public Board(string package, string name)

Methods

Showing 1 methods

public System.Threading.Tasks.Task Refresh(System.Threading.CancellationToken cancellation = null)

Parameters

  • cancellation: Default: null

Properties

Showing 9 properties

public string Sandbox.Services.Leaderboards.Board.Description { get; set; }

The description of this board, which was set in the backend.

public string Sandbox.Services.Leaderboards.Board.DisplayName { get; set; }

The display name of this board, which was set in the backend.

public Sandbox.Services.Leaderboards.Entry[] Sandbox.Services.Leaderboards.Board.Entries { get; set; }

The group of entries for this board. This is usually the entries that surround the TargetSteamId.

public string Sandbox.Services.Leaderboards.Board.Group { get; set; }

global, country, friends

public int Sandbox.Services.Leaderboards.Board.MaxEntries { get; set; }

The maximum entries to respond with.

public long Sandbox.Services.Leaderboards.Board.TargetSteamId { get; set; }

The steamid to get information about. If unset then this defaults to the current player.

public string Sandbox.Services.Leaderboards.Board.Title { get; set; }

The group name of this board. For example, "Global" for global, "Friends" for friends.

public long Sandbox.Services.Leaderboards.Board.TotalEntries { get; set; }

The total number of chart entries for this board.

public string Sandbox.Services.Leaderboards.Board.Unit { get; set; }

The unit type chosen for this board

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Services.Leaderboards.Board

On this page