SkillzCrossPlatform

The main point of interaction with Skillz.

Start Skillz

LaunchSkillz

Launches the Skillz UI. This method is overloaded.

Asynchronous

Synchronous

public static void LaunchSkillz(SkillzMatchDelegate _matchDelegate);

Parameters

_matchDelegate A reference to a SkillzMatchDelegate instance that Skillz will use.

public static void LaunchSkillz(SkillzSyncDelegate _syncMatchDelegate);

Parameters

_syncMatchDelegate A reference to a SkillzSyncDelegate instance that Skillz will use.

Match Completion and Score Methods

AbortMatch

Forfeits the current match and returns to the Skillz UI.

public static void AbortMatch();

DisplayTournamentResultsWithScore

The DisplayTournamentResultsWithScore method replaces the deprecated ReportFinalScore method. Skillz recommends that you try to use the SubmitScore and ReturnToSkillz methods in general. However, DisplayTournamentResultsWithScore can be used if for some reason the SubmitScore method fails. This can be used as a fail safe method as a best practice.

String score

Int score

Float score

public static void DisplayTournamentResultsWithScore(string score)

Parameters

score The player's final score as a string.

public static void DisplayTournamentResultsWithScore(int score)

Parameters

score The player's final score as an integer.

public static void DisplayTournamentResultsWithScore(float score)

Parameters

score The player's final score as a float.

ReportFinalScore (Deprecated)

Call this method when a player finishes a match. This will report the result of the game to the Skillz server, and return the player to the Skillz UI. This method is overloaded.

String score

Int score

Float score

public static void ReportFinalScore(String score)

Parameters

score The player's final score as a string.

public static void ReportFinalScore(int score)

Parameters

score The player's final score as an integer.

public static void ReportFinalScore(float score)

Parameters

score The player's final score as a float.

ReturnToSkillz

The ReturnToSkillz method presents the Skillz UI. This must be called after the score has been submitted with the SubmitScore method. After the SubmitScore has been called you can present users with relevant statistics such as high score and present content to enhance the game experience.

In all cases, it will return true or false, depending on whether or not it is able to return the user to Skillz. For the case of a match in progress, unless a score has been submitted, this method will return false and the user will not be returned to Skillz. If a score has been submitted, it returns true and returns the user to Skillz.

public static bool ReturnToSkillz()

Returns

True if score has been submitted and user can return to Skillz, false if match is in progress or score has not been submitted.

SubmitScore

Call this method when a player finishes a match. This will send the score to Skillz and conclude the match.

String score

Int score

Float score

public static void SubmitScore(string score, Action successCallback, Action<string> failureCallback)

Parameters

score The player's final score as a string.

successCallback Implementation of the System.Action delegate that handles successful submission

failureCallback Implementation of the System.Action delegate that handles failures

public static void SubmitScore(int score, Action successCallback, Action<string> failureCallback)

Parameters

score The player's final score as an integer.

successCallback Implementation of the System.Action delegate that handles successful submission

failureCallback Implementation of the System.Action delegate that handles failures

public static void SubmitScore(float score, Action successCallback, Action<string> failureCallback)

Parameters

score The player's final score as a float.

successCallback Implementation of the System.Action delegate that handles successful submission

failureCallback Implementation of the System.Action delegate that handles failures

Progression Methods

ProgressionNamespace Constants

Calls to the progression methods must use one of the three namespace string values. Each namespace return a separate list of key-value pairs for for that namespace:

// For player data and is game specific.
ProgressionNamespace.PLAYER_DATA
ProgressionNamespace.DEFAULT_PLAYER_DATA

// In game items and is shared across all games in publisher's portfolio.
ProgressionNamespace.IN_GAME_ITEMS

GetProgressionUserData

Call this method to request progression data for the currently logged in user. This will invoke one of the given callbacks when the attempted request is completed.

public static void GetProgressionUserData(string progressionNamespace, List<string> userDataKeys, Action<Dictionary<string, ProgressionValue>> successCallback, Action<string> failureCallback)

Parameters

progressionNamespace Use one of the following valid progression namespace string constants to fetch the progression data.

ProgressionNamespace.PLAYER_DATA
ProgressionNamespace.DEFAULT_PLAYER_DATA
ProgressionNamespace.IN_GAME_ITEMS

userDataKeys The list of user progression data elements to fetch.

successCallback The callback that will be invoked with the successfully retrieved user data.

failureCallback The callback that will be invoked with an error message if the request cannot be completed.

UpdateProgressionUserData

Call this method to update progression data for the currently logged in user. This must be called with no more than 25 elements and will invoke one of the given callbacks when the attempted update is completed.

public static void UpdateProgressionUserData(string progressionNamespace, Dictionary<string, object> userDataUpdates, Action successCallback, Action<string> failureCallback)

Parameters

progressionNamespace Use one of the following valid progression namespace string constants to fetch the progression data.

ProgressionNamespace.PLAYER_DATA
ProgressionNamespace.IN_GAME_ITEMS

userDataKeys The dictionary of keys and values to set as the user data.

successCallback The callback that will be invoked when the update is completed successfully.

failureCallback The callback that will be invoked with an error message if the update cannot be completed.

Gameplay Methods

EndReplay

End the current replay if one exists and returns the status of the score submission.

public static bool EndReplay()

Returns

True if end replay was successful and false if the user has not submitted a score for the match.

IsMatchInProgress

Checks if a match is currently in progress.

public static bool IsMatchInProgress();

Returns

A bool indicating if a match if is in progress.

GetMatchRules

Returns the match rules that you set up in the Skillz Developer Console for each match type.

public static Hashtable GetMatchRules();

Returns

A Hashtable containing a key-value pair for each rule of the current match type.

GetMatchInfo

public static Match GetMatchInfo();

Returns

A Match object containing information about the current match in progress.

UpdatePlayersCurrentScore

Call this method every time the player's score changes during a Skillz match. This method is overloaded.

String score

Int score

Float score

SkillzCrossPlatform.UpdatePlayersCurrentScore(string score);

Parameters

score The player's current score as a string.

SkillzCrossPlatform.UpdatePlayersCurrentScore(int score);

Parameters

score The player's current score as an integer.

SkillzCrossPlatform.UpdatePlayersCurrentScore(float score);

Parameters

score The player's current score as a float.

SDKVersionShort

Gets the version of the Skillz SDK your game is being run on.

public static string SDKVersionShort();

Returns

The Skillz SDK's version as a string.

GetPlayer

Gets information about the player.

public static SkillzSDK.Player GetPlayer();

Returns

A Player object.

SkillzCrossPlatform.Random

Value

Use the Skillz random implementation to ensure each competitor recieves the exact same random number.

SkillCrossPlatform.Random.Value()

InsideUnitSphere

Find a point inside the unit sphere using Value().

public static Vector3 InsideUnitSphere();

InsideUnitCircle

Find a point inside the unit circle using Value().

public static Vector2 InsideUnitCircle();

OnUnitSphere

Hybrid rejection / trig method to generate points on a sphere using Value().

public static Vector3 OnUnitSphere();

RotationUniform

Quaternion random using Value().

public static Quaternion RotationUniform();

Rotation

Quaternion random using Value().

public static Quaternion Rotation();

Range

Ranged random using Value(). This method is overloaded.

Float based

Int based

public static float Range(float min, float max);

public static int Range(int min, int max);

Parameters

min The minimum value.

max The maximum value.

Returns

The random value in between min and max, inclusive.

Objects

CustomServerConnectionInfo

Property	Data Type	Description
isBotMatch	bool	Indicates if the match is a sync bot match
MatchId	string	The ID of the real-time match
MatchToken	string	An encrypted token to help validate the session server side
ServerIp	string	The hostname or IP for the match
ServerPort	string	The port for the game server

Match

Property	Data Type	Description
CustomServerConnectionInfo	CustomServerConnectionInfo	The connection info to a custom server that coordinates a real-time match
Description	string	The description of this tournament type
EntryCash	float?	If this tournament is being played for real cash, this is the amount of cash required to enter
EntryPoints	int?	If this tournament is being played for Z, this is the amount of Z required to enter.
GameParams	Dictionary<string, string>	The custom parameters for this tournament type specified in the developer portal
ID	ulong?	The unique ID for the match
IsCash	bool?	Indicates the match is for real prizes or for Z
IsCustomSynchronousMatch	bool	Indicates if the match is a sync match
IsSynchronous	bool	Deprecated. Indicates if this match is Sync. Note: please use the IsCustomSynchronousMatch property
Name	string	Name of the match
Players	List<Player>	List of players in the match
SkillzDifficulty	uint?	The difficulty of the game (used with automatic difficulty). Note: only set in production.
TemplateID	int?	The unique ID for the tournament template this match is based on

Player

Property	Data Type	Description
AvatarURL	string	A link to the user's avatar image
DisplayName	string	Player name
FlagURL	string	A link to the user's country's flag image
ID	ulong?	The unique ID for this match
IsCurrentPlayer	bool	This Player represents the current user if this is true
TournamentPlayerID	ulong?	A Tournament Player ID unique to this user

ProgressionMetadata

Property	Data Type	Description
GameIds	List<string>	List of relevant game IDs for the associated ProgressionValue

ProgressionValue

Property	Data Type	Description
DataType	string	The data type for the stored value
DisplayName	string	The display name for the stored value
LastUpdatedTime	DateTime	The timestamp of when the data was last updated on Skillz servers in UTC
Metadata	ProgressionMetadata	The metadata for this progression value
Value	string	The stored value for this progression value

Interfaces

SkillzMatchDelegate

Implement this interface to be notified when an asynchronous match is about to begin, and for other events of interest.

OnMatchWillBegin

Called when an asynchronous match is about to begin.

void OnMatchWillBegin(Match matchInfo);

Parameters

matchInfo A Match object containing info about the match.

OnSkillzWillExit

Called when the Skillz UI is exiting via the side menu.

void OnSkillzWillExit();

OnProgressionRoomEnter

Called when Progression Room Entry Point is acted upon (via Skillz home tab or side menu)

void OnProgressionRoomEnter();