class
Board2
public class Board2 Constructors
Board2(String package, String name) Properties
| Name | Type | Description |
|---|---|---|
Stat | String | |
TargetSteamId | Int64 | The steamid to get information about. If unset then this defaults to the current player. |
MaxEntries | Int32 | The maximum entries to respond with. |
Offset | Int32 | The offset to start at. If less than 0, we will start from the bottom. |
TotalEntries | Int64 | The total number of chart entries for this board. |
TimePeriodDescription | String | If you are restructing by time period, this is the name of the period |
Entries | Entry[] | The group of entries for this board. This is usually the entries that surround the TargetSteamId. |
Methods
Void SetAggregationSum() Void SetAggregationAvg() Void SetAggregationMin() Void SetAggregationMax() Void SetAggregationLast() Void SetSortAscending() Void SetSortDescending() Void SetFriendsOnly(Boolean friendsOnly) Void SetCountryCode(String countryCode) Void SetCountryAuto() Void FilterByYear() Void FilterByMonth() Void FilterByWeek() Void FilterByDay() Void FilterByNone() Void SetDatePeriod(DateTime dateTime) Void CenterOnSteamId(Int64 steamid) Center the results on this steamid, show the surrounding results with this in the middle.
Void CenterOnMe() Center the results on you, show the surrounding results with you in the middle.
Void IncludeSteamIds(Int64[] steamids) If they have any results, include these steamids in the results - regardless of their position.
Task Refresh(CancellationToken cancellation = null) Assembly:
Sandbox.Engine Declaring Type: Leaderboards Full Name: Sandbox.Services.Leaderboards.Board2