Board2class
Constructors1
Showing 1 constructors
public Board2(string package, string name)
| Parameter | Type | Description |
|---|---|---|
| package | string | — |
| name | string | — |
No results match this filter.
Methods20
Showing 20 methods
public void CenterOnMe()
Center the results on you, show the surrounding results with you in the middle.
void—public void CenterOnSteamId(long steamid)
Center the results on this steamid, show the surrounding results with this in the middle.
| Parameter | Type | Description |
|---|---|---|
| steamid | long | — |
void—public void FilterByDay()
void—public void FilterByMonth()
void—public void FilterByNone()
void—public void FilterByWeek()
void—public void FilterByYear()
void—public void IncludeSteamIds(long[] steamids)
If they have any results, include these steamids in the results - regardless of their position.
| Parameter | Type | Description |
|---|---|---|
| steamids | long[] | — |
void—public System.Threading.Tasks.Task Refresh(System.Threading.CancellationToken cancellation = null)
| Parameter | Type | Description |
|---|---|---|
| cancellation = null | CancellationToken | — |
Task—public void SetAggregationAvg()
void—public void SetAggregationLast()
void—public void SetAggregationMax()
void—public void SetAggregationMin()
void—public void SetAggregationSum()
void—public void SetCountryAuto()
void—public void SetCountryCode(string countryCode)
| Parameter | Type | Description |
|---|---|---|
| countryCode | string | — |
void—public void SetDatePeriod(System.DateTime dateTime)
| Parameter | Type | Description |
|---|---|---|
| dateTime | DateTime | — |
void—public void SetFriendsOnly(bool friendsOnly)
| Parameter | Type | Description |
|---|---|---|
| friendsOnly | bool | — |
void—public void SetSortAscending()
void—public void SetSortDescending()
void—No results match this filter.
Properties7
Showing 7 properties
public Sandbox.Services.Leaderboards.Board2.Entry[] Sandbox.Services.Leaderboards.Board2.Entries { get; set; }
The group of entries for this board. This is usually the entries that surround the TargetSteamId.
public int Sandbox.Services.Leaderboards.Board2.MaxEntries { get; set; }
The maximum entries to respond with.
int—public int Sandbox.Services.Leaderboards.Board2.Offset { get; set; }
The offset to start at. If less than 0, we will start from the bottom.
int—public string Sandbox.Services.Leaderboards.Board2.Stat { get; set; }
string—public long Sandbox.Services.Leaderboards.Board2.TargetSteamId { get; set; }
The steamid to get information about. If unset then this defaults to the current player.
long—public string Sandbox.Services.Leaderboards.Board2.TimePeriodDescription { get; set; }
If you are restructing by time period, this is the name of the period
string—public long Sandbox.Services.Leaderboards.Board2.TotalEntries { get; set; }
The total number of chart entries for this board.
long—No results match this filter.