Class: PS

Extends

• starsGDK.Class

Classes

clientUI

loader

lobby

locale

sound

Methods

staticwindow.PS.animationCompleted()

source/main.js, line 442

Send message to the server after game animation completed

staticwindow.PS.areWeInGermany()

source/main.js, line 505

Get areWeInGermany

staticwindow.PS.autoPlayStarted()

source/main.js, line 257

Game client notify GDK that auto-play had started.

staticwindow.PS.autoPlayStopped()

source/main.js, line 270

Game client notify GDK that auto-play had stopped.

staticwindow.PS.gameReadyForInteraction()

source/main.js, line 170

Game notify GDK that it loaded scene and ready for further interaction

staticwindow.PS.gameStatusUpdated(gameStatusTypes){String}

source/main.js, line 523

Update the status of the game

Name	Type	Description
gameStatusTypes	String	either handStart or handEnd

Returns:

Type	Description
String

staticwindow.PS.gameViewInitialized()

source/main.js, line 209

Game notify GDK that it view is loaded, can be used by GDK for various needs. In production GDK, as of right now (2017-12-19) it used to init jackpot channel. In a local GDK it's not necessary since jackpot info pumped through to the game all the time.

staticwindow.PS.gameWagerUpdated(amount)

source/main.js, line 401

Update bottom bar with player wager on mobile devices

Name	Type	Description
amount	Number

staticwindow.PS.gameWonUpdated(amount)

source/main.js, line 422

Update bottom bar with player winnings on mobile devices

Name	Type	Description
amount	Number

staticwindow.PS.getGlobalSetting(key){String}

source/main.js, line 468

Get specific global setting

Name	Type	Description
key	String

Returns:

Type	Description
String

staticwindow.PS.getGlobalSettings(){Object}

source/main.js, line 513

Get all global settings

Returns:

Type	Description
Object

staticwindow.PS.getUserData(key){String}

source/main.js, line 532

Get persistent custom user data

Name	Type	Description
key	String

Returns:

Type	Description
String

staticwindow.PS.init()

source/main.js, line 75

Init client UI HTML/CSS parts after GDK local initialized, game launched and we have access to game canvas

staticwindow.PS.isAutoPlayAllowed()

source/main.js, line 498

Get isAutoPlayAllowed

staticwindow.PS.isSoundControlInGameAllowed()

source/main.js, line 491

Get SoundControlInGameAllowd

staticwindow.PS.orientationChanged()

source/main.js, line 163

Notify lobby that game orientation changed. Implementation does not required for local GDK functionality. Yet.

staticwindow.PS.registerMessageHandler(messageType, handler, context)

source/main.js, line 636

Register handler for received messages

Name	Type	Description
messageType	String	message type for which handler is registered
handler	function	execution function for message
context	Object	context for handler execution

staticwindow.PS.removeUserData(key){boolean}

source/main.js, line 580

Remove persistent custom user data

Name	Type	Description
key	String

Returns:

Type	Description
boolean

staticwindow.PS.requestAutoPlay()

source/main.js, line 223

Game client request to show an autoplay pop-up HTML component.

staticwindow.PS.send(message)

source/main.js, line 706

Send message from client to server

Name	Type	Description
message	Object | String

staticwindow.PS.setGameClientReference(game)

source/main.js, line 151

Set reference for game client object

Name	Type	Description
game	Object

staticwindow.PS.setGlobalSetting(key, value)

source/main.js, line 484

Set specific global setting

Name	Type	Description
key	String
value	*

staticwindow.PS.setManualOutcome(outcome)

source/main.js, line 780

Manually set entropy sent from the client

Name	Type	Description
outcome	String

staticwindow.PS.setUserData(key, value){boolean}

source/main.js, line 555

Set persistent custom user data

Name	Type	Description
key	String
value	String

Returns:

Type	Description
boolean

staticwindow.PS.unregisterMessageHandler(messageType)

source/main.js, line 652

Unregister message handler

Name	Type	Description
messageType	String	type of the message for which to remove the handler