lobby.getSettings
Prototype
public function getSettings()
Return value
Returns the current settings object or null if they haven't been retrieved yet
Description
Reads the current settings as returned from the server (or null if they haven't been retrieved yet). The settings are ready to read once the GotSettings event has been triggered.
The settings object contains the following fields:
settings.sounds - boolean value
settings.music - boolean value
settings.buddies - boolean, true if buddies can join private games without a password
settings.quick - boolean, the user wants to bypass the lobby and head straight to the game
settings.localsetting - array of booleans with settings specific to the game
For more details about using the settings, please see the Programmers Guide
Example code
var settings:Object = lobby.getSettings();
if (settings.sounds)
{
playSound();
}