API Referenceglobal
Boardclass
object→Board
Constructors1
Showing 1 constructors
public Board(string package, string name)
| Parameter | Type | Description |
|---|---|---|
| package | string | — |
| name | string | — |
No results match this filter.
Methods1
Showing 1 methods
public System.Threading.Tasks.Task Refresh(System.Threading.CancellationToken cancellation = null)
| Parameter | Type | Description |
|---|---|---|
| cancellation = null | CancellationToken | — |
Returns:
Task—No results match this filter.
Properties9
Showing 9 properties
public string Sandbox.Services.Leaderboards.Board.Description { get; set; }
The description of this board, which was set in the backend.
Returns:
string—public string Sandbox.Services.Leaderboards.Board.DisplayName { get; set; }
The display name of this board, which was set in the backend.
Returns:
string—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
Returns:
string—public int Sandbox.Services.Leaderboards.Board.MaxEntries { get; set; }
The maximum entries to respond with.
Returns:
int—public long Sandbox.Services.Leaderboards.Board.TargetSteamId { get; set; }
The steamid to get information about. If unset then this defaults to the current player.
Returns:
long—public string Sandbox.Services.Leaderboards.Board.Title { get; set; }
The group name of this board. For example, "Global" for global, "Friends" for friends.
Returns:
string—public long Sandbox.Services.Leaderboards.Board.TotalEntries { get; set; }
The total number of chart entries for this board.
Returns:
long—public string Sandbox.Services.Leaderboards.Board.Unit { get; set; }
The unit type chosen for this board
Returns:
string—No results match this filter.