Package | com.whirled.game.loopback |
Class | public class LoopbackGameControl |
Inheritance | LoopbackGameControl ![]() ![]() ![]() |
Property | Defined by | ||
---|---|---|---|
_awardedTrophies : Set | LoopbackGameControl | ||
_bags : Map
[static]
| LoopbackGameControl | ||
_curTransaction : Array | LoopbackGameControl | ||
_disp : DisplayObject | LoopbackGameControl | ||
_gameData : Object | LoopbackGameControl | ||
_gameStarted : Boolean [static]
| LoopbackGameControl | ||
_isPartyGame : Boolean [static]
| LoopbackGameControl | ||
isPlayer : Boolean [read-only]
| LoopbackGameControl | ||
isServer : Boolean [read-only]
| LoopbackGameControl | ||
_keyDispatcher : Function The function on the GameControl which we can use to directly dispatch events to the
user's game.
| LoopbackGameControl | ||
log : Log | LoopbackGameControl | ||
otherLoopback : LoopbackGameControl
[read-only]
| LoopbackGameControl | ||
_playerId : int [static]
| LoopbackGameControl | ||
_playerLoopback : LoopbackGameControl
[static]
| LoopbackGameControl | ||
_roundId : int [static]
| LoopbackGameControl | ||
_roundStarted : Boolean = true [static]
| LoopbackGameControl | ||
_serverAgentId : int [static]
| LoopbackGameControl | ||
_serverLoopback : LoopbackGameControl
[static]
| LoopbackGameControl | ||
_tickers : Map
[static]
| LoopbackGameControl | ||
_transactionCount : int | LoopbackGameControl | ||
_turnHolderId : int [static]
| LoopbackGameControl | ||
_userCookies : Map | LoopbackGameControl | ||
_userFuncs : Object | LoopbackGameControl | ||
_whirledCtrl : GameControl
[static]
| LoopbackGameControl |
Method | Defined by | ||
---|---|---|---|
LoopbackGameControl(disp:DisplayObject, isServer:Boolean, isPartyGame:Boolean, autoReady:Boolean = true, completelyOffline:Boolean = false)
| LoopbackGameControl | ||
![]() |
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener.
| AbstractControl | |
![]() |
doBatch(fn:Function, ... args):void
Execute the specified function as a batch of commands that will be sent to the server
together.
| AbstractControl | |
isConnected():Boolean
| LoopbackGameControl | ||
![]() |
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Unregisters an event listener.
| AbstractControl |
Method | Defined by | ||
---|---|---|---|
alterKeyEvents_v1(keyEventType:String, add:Boolean):void
| LoopbackGameControl | ||
applyPropertySet(props:Object, propName:String, value:Object, key:Object, isArray:Boolean):Object
[static]
Enacts a property change.
| LoopbackGameControl | ||
awardPrize_v1(ident:String, playerId:int):void
| LoopbackGameControl | ||
awardTrophy_v1(ident:String, playerId:int):Boolean
| LoopbackGameControl | ||
callUserCode(name:String, ... args):*
| LoopbackGameControl | ||
changeGameState(newState:Boolean, loopbackPlayerIsWinner:Boolean = false, payoutType:int = 0, gameMode:int = 0):void
| LoopbackGameControl | ||
changeRoundState(newState:Boolean):Boolean
| LoopbackGameControl | ||
checkDictionaryWord_v2(locale:String, dictionary:String, word:String, callback:Function):void
| LoopbackGameControl | ||
clearScores_v1(clearValue:Object = null, sortValuesToo:Boolean = false):void
| LoopbackGameControl | ||
commitTransaction_v1():void
Commits a transaction started with
startTransaction_v1 . | LoopbackGameControl | ||
destroyBag(name:String):void
| LoopbackGameControl | ||
endGame_v2(... winnerIds):void
| LoopbackGameControl | ||
endGameWithScores_v1(playerIds:Array, scores:Array, payoutType:int, gameMode:int = 0):void
| LoopbackGameControl | ||
endGameWithWinners_v1(winnerIds:Array, loserIds:Array, payoutType:int):void
| LoopbackGameControl | ||
endRound_v1(nextRoundDelay:int):void
| LoopbackGameControl | ||
filter_v1(text:String):String
| LoopbackGameControl | ||
focusContainer_v1():void
| LoopbackGameControl | ||
gameStateChanged():void
| LoopbackGameControl | ||
getBag(name:String, create:Boolean):Array
| LoopbackGameControl | ||
getControllerId_v1():int
| LoopbackGameControl | ||
getCookie_v1(callback:Function, occupantId:int):void
| LoopbackGameControl | ||
getDictionaryLetterSet_v2(locale:String, dictionary:String, count:int, callback:Function):void
| LoopbackGameControl | ||
getDictionaryWords_v1(locale:String, dictionary:String, count:int, callback:Function):void
| LoopbackGameControl | ||
getFromCollection_v2(collName:String, count:int, msgOrPropName:String, playerId:int, consume:Boolean, callback:Function):void
Helper method for pickFromCollection and dealFromCollection.
| LoopbackGameControl | ||
getHeadShot_v2():DisplayObject
| LoopbackGameControl | ||
getInviterMemberId_v1():int
| LoopbackGameControl | ||
getInviteToken_v1():String
| LoopbackGameControl | ||
getItemPacks_v1(filter:Function = null):Array
| LoopbackGameControl | ||
getLevelPacks_v2(filter:Function = null):Array
| LoopbackGameControl | ||
getMyId_v1():int
| LoopbackGameControl | ||
getMyPosition_v1():int
| LoopbackGameControl | ||
getOccupantName_v1(playerId:int):String
| LoopbackGameControl | ||
getOccupants_v1():Array
| LoopbackGameControl | ||
getPlayerItemPacks_v1(playerId:int):Array
| LoopbackGameControl | ||
getPlayerLevelPacks_v1(playerId:int):Array
| LoopbackGameControl | ||
getPlayerPosition_v1(playerId:int):int
| LoopbackGameControl | ||
getPlayers_v1():Array
| LoopbackGameControl | ||
getRound_v1():int
| LoopbackGameControl | ||
getSize_v1():Point
Get the size of the game area.
| LoopbackGameControl | ||
getTurnHolder_v1():int
| LoopbackGameControl | ||
getUserCookie_v2(playerId:int, callback:Function):void
| LoopbackGameControl | ||
handleKeyEvent(evt:Event):void
Handle key events on our container and pass them into the game.
| LoopbackGameControl | ||
handleUnload(event:Event):void
Handle any shutdown required.
| LoopbackGameControl | ||
handleUserCodeConnect(evt:Event):void
| LoopbackGameControl | ||
holdsTrophy_v1(ident:String, playerId:int):Boolean
| LoopbackGameControl | ||
isEmbedded_v1():Boolean
| LoopbackGameControl | ||
isInPlay_v1():Boolean
| LoopbackGameControl | ||
isMyTurn_v1():Boolean
| LoopbackGameControl | ||
loadItemPackData_v1(ident:String, onLoaded:Function, onFailure:Function):void
| LoopbackGameControl | ||
loadLevelPackData_v1(ident:String, onLoaded:Function, onFailure:Function):void
| LoopbackGameControl | ||
localChat_v1(msg:String):void
| LoopbackGameControl | ||
mergeCollection_v1(srcColl:String, intoColl:String):void
| LoopbackGameControl | ||
playerReady_v1():void
Called by the client code when it is ready for the game to be started (if called before the
game ever starts) or rematched (if called after the game has ended).
| LoopbackGameControl | ||
populateCollection_v1(collName:String, values:Array, clearExisting:Boolean):void
Helper method for setCollection and addToCollection.
| LoopbackGameControl | ||
populateProperties(o:Object):void
| LoopbackGameControl | ||
receiveChat(senderId:int, msg:String):void
| LoopbackGameControl | ||
receiveMessage(messageName:String, value:Object, fromId:int, toId:int):void
[static]
| LoopbackGameControl | ||
receiveMessageLocally(messageName:String, value:Object, fromId:int):void
| LoopbackGameControl | ||
receiveUserCookie(occupantId:int, cookieBytes:ByteArray):void
| LoopbackGameControl | ||
redispatch(eventType:String, source:EventDispatcher, target:EventDispatcher):void
| LoopbackGameControl | ||
reportGameError(msg:String, err:Error = null):void
Log the specified game error message.
| LoopbackGameControl | ||
requestConsumeItemPack_v1(ident:String, msg:String):Boolean
| LoopbackGameControl | ||
restartGameIn_v1(seconds:int):void
| LoopbackGameControl | ||
roundStateChanged():void
| LoopbackGameControl | ||
routeFunction(o:Object, name:String, offlineImpl:Function, rerouteToWhirled:Boolean):void
| LoopbackGameControl | ||
runOnce(delayMs:Number, callback:Function):void
| LoopbackGameControl | ||
sendChat_v1(msg:String):void
| LoopbackGameControl | ||
sendMessage_v2(messageName:String, value:Object, playerId:int):void
| LoopbackGameControl | ||
setCookie_v1(cookie:Object, occupantId:int):Boolean
| LoopbackGameControl | ||
setFrameRate_v1(frameRate:Number, quality:String = null):void
| LoopbackGameControl | ||
setMappedScores_v1(scores:Object):void
| LoopbackGameControl | ||
setOccupantsLabel_v1(label:String):void
| LoopbackGameControl | ||
setPlayerScores_v1(scores:Array, sortValues:Array = null):void
| LoopbackGameControl | ||
setProperty_v2(propName:String, value:Object, key:Object, isArray:Boolean, immediate:Boolean):void
Sets a property.
| LoopbackGameControl | ||
setShowReplay_v1(show:Boolean):void
| LoopbackGameControl | ||
setStageQuality_v1(quality:String):void
| LoopbackGameControl | ||
setTicker_v1(tickerName:String, msOfDelay:int):void
| LoopbackGameControl | ||
setUserCodeProperties(o:Object):void
| LoopbackGameControl | ||
setUserCookie_v1(cookie:Object, playerId:int):Boolean
| LoopbackGameControl | ||
showAllGames_v1():void
| LoopbackGameControl | ||
showGameLobby_v1(multiplayer:Boolean):void
| LoopbackGameControl | ||
showGameShop_v1(itemType:String, catalogId:int = 0):void
| LoopbackGameControl | ||
showInvitePage_v1(defmsg:String, token:String = ""):void
| LoopbackGameControl | ||
showTrophies_v1():void
| LoopbackGameControl | ||
startNextTurn_v1(nextPlayerId:int):void
| LoopbackGameControl | ||
startTransaction_v1():void
Starts a transaction that will group all game state changes into a single message.
| LoopbackGameControl | ||
stopAllTickers():void
| LoopbackGameControl | ||
stopTicker(tickerName:String):void
| LoopbackGameControl | ||
testAndSetProperty_v1(propName:String, value:Object, testValue:Object, index:int = -1):void
Test and set a property.
| LoopbackGameControl | ||
tickerFired(ticker:Ticker):void
| LoopbackGameControl | ||
turnChanged():void
| LoopbackGameControl | ||
updateProp(propName:String, encodedVal:Object, ikey:Integer, isArray:Boolean):void
[static]
| LoopbackGameControl | ||
updatePropLocally(propName:String, encodedVal:Object, ikey:Integer, isArray:Boolean):void
| LoopbackGameControl | ||
validateChat(msg:String):void
Verify that the supplied chat message is valid.
| LoopbackGameControl | ||
validateName(name:String):void
Verify that the specified name is valid.
| LoopbackGameControl | ||
validatePropertyChange(propName:String, value:Object, array:Boolean, index:int):void
Verify that the property name / value are valid.
| LoopbackGameControl | ||
validateValue(value:Object):void
Verify that the value is legal to be streamed to other clients.
| LoopbackGameControl |
Constant | Defined by | ||
---|---|---|---|
CURRENT_USER : int = 0 [static]
| LoopbackGameControl | ||
DICTIONARY_LETTERS : Array [static]
| LoopbackGameControl | ||
DICTIONARY_WORDS : Array [static]
| LoopbackGameControl | ||
MAX_TICKERS : int = 3 [static]
| LoopbackGameControl | ||
MAX_USER_COOKIE : int = 4096 [static]
| LoopbackGameControl | ||
MIN_TICKER_INTERVAL : int = 50 [static]
| LoopbackGameControl | ||
SERVER_AGENT_ID : int = -2.147483648E9 [static]
| LoopbackGameControl | ||
TO_ALL : int = 0 [static]
| LoopbackGameControl |
_awardedTrophies | property |
protected var _awardedTrophies:Set
_bags | property |
protected static var _bags:Map
_curTransaction | property |
protected var _curTransaction:Array
_disp | property |
protected var _disp:DisplayObject
_gameData | property |
protected var _gameData:Object
_gameStarted | property |
protected static var _gameStarted:Boolean
_isPartyGame | property |
protected static var _isPartyGame:Boolean
isPlayer | property |
isPlayer:Boolean
[read-only]Implementation
protected function get isPlayer():Boolean
isServer | property |
isServer:Boolean
[read-only]Implementation
protected function get isServer():Boolean
_keyDispatcher | property |
protected var _keyDispatcher:Function
The function on the GameControl which we can use to directly dispatch events to the user's game.
log | property |
protected var log:Log
otherLoopback | property |
otherLoopback:LoopbackGameControl
[read-only]Implementation
protected function get otherLoopback():LoopbackGameControl
_playerId | property |
protected static var _playerId:int
_playerLoopback | property |
protected static var _playerLoopback:LoopbackGameControl
_roundId | property |
protected static var _roundId:int
_roundStarted | property |
protected static var _roundStarted:Boolean = true
_serverAgentId | property |
protected static var _serverAgentId:int
_serverLoopback | property |
protected static var _serverLoopback:LoopbackGameControl
_tickers | property |
protected static var _tickers:Map
_transactionCount | property |
protected var _transactionCount:int
_turnHolderId | property |
protected static var _turnHolderId:int
_userCookies | property |
protected var _userCookies:Map
_userFuncs | property |
protected var _userFuncs:Object
_whirledCtrl | property |
protected static var _whirledCtrl:GameControl
LoopbackGameControl | () | constructor |
public function LoopbackGameControl(disp:DisplayObject, isServer:Boolean, isPartyGame:Boolean, autoReady:Boolean = true, completelyOffline:Boolean = false)
Parameters
disp:DisplayObject |
|
isServer:Boolean |
|
isPartyGame:Boolean |
|
autoReady:Boolean (default = true )
|
|
completelyOffline:Boolean (default = false )
|
alterKeyEvents_v1 | () | method |
protected function alterKeyEvents_v1(keyEventType:String, add:Boolean):void
Parameters
keyEventType:String |
|
add:Boolean |
applyPropertySet | () | method |
protected static function applyPropertySet(props:Object, propName:String, value:Object, key:Object, isArray:Boolean):Object
Enacts a property change.
Parametersprops:Object |
|
propName:String |
|
value:Object |
|
key:Object |
|
isArray:Boolean |
Object — the old value
|
— if the key is out of range (arrays only)
|
awardPrize_v1 | () | method |
protected function awardPrize_v1(ident:String, playerId:int):void
Parameters
ident:String |
|
playerId:int |
awardTrophy_v1 | () | method |
protected function awardTrophy_v1(ident:String, playerId:int):Boolean
Parameters
ident:String |
|
playerId:int |
Boolean |
callUserCode | () | method |
protected function callUserCode(name:String, ... args):*
Parameters
name:String |
|
... args |
* |
changeGameState | () | method |
protected function changeGameState(newState:Boolean, loopbackPlayerIsWinner:Boolean = false, payoutType:int = 0, gameMode:int = 0):void
Parameters
newState:Boolean |
|
loopbackPlayerIsWinner:Boolean (default = false )
|
|
payoutType:int (default = 0 )
|
|
gameMode:int (default = 0 )
|
changeRoundState | () | method |
protected function changeRoundState(newState:Boolean):Boolean
Parameters
newState:Boolean |
Boolean |
checkDictionaryWord_v2 | () | method |
protected function checkDictionaryWord_v2(locale:String, dictionary:String, word:String, callback:Function):void
Parameters
locale:String |
|
dictionary:String |
|
word:String |
|
callback:Function |
clearScores_v1 | () | method |
protected function clearScores_v1(clearValue:Object = null, sortValuesToo:Boolean = false):void
Parameters
clearValue:Object (default = null )
|
|
sortValuesToo:Boolean (default = false )
|
commitTransaction_v1 | () | method |
protected function commitTransaction_v1():void
Commits a transaction started with startTransaction_v1
.
destroyBag | () | method |
protected function destroyBag(name:String):void
Parameters
name:String |
endGame_v2 | () | method |
protected function endGame_v2(... winnerIds):void
Parameters
... winnerIds |
endGameWithScores_v1 | () | method |
protected function endGameWithScores_v1(playerIds:Array, scores:Array, payoutType:int, gameMode:int = 0):void
Parameters
playerIds:Array |
|
scores:Array |
|
payoutType:int |
|
gameMode:int (default = 0 )
|
endGameWithWinners_v1 | () | method |
protected function endGameWithWinners_v1(winnerIds:Array, loserIds:Array, payoutType:int):void
Parameters
winnerIds:Array |
|
loserIds:Array |
|
payoutType:int |
endRound_v1 | () | method |
protected function endRound_v1(nextRoundDelay:int):void
Parameters
nextRoundDelay:int |
filter_v1 | () | method |
protected function filter_v1(text:String):String
Parameters
text:String |
String |
focusContainer_v1 | () | method |
protected function focusContainer_v1():void
gameStateChanged | () | method |
protected function gameStateChanged():void
getBag | () | method |
protected function getBag(name:String, create:Boolean):Array
Parameters
name:String |
|
create:Boolean |
Array |
getControllerId_v1 | () | method |
protected function getControllerId_v1():int
Returns
int |
getCookie_v1 | () | method |
protected function getCookie_v1(callback:Function, occupantId:int):void
Parameters
callback:Function |
|
occupantId:int |
getDictionaryLetterSet_v2 | () | method |
protected function getDictionaryLetterSet_v2(locale:String, dictionary:String, count:int, callback:Function):void
Parameters
locale:String |
|
dictionary:String |
|
count:int |
|
callback:Function |
getDictionaryWords_v1 | () | method |
protected function getDictionaryWords_v1(locale:String, dictionary:String, count:int, callback:Function):void
Parameters
locale:String |
|
dictionary:String |
|
count:int |
|
callback:Function |
getFromCollection_v2 | () | method |
protected function getFromCollection_v2(collName:String, count:int, msgOrPropName:String, playerId:int, consume:Boolean, callback:Function):void
Helper method for pickFromCollection and dealFromCollection.
ParameterscollName:String |
|
count:int |
|
msgOrPropName:String |
|
playerId:int |
|
consume:Boolean |
|
callback:Function |
getHeadShot_v2 | () | method |
protected function getHeadShot_v2():DisplayObject
Returns
DisplayObject |
getInviterMemberId_v1 | () | method |
protected function getInviterMemberId_v1():int
Returns
int |
getInviteToken_v1 | () | method |
protected function getInviteToken_v1():String
Returns
String |
getItemPacks_v1 | () | method |
protected function getItemPacks_v1(filter:Function = null):Array
Parameters
filter:Function (default = null )
|
Array |
getLevelPacks_v2 | () | method |
protected function getLevelPacks_v2(filter:Function = null):Array
Parameters
filter:Function (default = null )
|
Array |
getMyId_v1 | () | method |
protected function getMyId_v1():int
Returns
int |
getMyPosition_v1 | () | method |
protected function getMyPosition_v1():int
Returns
int |
getOccupantName_v1 | () | method |
protected function getOccupantName_v1(playerId:int):String
Parameters
playerId:int |
String |
getOccupants_v1 | () | method |
protected function getOccupants_v1():Array
Returns
Array |
getPlayerItemPacks_v1 | () | method |
protected function getPlayerItemPacks_v1(playerId:int):Array
Parameters
playerId:int |
Array |
getPlayerLevelPacks_v1 | () | method |
protected function getPlayerLevelPacks_v1(playerId:int):Array
Parameters
playerId:int |
Array |
getPlayerPosition_v1 | () | method |
protected function getPlayerPosition_v1(playerId:int):int
Parameters
playerId:int |
int |
getPlayers_v1 | () | method |
protected function getPlayers_v1():Array
Returns
Array |
getRound_v1 | () | method |
protected function getRound_v1():int
Returns
int |
getSize_v1 | () | method |
protected function getSize_v1():Point
Get the size of the game area.
ReturnsPoint |
getTurnHolder_v1 | () | method |
protected function getTurnHolder_v1():int
Returns
int |
getUserCookie_v2 | () | method |
protected function getUserCookie_v2(playerId:int, callback:Function):void
Parameters
playerId:int |
|
callback:Function |
handleKeyEvent | () | method |
protected function handleKeyEvent(evt:Event):void
Handle key events on our container and pass them into the game.
Parametersevt:Event |
handleUnload | () | method |
protected override function handleUnload(event:Event):void
Handle any shutdown required.
Parametersevent:Event |
handleUserCodeConnect | () | method |
protected function handleUserCodeConnect(evt:Event):void
Parameters
evt:Event |
holdsTrophy_v1 | () | method |
protected function holdsTrophy_v1(ident:String, playerId:int):Boolean
Parameters
ident:String |
|
playerId:int |
Boolean |
isConnected | () | method |
public override function isConnected():Boolean
Returns
Boolean |
isEmbedded_v1 | () | method |
protected function isEmbedded_v1():Boolean
Returns
Boolean |
isInPlay_v1 | () | method |
protected function isInPlay_v1():Boolean
Returns
Boolean |
isMyTurn_v1 | () | method |
protected function isMyTurn_v1():Boolean
Returns
Boolean |
loadItemPackData_v1 | () | method |
protected function loadItemPackData_v1(ident:String, onLoaded:Function, onFailure:Function):void
Parameters
ident:String |
|
onLoaded:Function |
|
onFailure:Function |
loadLevelPackData_v1 | () | method |
protected function loadLevelPackData_v1(ident:String, onLoaded:Function, onFailure:Function):void
Parameters
ident:String |
|
onLoaded:Function |
|
onFailure:Function |
localChat_v1 | () | method |
protected function localChat_v1(msg:String):void
Parameters
msg:String |
mergeCollection_v1 | () | method |
protected function mergeCollection_v1(srcColl:String, intoColl:String):void
Parameters
srcColl:String |
|
intoColl:String |
playerReady_v1 | () | method |
protected function playerReady_v1():void
Called by the client code when it is ready for the game to be started (if called before the game ever starts) or rematched (if called after the game has ended).
populateCollection_v1 | () | method |
protected function populateCollection_v1(collName:String, values:Array, clearExisting:Boolean):void
Helper method for setCollection and addToCollection.
ParameterscollName:String |
|
values:Array |
|
clearExisting:Boolean |
populateProperties | () | method |
protected function populateProperties(o:Object):void
Parameters
o:Object |
receiveChat | () | method |
protected function receiveChat(senderId:int, msg:String):void
Parameters
senderId:int |
|
msg:String |
receiveMessage | () | method |
protected static function receiveMessage(messageName:String, value:Object, fromId:int, toId:int):void
Parameters
messageName:String |
|
value:Object |
|
fromId:int |
|
toId:int |
receiveMessageLocally | () | method |
protected function receiveMessageLocally(messageName:String, value:Object, fromId:int):void
Parameters
messageName:String |
|
value:Object |
|
fromId:int |
receiveUserCookie | () | method |
protected function receiveUserCookie(occupantId:int, cookieBytes:ByteArray):void
Parameters
occupantId:int |
|
cookieBytes:ByteArray |
redispatch | () | method |
protected function redispatch(eventType:String, source:EventDispatcher, target:EventDispatcher):void
Parameters
eventType:String |
|
source:EventDispatcher |
|
target:EventDispatcher |
reportGameError | () | method |
protected function reportGameError(msg:String, err:Error = null):void
Log the specified game error message.
Parametersmsg:String |
|
err:Error (default = null )
|
requestConsumeItemPack_v1 | () | method |
protected function requestConsumeItemPack_v1(ident:String, msg:String):Boolean
Parameters
ident:String |
|
msg:String |
Boolean |
restartGameIn_v1 | () | method |
protected function restartGameIn_v1(seconds:int):void
Parameters
seconds:int |
roundStateChanged | () | method |
protected function roundStateChanged():void
routeFunction | () | method |
protected function routeFunction(o:Object, name:String, offlineImpl:Function, rerouteToWhirled:Boolean):void
Parameters
o:Object |
|
name:String |
|
offlineImpl:Function |
|
rerouteToWhirled:Boolean |
runOnce | () | method |
protected function runOnce(delayMs:Number, callback:Function):void
Parameters
delayMs:Number |
|
callback:Function |
sendChat_v1 | () | method |
protected function sendChat_v1(msg:String):void
Parameters
msg:String |
sendMessage_v2 | () | method |
protected function sendMessage_v2(messageName:String, value:Object, playerId:int):void
Parameters
messageName:String |
|
value:Object |
|
playerId:int |
setCookie_v1 | () | method |
protected function setCookie_v1(cookie:Object, occupantId:int):Boolean
Parameters
cookie:Object |
|
occupantId:int |
Boolean |
setFrameRate_v1 | () | method |
protected function setFrameRate_v1(frameRate:Number, quality:String = null):void
Parameters
frameRate:Number |
|
quality:String (default = null )
|
setMappedScores_v1 | () | method |
protected function setMappedScores_v1(scores:Object):void
Parameters
scores:Object |
setOccupantsLabel_v1 | () | method |
protected function setOccupantsLabel_v1(label:String):void
Parameters
label:String |
setPlayerScores_v1 | () | method |
protected function setPlayerScores_v1(scores:Array, sortValues:Array = null):void
Parameters
scores:Array |
|
sortValues:Array (default = null )
|
setProperty_v2 | () | method |
protected function setProperty_v2(propName:String, value:Object, key:Object, isArray:Boolean, immediate:Boolean):void
Sets a property. Note: immediate defaults to true, even though immediate=false is the general case. We are providing some backwards compatibility to old versions of setProperty_v1() that assumed immediate and did not pass a 4th value. All callers should now specify that value explicitly.
ParameterspropName:String |
|
value:Object |
|
key:Object |
|
isArray:Boolean |
|
immediate:Boolean |
setShowReplay_v1 | () | method |
protected function setShowReplay_v1(show:Boolean):void
Parameters
show:Boolean |
setStageQuality_v1 | () | method |
protected function setStageQuality_v1(quality:String):void
Parameters
quality:String |
setTicker_v1 | () | method |
protected function setTicker_v1(tickerName:String, msOfDelay:int):void
Parameters
tickerName:String |
|
msOfDelay:int |
setUserCodeProperties | () | method |
protected function setUserCodeProperties(o:Object):void
Parameters
o:Object |
setUserCookie_v1 | () | method |
protected function setUserCookie_v1(cookie:Object, playerId:int):Boolean
Parameters
cookie:Object |
|
playerId:int |
Boolean |
showAllGames_v1 | () | method |
protected function showAllGames_v1():void
showGameLobby_v1 | () | method |
protected function showGameLobby_v1(multiplayer:Boolean):void
Parameters
multiplayer:Boolean |
showGameShop_v1 | () | method |
protected function showGameShop_v1(itemType:String, catalogId:int = 0):void
Parameters
itemType:String |
|
catalogId:int (default = 0 )
|
showInvitePage_v1 | () | method |
protected function showInvitePage_v1(defmsg:String, token:String = ""):void
Parameters
defmsg:String |
|
token:String (default = " ")
|
showTrophies_v1 | () | method |
protected function showTrophies_v1():void
startNextTurn_v1 | () | method |
protected function startNextTurn_v1(nextPlayerId:int):void
Parameters
nextPlayerId:int |
startTransaction_v1 | () | method |
protected function startTransaction_v1():void
Starts a transaction that will group all game state changes into a single message.
stopAllTickers | () | method |
protected function stopAllTickers():void
stopTicker | () | method |
protected function stopTicker(tickerName:String):void
Parameters
tickerName:String |
testAndSetProperty_v1 | () | method |
protected function testAndSetProperty_v1(propName:String, value:Object, testValue:Object, index:int = -1):void
Test and set a property. Note that the 'index' parameter was deprecated on 2008-02-20. Newer code will only pass in propName, value, testValue. Older code will also pass in the index, but that's ok as long as it's -1.
ParameterspropName:String |
|
value:Object |
|
testValue:Object |
|
index:int (default = -1 )
|
tickerFired | () | method |
protected function tickerFired(ticker:Ticker):void
Parameters
ticker:Ticker |
turnChanged | () | method |
protected function turnChanged():void
updateProp | () | method |
protected static function updateProp(propName:String, encodedVal:Object, ikey:Integer, isArray:Boolean):void
Parameters
propName:String |
|
encodedVal:Object |
|
ikey:Integer |
|
isArray:Boolean |
updatePropLocally | () | method |
protected function updatePropLocally(propName:String, encodedVal:Object, ikey:Integer, isArray:Boolean):void
Parameters
propName:String |
|
encodedVal:Object |
|
ikey:Integer |
|
isArray:Boolean |
validateChat | () | method |
protected function validateChat(msg:String):void
Verify that the supplied chat message is valid.
Parametersmsg:String |
validateName | () | method |
protected function validateName(name:String):void
Verify that the specified name is valid.
Parametersname:String |
validatePropertyChange | () | method |
protected function validatePropertyChange(propName:String, value:Object, array:Boolean, index:int):void
Verify that the property name / value are valid.
ParameterspropName:String |
|
value:Object |
|
array:Boolean |
|
index:int |
validateValue | () | method |
protected function validateValue(value:Object):void
Verify that the value is legal to be streamed to other clients.
Parametersvalue:Object |
CURRENT_USER | constant |
protected static const CURRENT_USER:int = 0
DICTIONARY_LETTERS | constant |
protected static const DICTIONARY_LETTERS:Array
DICTIONARY_WORDS | constant |
protected static const DICTIONARY_WORDS:Array
MAX_TICKERS | constant |
protected static const MAX_TICKERS:int = 3
MAX_USER_COOKIE | constant |
protected static const MAX_USER_COOKIE:int = 4096
MIN_TICKER_INTERVAL | constant |
protected static const MIN_TICKER_INTERVAL:int = 50
SERVER_AGENT_ID | constant |
protected static const SERVER_AGENT_ID:int = -2.147483648E9
TO_ALL | constant |
protected static const TO_ALL:int = 0