Class UILeaderboardMenu

Namespace

PlayEveryWare.EpicOnlineServices.Samples

public class UILeaderboardMenu : SampleMenu

Inheritance

object

SampleMenu

UILeaderboardMenu

Inherited Members

SampleMenu.UIFirstSelected

SampleMenu.UIParent

SampleMenu.Hidden

SampleMenu.RequiresAuthentication

SampleMenu.StartsHidden

SampleMenu.Awake()

SampleMenu.OnEnable()

SampleMenu.Update()

SampleMenu.Hide()

SampleMenu.Log(string, string)

Fields

CurrentSelectedLeaderboardTxt

public Text CurrentSelectedLeaderboardTxt

Field Value

Text

LeaderboardDefinitionsContentParent

public GameObject LeaderboardDefinitionsContentParent

Field Value

GameObject

LeaderboardEntriesContentParent

public GameObject LeaderboardEntriesContentParent

Field Value

GameObject

SecondsAfterStatIngestedToRefresh

If this value is greater than 0, after a successful IngestStatOnClick(), this amount of seconds will be waited before refreshing the current leaderboard. There's no promise that a successfully ingested stat means that it is proliferated across other Epic Online Services systems, like leaderboards. This delay is a guess at how long to reasonably wait before requerying the leaderboard to reflect the newly ingested stat.

public float SecondsAfterStatIngestedToRefresh

Field Value

float

SecondsBetweenLeaderboardRefreshes

If this value is greater than 0, then every time this number of seconds pass, the current viewed leaderboard will refresh. The internal timer for this resets whenever a leaderboard is queried. There is no way to determine when a successfully ingested stat has been fully processed, and that stat proliferated to the leaderboards in the back end. Periodic refreshing of the leaderboard is one way to get up to date information. Note that per user, you should never request stats more than 100 times a minute.

public float SecondsBetweenLeaderboardRefreshes

Field Value

float

UIFileNameEntryPrefab

public GameObject UIFileNameEntryPrefab

Field Value

GameObject

UILeaderboardEntryPrefab

public GameObject UILeaderboardEntryPrefab

Field Value

GameObject

ingestStatValueInput

public UIConsoleInputField ingestStatValueInput

Field Value

UIConsoleInputField

Methods

IngestStatOnClick()

public void IngestStatOnClick()

OnDestroy()

When overriding, call this base implementation first.

protected override void OnDestroy()

RefreshCurrentSelectedLeaderboard()

If a leaderboard is selected, re-query and re-display its values.

public void RefreshCurrentSelectedLeaderboard()

RefreshDefinitionsOnClick()

public void RefreshDefinitionsOnClick()

Show()

Shows the SampleMenu. If overriding, make sure to call this base implementation first.

public override void Show()

ShowFriendsOnClick()

public void ShowFriendsOnClick()

ShowGlobalOnClick()

public void ShowGlobalOnClick()