s&box docs

public class Sandbox.Services.Leaderboards.Board2

Constructors

Showing 1 constructors

public Board2(string package, string name)

Methods

Showing 20 methods

public void CenterOnMe()

Center the results on you, show the surrounding results with you in the middle.

public void CenterOnSteamId(long steamid)

Center the results on this steamid, show the surrounding results with this in the middle.

public void FilterByDay()

public void FilterByMonth()

public void FilterByNone()

public void FilterByWeek()

public void FilterByYear()

public void IncludeSteamIds(long[] steamids)

If they have any results, include these steamids in the results - regardless of their position.

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

Parameters

  • cancellation: Default: null

public void SetAggregationAvg()

public void SetAggregationLast()

public void SetAggregationMax()

public void SetAggregationMin()

public void SetAggregationSum()

public void SetCountryAuto()

public void SetCountryCode(string countryCode)

public void SetDatePeriod(System.DateTime dateTime)

public void SetFriendsOnly(bool friendsOnly)

public void SetSortAscending()

public void SetSortDescending()

Properties

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.

public int Sandbox.Services.Leaderboards.Board2.Offset { get; set; }

The offset to start at. If less than 0, we will start from the bottom.

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

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

public string Sandbox.Services.Leaderboards.Board2.TimePeriodDescription { get; set; }

If you are restructing by time period, this is the name of the period

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

The total number of chart entries for this board.

Metadata

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

On this page

Constructorspublic Board2(System.String package, System.String name)Methodspublic System.Void CenterOnMe()public System.Void CenterOnSteamId(System.Int64 steamid)public System.Void FilterByDay()public System.Void FilterByMonth()public System.Void FilterByNone()public System.Void FilterByWeek()public System.Void FilterByYear()public System.Void IncludeSteamIds(System.Int64[] steamids)public System.Threading.Tasks.Task Refresh(System.Threading.CancellationToken cancellation = null)public System.Void SetAggregationAvg()public System.Void SetAggregationLast()public System.Void SetAggregationMax()public System.Void SetAggregationMin()public System.Void SetAggregationSum()public System.Void SetCountryAuto()public System.Void SetCountryCode(System.String countryCode)public System.Void SetDatePeriod(System.DateTime dateTime)public System.Void SetFriendsOnly(System.Boolean friendsOnly)public System.Void SetSortAscending()public System.Void SetSortDescending()Propertiespublic Sandbox.Services.Leaderboards.Board2.Entry[] Sandbox.Services.Leaderboards.Board2.Entries { get; set; }public System.Int32 Sandbox.Services.Leaderboards.Board2.MaxEntries { get; set; }public System.Int32 Sandbox.Services.Leaderboards.Board2.Offset { get; set; }public System.String Sandbox.Services.Leaderboards.Board2.Stat { get; set; }public System.Int64 Sandbox.Services.Leaderboards.Board2.TargetSteamId { get; set; }public System.String Sandbox.Services.Leaderboards.Board2.TimePeriodDescription { get; set; }public System.Int64 Sandbox.Services.Leaderboards.Board2.TotalEntries { get; set; }Metadata