Overview

Server functions

essential.addPlayer
essential.createPlayerInfo
essential.disconnectedPlayer
essential.getGameStateData
essential.getScore
essential.handlePacket
essential.handleState
essential.playerAddedToIdleGame
essential.reconnectedPlayer
essential.removePlayer
essential.setupGameRoom
essential.storeHighScore
essential.winnerResult

helper.bootPlayer
helper.calcScoreFromTime
helper.getAllPlayerInfos
helper.getAllPlayerNames
helper.getCurrentTime
helper.getPlayerInfo
helper.getPlayerPosition
helper.getSpecialStat
helper.getSquizQuestion
helper.getStat
helper.numberOfPlayersInGame
helper.postNewState
helper.postPacketToAll
helper.postPacketToPlayer
helper.postPacketToRest
helper.removeCheater
helper.setLobbyStatus
helper.setPlayerInfo
helper.storeStat
helper.trace

Client methods

chat.addText
chat.connectToLobby
chat.connectToPlayerComponent

lobby.addEventListener
lobby.exitToLobby
lobby.getInviteAddress
lobby.getSettings
lobby.sendPacket
lobby.setGameName
lobby.setLocal
lobby.updateSettings

player.clearPlayerInfo
player.updatePlayerInfo

lobby.updateSettings

Prototype

public function updateSettings(settings)

Input parameters

settings - the new settings to store on the server for this player

Return value

null

Description

Updates the settings on the server for the player. For most games there is no need to update game settings, as this is handled automatically by the lobby component. You will need to pass this method a valid settings object and the easiest way to do so is to first retrieve a settings object using getSettings, change it, then store it using the updateSettings method.

Example code

var settings:Object = lobby.getSettings();
settings.sounds = true;
lobby.updateSettings(settings);