Game Jolt Unity API  v2.5.8
Public Member Functions | Protected Member Functions | List of all members
GameJolt.UI.GameJoltUI Class Reference

The UI API Manager. More...

Inheritance diagram for GameJolt.UI.GameJoltUI:
GameJolt.API.Core.MonoSingleton< GameJoltUI >

Public Member Functions

void ShowSignIn ()
 Shows the sign in window. If the user's credentials are stored in PlayerPrefs, it will populate the fields with them. More...
 
void ShowSignIn (Action< bool > signedInCallback, Action< bool > userFetchedCallback=null)
 Shows the sign in windows. If the user's credentials are stored in PlayerPrefs, it will populate the fields with them. More...
 
void ShowTrophies ()
 Shows the trophies windows. More...
 
void ShowTrophies (Action< bool > callback)
 Shows the trophies windows. More...
 
void ShowLeaderboards ()
 Shows the leaderboards window. More...
 
void ShowLeaderboards (Action< bool > callback)
 Shows the leaderboards window. More...
 
void ShowLeaderboards (Action< bool > callback, int? activeTable, params int[] visibleTables)
 Shows the leaderboards window. More...
 
void QueueNotification (string text)
 Queues a notification. More...
 
void QueueNotification (string text, Sprite image)
 Queues a notification. More...
 
void QueueNotification (Objects.Notification notification)
 Queues a notification. More...
 

Protected Member Functions

override void Init ()
 Init this instance. More...
 

Additional Inherited Members

- Properties inherited from GameJolt.API.Core.MonoSingleton< GameJoltUI >
static T Instance [get]
 

Detailed Description

The UI API Manager.

Member Function Documentation

◆ Init()

override void GameJolt.UI.GameJoltUI.Init ( )
inlineprotectedvirtual

Init this instance.

Reimplemented from GameJolt.API.Core.MonoSingleton< GameJoltUI >.

◆ QueueNotification() [1/3]

void GameJolt.UI.GameJoltUI.QueueNotification ( string  text)
inline

Queues a notification.

Parameters
textThe notification text.

◆ QueueNotification() [2/3]

void GameJolt.UI.GameJoltUI.QueueNotification ( string  text,
Sprite  image 
)
inline

Queues a notification.

Parameters
textThe notification text.
imageThe notification image.

◆ QueueNotification() [3/3]

void GameJolt.UI.GameJoltUI.QueueNotification ( Objects.Notification  notification)
inline

Queues a notification.

Parameters
notificationThe Objects.Notification.

◆ ShowLeaderboards() [1/3]

void GameJolt.UI.GameJoltUI.ShowLeaderboards ( )
inline

Shows the leaderboards window.

◆ ShowLeaderboards() [2/3]

void GameJolt.UI.GameJoltUI.ShowLeaderboards ( Action< bool >  callback)
inline

Shows the leaderboards window.

Parameters
callbackA callback function accepting a single parameter, a boolean indicating success.

◆ ShowLeaderboards() [3/3]

void GameJolt.UI.GameJoltUI.ShowLeaderboards ( Action< bool >  callback,
int?  activeTable,
params int []  visibleTables 
)
inline

Shows the leaderboards window.

Parameters
callbackA callback function accepting a single parameter, a boolean indicating success.
activeTableThe table which should be active. If null, the primary table is active.
visibleTablesThe ids of the tables to be shown. If null or empty, all tables are shown.

◆ ShowSignIn() [1/2]

void GameJolt.UI.GameJoltUI.ShowSignIn ( )
inline

Shows the sign in window. If the user's credentials are stored in PlayerPrefs, it will populate the fields with them.

◆ ShowSignIn() [2/2]

void GameJolt.UI.GameJoltUI.ShowSignIn ( Action< bool >  signedInCallback,
Action< bool >  userFetchedCallback = null 
)
inline

Shows the sign in windows. If the user's credentials are stored in PlayerPrefs, it will populate the fields with them.

Parameters
signedInCallbackA callback function accepting a single parameter, a boolean indicating whether the user has been signed-in successfully.
userFetchedCallbackA callback function accepting a single parameter, a boolean indicating whether the user's information have been fetched successfully.

◆ ShowTrophies() [1/2]

void GameJolt.UI.GameJoltUI.ShowTrophies ( )
inline

Shows the trophies windows.

◆ ShowTrophies() [2/2]

void GameJolt.UI.GameJoltUI.ShowTrophies ( Action< bool >  callback)
inline

Shows the trophies windows.

Parameters
callbackA callback function accepting a single parameter, a boolean indicating success.

The documentation for this class was generated from the following file: