File: Games\Plateau\Game.js

GamesByEmail
Class PlateauGame

Object
  
 
 
GamesByEmail.Game
 
 
GamesByEmail.PlateauGame

All Implemented Interfaces:

Class, Elemental, Resourceful, Server


GamesByEmail.PlateauGame

extends Game

Constructor Summary
GamesByEmail.PlateauGame()

Field Summary
 animationNumSteps
 animationStartInterval
 animationStepInterval
static ObjectresourcePack
Resources for most of the game. Override to add resources specific to game.

Fields inherited from GamesByEmail.Game
board, canPie, constrainer, font, id, info, isLog, lastMove, logSettings, maxMoveNumber, message, move, notify, onLeftMouseDown, onLeftMouseUp, onMiddleMouseDown, onMiddleMouseUp, onMouseDown, onMouseMove, onMouseOut, onMouseOver, onMouseUp, onRightMouseDown, onRightMouseUp, pieces, previewing, rotation, status, teams, territories, testing, title, type, verbose

Fields inherited from Foundation.Elemental
$Foundation_$registry_index

Method Summary
 addToCaptured(team, value, toEnd)
 addToReserve(team, value, toEnd)
 addToTrades(team, value)
 animateCapture(captured, boardPoint)
 animationAbort()
 animationAppendImages()
 animationPushCaptures(captured, boardPoint)
 animationRemoveImages()
 animationSetCapturedVisibility(hidden)
 animationSetCapturedVisibilityAtIndex(hidden, index)
 animationStartNext()
 animationStep()
 canMove(team)
 canOnboardAtBoardPoint(boardPoint)
 checkForWin()
 clearMovementAtPoint(boardPoint)
StringcompleteYourTurnHtml(/*String*/ resourceName)
Called when needing the complete-your-turn game prompt HTML (typically a short sentence about the move and a Send This Move button). Override and set mouse events here. Internally uses the "completeYourTurn" resource.
StringcontinueYourTurnHtml(/*String*/ resourceName)
Called when needing the continue-your-turn game prompt HTML (typically a short sentence about the move, no send move button yet). Override and set mouse events here. Internally uses the "continueYourTurn" resource.
 countMoving(leftMoving)
 dispose()
 flipAtBoardPoint(boardPoint)
 flipOnMouseDown(screenPoint)
StringgameOverHtml()
Called when needing the game-over game prompts HTML. Override to set. Internally returns one of the following: theyResignedHtml, youResignedHtml, youTiedHtml, drawAcceptedHtml, youWinHtml or youLoseHtml.
 getCapturedAtIndex(team, index)
 getCapturedList(team)
 getCapturedValue(value)
 getFlippedValue(boardValue)
StringgetGamePromptsHtml()
Called when needing the game prompts HTML. Override to set. Internally clears the mouse events, then returns either spectatingHtml, gameOverHtml, notYourTurnHtml or getTurnHtml.
StringgetHtml()
Gets the HTML of the entire game.
 getIndexOfReserve(team, value)
 getMovementStack(boardPoint, auxMoveData)
 getMovingNumIntermediate(screenPoint, stack)
 getMovingNumTerminal(boardPoint, stackLength)
 getNumCaptured(team)
 getNumReserve(team)
 getNumTrades(team)
 getPiecesTitleHtml(team)
 getProcessedValue(p)
 getPublicValue(value)
 getReserveAtIndex(team, index)
 getReserveList(team)
StringgetTeamTitleHtml(/*Team*/ team, /*Boolean*/ top)
Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.
 getTradeAtIndex(team, index)
 getTradeList(team)
 getTradeValue(trades)
 getTurnOptionsHtml(continuing)
voidinitialize(/*Number*/ numPlayers, /*Number*/ turnTeamIndex)
The first method to be called when a game is created, override to set up teams, players and the game state.
 initiateFlipping()
 initiateMoving()
 initiateOnboarding()
 initiatePerusing(color)
 initiateTrading()
 isBoardPointOnMovementPath(boardPoint)
 isBoardPointOnMovementPath_b(boardPoint)
 isBoardPointOnMovementPath_m(boardPoint)
 isBoardPointOnMovementPath_r(boardPoint)
 isBoardPointOnMovementPath_t(boardPoint)
 isBounceWeaponValue(value)
 isEnigmaValue(value)
 isFlippableValue(value)
 isInitialTurn()
 isIntermediateSpace(boardPoint)
 isPerimeterPoint(boardPoint)
 isPerusePaused(boardPoint)
 isWeaponValue(value)
StringitsYourTurnHtml(/*String*/ resourceName)
Called when needing the it-is-your-turn game prompt HTML (typically a short sentence about the move). Override and set mouse events here. Internally uses the "itIsYourTurnToMove" resource.
 logIconFromName(name)
 logPieceImagesFromIndices(moveIndex, indices)
 logPieceImagesFromValues(values)
 logPointNotation(x, y)
 moveMouseMoved(screenPoint, force)
 moveOnMouseDown(screenPoint)
 moveOnMouseMove(screenPoint)
 moveOnMouseUp(screenPoint)
 movingGetBounceLogData()
 movingGetLogData()
StringnotYourTurnHtml(/*String*/ resourceName)
Called when needing the it-is-not-your-turn game prompt HTML (typically a short sentence with Send Reminder, Refresh Game and Close Window buttons Start Another Game button). Override to set. Internally uses the "notYourTurn" resource.
 onboardFlip(screenPoint)
 onboardMouseDown(event, index)
 onboardMouseMove(screenPoint)
 onboardMouseUp(screenPoint)
 onboardValueAtBoardPoint(value, boardPoint, insertIndex, noUpdate)
 perusePause(boardPoint)
 perusingOnMouseMove(screenPoint)
 perusingOnMouseOut()
 processLogMove0(moveIndex, data, info)
 processLogMove1(moveIndex, data, info)
 processLogMove2(moveIndex, data, info)
 processLogMove3(moveIndex, data, info)
 processLogMove4(moveIndex, data, info)
 processLogMove5(moveIndex, data, info)
 processLogMove6(moveIndex, data, info)
BooleanprocessSecureMove(/*GamesByEmail*/ game)
Gets called when the sending moves, fir processing secure move data on the client. Override to process secure data.
 processText_pieceImages(p1, p2)
 promotionResponse(status)
 promotionSubmit()
 removeFromCaptured(team, value)
 removeFromReserve(team, value)
 removeFromTrades(team, value)
 removeOnboardFromReserve(value)
BooleansendMove(/*Boolean*/ sendNow, /*Player*/ player)
Gets called when the Send Move button is pushed. Override and set the game state, then call Super.sendMove.
 setBottomOnboardAsEnigma(boardPoint)
 setCapturedList(team, values, noSort)
voidsetPerspective(/*Team*/ team)
Called when synchronizing, sets the perspective of the board based on the player. By default sets the rotation property to 0.
 setReserveList(team, values, noSort)
 setTradeList(team, values, noSort)
 sortPieceList(value)
voidsynch()
Called when the game should synchronize with info properties from the server.
voidsynchTeam(/*Team*/ team)
Called to synchronize the team properties with the raw team data. Just the color and title properties are set by default, override to set more.
 titlesSetCapturedVisibility(hidden)
 titlesSetCapturedVisibilityAtIndex(hidden, index)
 tradingAcceptingGetLogEntries()
 tradingAddIndexToTable(index)
 tradingAddPiecesToTable(pieces)
 tradingCalculateTotal(values)
 tradingDecline()
 tradingDeclinedAcknowledged(noUpdate)
 tradingDecliningGetLogEntries()
 tradingGetAskingHtml()
 tradingGetBeginningHtml()
 tradingGetDeclinedHtml()
 tradingGetDecliningHtml()
 tradingGetObligitoryTradesHtml()
 tradingGetPossibilities(pieces)
 tradingGetRespondHtml()
 tradingGetSuggestionHtml(pieces)
 tradingGetTabledPieceHtml(value, addMouseEvent)
 tradingGetTabledPiecesHtml(values, addMouseEvents)
 tradingGetTeamTradingSpaceHtml(team, addMouseEvents)
 tradingIsReadyToSend()
 tradingMaybeShowBox()
 tradingOfferingGetLogEntries()
 tradingOnSendMove()
 tradingOrderPieces(pieces)
 tradingParePossibilities(possibilities, pareType, value)
 tradingPossibiltyToString()
 tradingPushPossibilities(possibilities, pieces, rest, size)
 tradingRemovePiecesFromTable(pieces)
voidundo(/*Boolean*/ skipUpdate)
Undos all moves since the last synch method call. The synch and update methods will be called again.
 undoBeginCommand()
 undoBeginCommand_flip(boardPoint)
 undoBeginCommand_move(boardPoint)
 undoBeginCommand_onboard()
 undoBeginCommand_tradingOffering(boardPoint)
 undoClearRegistry()
 undoCloneArguments(args)
 undoCloneData(data)
 undoCompareArguments(args1, args2)
 undoCompareData(data1, data2)
 undoGetLogEntries()
 undoRegisterCommand()
 undoRegisterCompareLastMove()
 weCapturedAtIndex(index, value)

Methods inherited from GamesByEmail.Game
aboveTeamTitleRowHtml, acceptDeclineDrawHtml, acceptDraw, acceptDrawButtonHtml, addNote, addToPage, appendAdditionalPreferencesHtml, appendBoardHtml, beginTurnHtml, belowTeamTitleRowHtml, boardPointFromScreenPoint, boardPointFromScreenXY, boardPointFromValueIndex, boardValueFromValueColor, cancelGameButtonHtml, cancelGameHtml, checkMove, clearHilites, clearMouseEvents, closeWindowButtonHtml, closeWindowHtml, colorFromBoardValue, colorFromPointBoard, colorFromXYBoard, completeTurnHtml, constrainPoint, constrainRectangle, continueTurnHtml, debug, diceRolls, dieRoll, drawAcceptedHeaderHtml, drawAcceptedHtml, drawDeclinedHeaderHtml, drawDeclinedHtml, drawOfferedHeaderHtml, elementTitleAttributes, findNextPlayer, findPlayer, findWinningTeam, forEachBoardPoint, forEachTeam, gameInProgressHeaderHtml, gameOverHeaderHtml, getActionLinksHtml, getAnchorHtml, getButtonHtml, getCheckboxHtml, getHeaderHtml, getHtmlButtonHtml, getImageSrc, getNewGamePlayerOrder, getNextGamesTitle, getOptionHtml, getPieType, getPieceRect, getPieceSrc, getRadioHtml, getSelectHtml, getSpectatorAnchorHtml, getSpectatorUrl, getTeamAtDistance, getTeamFontColor, getTeamLogFontBgColor, getTeamLogFontColor, getTeamTitleAlignment, getTeamTitlesHtml, getTeamsForTitles, getTextHtml, getTextareaHtml, getTurnHtml, getTurnTeam, getVButtonHtml, handleMoveCollision, hiliteImageHtml, initializeNewGameForm, isBoardPointHidden, isColorAtPoint, isColorAtXY, isMyTurn, isPathClear, isPointBoardClear, isPointOnBoard, isValueColorAtPoint, isValueColorAtXY, isXYBoardClear, isXYOnBoard, maybePie, maybeResign, movePiece, nextTeam, numInPath, numTeamsPlaying, offerDrawCheckBoxHtml, offerDrawHtml, openLogAnchorHtml, openPlayerChatAnchorHtml, openPreferencesAnchorHtml, openRulesAnchorHtml, pie, pieButtonHtml, pieHtml, refreshGame, refreshGameButtonHtml, reportProblemAnchorHtml, resign, resignButtonHtml, resignHtml, resignedHeaderHtml, screenRectFromBoardPoint, screenRectFromBoardXY, sendMoveButtonHtml, sendMoveHtml, sendReminderButtonHtml, setConstrainer, setEnded, setFloatHtml, setInnerHtml, setMouseHtml, setPlayerPrefs, setValueAtPoint, setValueAtXY, showTransactionPrompt, spectatingHtml, startAnotherGameButtonHtml, startAnotherGameHtml, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, turnHeaderHtml, undoButtonHtml, undoMoveHtml, update, updateTeamTitles, valueFromBoardValue, valueFromPointBoard, valueFromXYBoard, valueIndexFromBoardPoint, valueIndexFromBoardXY, wonHeaderHtml, youLoseHtml, youResignedHtml, youTiedHtml, youWinHtml

Methods inherited from Foundation.Class
getTypePath, isInstanceOf

Methods inherited from Foundation.Elemental
attachEvent, detachEvent, elementId, event, getById, getElement, getElementValue, getElements, getFirst, getNext, parseElementId, processHtml, processHtml

Methods inherited from Foundation.Resourceful
resource, resource, resourceUrl, resourceUrl

Methods inherited from Foundation.Server
server, serverSerialized, serverSynchronous

Constructor Detail

PlateauGame

GamesByEmail.PlateauGame()

Field Detail

animationNumSteps

animationNumSteps

animationStartInterval

animationStartInterval

animationStepInterval

animationStepInterval

resourcePack

static Object resourcePack

Resources for most of the game. Override to add resources specific to game.

Overrides:
resourcePack in class Game
See Also:
Foundation.Resourceful.resource

Method Detail

addToCaptured

addToCaptured(team,
              value,
              toEnd)
Parameters:
team - 

value - 

toEnd - 


addToReserve

addToReserve(team,
             value,
             toEnd)
Parameters:
team - 

value - 

toEnd - 


addToTrades

addToTrades(team,
            value)
Parameters:
team - 

value - 


animateCapture

animateCapture(captured,
               boardPoint)
Parameters:
captured - 

boardPoint - 


animationAbort

animationAbort()

animationAppendImages

animationAppendImages()

animationPushCaptures

animationPushCaptures(captured,
                      boardPoint)
Parameters:
captured - 

boardPoint - 


animationRemoveImages

animationRemoveImages()

animationSetCapturedVisibility

animationSetCapturedVisibility(hidden)
Parameters:
hidden - 


animationSetCapturedVisibilityAtIndex

animationSetCapturedVisibilityAtIndex(hidden,
                                      index)
Parameters:
hidden - 

index - 


animationStartNext

animationStartNext()

animationStep

animationStep()

canMove

canMove(team)
Parameters:
team - 


canOnboardAtBoardPoint

canOnboardAtBoardPoint(boardPoint)
Parameters:
boardPoint - 


checkForWin

checkForWin()

clearMovementAtPoint

clearMovementAtPoint(boardPoint)
Parameters:
boardPoint - 


completeYourTurnHtml

String completeYourTurnHtml(/*String*/ resourceName)

Called when needing the complete-your-turn game prompt HTML (typically a short sentence about the move and a Send This Move button). Override and set mouse events here. Internally uses the "completeYourTurn" resource.

Overrides:
completeYourTurnHtml in class Game
Parameters:
resourceName - 
(Optional) A resource name to override the default resource to use.
Returns:
HTML for the game prompts.

continueYourTurnHtml

String continueYourTurnHtml(/*String*/ resourceName)

Called when needing the continue-your-turn game prompt HTML (typically a short sentence about the move, no send move button yet). Override and set mouse events here. Internally uses the "continueYourTurn" resource.

Overrides:
continueYourTurnHtml in class Game
Parameters:
resourceName - 
(Optional) A resource name to override the default resource to use.
Returns:
HTML for the game prompts.

countMoving

countMoving(leftMoving)
Parameters:
leftMoving - 


dispose

dispose()
Overrides:
dispose in class Game

flipAtBoardPoint

flipAtBoardPoint(boardPoint)
Parameters:
boardPoint - 


flipOnMouseDown

flipOnMouseDown(screenPoint)
Parameters:
screenPoint - 


gameOverHtml

String gameOverHtml()

Called when needing the game-over game prompts HTML. Override to set. Internally returns one of the following: theyResignedHtml, youResignedHtml, youTiedHtml, drawAcceptedHtml, youWinHtml or youLoseHtml.

Overrides:
gameOverHtml in class Game
Returns:
HTML for the game prompts.

getCapturedAtIndex

getCapturedAtIndex(team,
                   index)
Parameters:
team - 

index - 


getCapturedList

getCapturedList(team)
Parameters:
team - 


getCapturedValue

getCapturedValue(value)
Parameters:
value - 


getFlippedValue

getFlippedValue(boardValue)
Parameters:
boardValue - 


getGamePromptsHtml

String getGamePromptsHtml()

Called when needing the game prompts HTML. Override to set. Internally clears the mouse events, then returns either spectatingHtml, gameOverHtml, notYourTurnHtml or getTurnHtml.

Overrides:
getGamePromptsHtml in class Game
Returns:
HTML for the game prompts.

getHtml

String getHtml()

Gets the HTML of the entire game.

Overrides:
getHtml in class Game
Returns:
The game's HTML.

getIndexOfReserve

getIndexOfReserve(team,
                  value)
Parameters:
team - 

value - 


getMovementStack

getMovementStack(boardPoint,
                 auxMoveData)
Parameters:
boardPoint - 

auxMoveData - 


getMovingNumIntermediate

getMovingNumIntermediate(screenPoint,
                         stack)
Parameters:
screenPoint - 

stack - 


getMovingNumTerminal

getMovingNumTerminal(boardPoint,
                     stackLength)
Parameters:
boardPoint - 

stackLength - 


getNumCaptured

getNumCaptured(team)
Parameters:
team - 


getNumReserve

getNumReserve(team)
Parameters:
team - 


getNumTrades

getNumTrades(team)
Parameters:
team - 


getPiecesTitleHtml

getPiecesTitleHtml(team)
Parameters:
team - 


getProcessedValue

getProcessedValue(p)
Parameters:
p - 


getPublicValue

getPublicValue(value)
Parameters:
value - 


getReserveAtIndex

getReserveAtIndex(team,
                  index)
Parameters:
team - 

index - 


getReserveList

getReserveList(team)
Parameters:
team - 


getTeamTitleHtml

String getTeamTitleHtml(/*Team*/ team,
                        /*Boolean*/ top)

Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.

Overrides:
getTeamTitleHtml in class Game
Parameters:
team - 
The team to get the color for.
top - 
Whether this team's title will be displayed above the board or below.
Returns:
The log background color.

getTradeAtIndex

getTradeAtIndex(team,
                index)
Parameters:
team - 

index - 


getTradeList

getTradeList(team)
Parameters:
team - 


getTradeValue

getTradeValue(trades)
Parameters:
trades - 


getTurnOptionsHtml

getTurnOptionsHtml(continuing)
Parameters:
continuing - 


initialize

void initialize(/*Number*/ numPlayers,
                /*Number*/ turnTeamIndex)

The first method to be called when a game is created, override to set up teams, players and the game state.

Overrides:
initialize in class Game
Parameters:
numPlayers - 
The number of players from the game form.
turnTeamIndex - 
The index of the team to set the initial turn. Call the Super with -1 to set all teams turn.

Example:

// Override initialize
   initialize:function(numPlayers,turnTeamIndex)
   {
      // Call the Super.initialize to add default teams.
      Super.initialize(numPlayers,turnTeamIndex);
 
      // Initialize the board state.
      this.info["board"]="rnbqkbnrpppppppp                                PPPPPPPPRNBQKBNR";
      var team=this.teams[0];
      team.info["i_ep"]=-1;
      team.info["b_cs"]=true;
      team.info["b_cl"]=true;
      team=this.teams[1];
      team.info["i_ep"]=-1;
      team.info["b_cs"]=true;
      team.info["b_cl"]=true;
      
      // Log the start of game.
      this.move.log=this.logEntry(44);
   }

initiateFlipping

initiateFlipping()

initiateMoving

initiateMoving()

initiateOnboarding

initiateOnboarding()

initiatePerusing

initiatePerusing(color)
Parameters:
color - 


initiateTrading

initiateTrading()

isBoardPointOnMovementPath

isBoardPointOnMovementPath(boardPoint)
Parameters:
boardPoint - 


isBoardPointOnMovementPath_b

isBoardPointOnMovementPath_b(boardPoint)
Parameters:
boardPoint - 


isBoardPointOnMovementPath_m

isBoardPointOnMovementPath_m(boardPoint)
Parameters:
boardPoint - 


isBoardPointOnMovementPath_r

isBoardPointOnMovementPath_r(boardPoint)
Parameters:
boardPoint - 


isBoardPointOnMovementPath_t

isBoardPointOnMovementPath_t(boardPoint)
Parameters:
boardPoint - 


isBounceWeaponValue

isBounceWeaponValue(value)
Parameters:
value - 


isEnigmaValue

isEnigmaValue(value)
Parameters:
value - 


isFlippableValue

isFlippableValue(value)
Parameters:
value - 


isInitialTurn

isInitialTurn()

isIntermediateSpace

isIntermediateSpace(boardPoint)
Parameters:
boardPoint - 


isPerimeterPoint

isPerimeterPoint(boardPoint)
Parameters:
boardPoint - 


isPerusePaused

isPerusePaused(boardPoint)
Parameters:
boardPoint - 


isWeaponValue

isWeaponValue(value)
Parameters:
value - 


itsYourTurnHtml

String itsYourTurnHtml(/*String*/ resourceName)

Called when needing the it-is-your-turn game prompt HTML (typically a short sentence about the move). Override and set mouse events here. Internally uses the "itIsYourTurnToMove" resource.

Overrides:
itsYourTurnHtml in class Game
Parameters:
resourceName - 
(Optional) A resource name to override the default resource to use.
Returns:
HTML for the game prompts.

logIconFromName

logIconFromName(name)
Parameters:
name - 


logPieceImagesFromIndices

logPieceImagesFromIndices(moveIndex,
                          indices)
Parameters:
moveIndex - 

indices - 


logPieceImagesFromValues

logPieceImagesFromValues(values)
Parameters:
values - 


logPointNotation

logPointNotation(x,
                 y)
Parameters:
x - 

y - 


moveMouseMoved

moveMouseMoved(screenPoint,
               force)
Parameters:
screenPoint - 

force - 


moveOnMouseDown

moveOnMouseDown(screenPoint)
Parameters:
screenPoint - 


moveOnMouseMove

moveOnMouseMove(screenPoint)
Parameters:
screenPoint - 


moveOnMouseUp

moveOnMouseUp(screenPoint)
Parameters:
screenPoint - 


movingGetBounceLogData

movingGetBounceLogData()

movingGetLogData

movingGetLogData()

notYourTurnHtml

String notYourTurnHtml(/*String*/ resourceName)

Called when needing the it-is-not-your-turn game prompt HTML (typically a short sentence with Send Reminder, Refresh Game and Close Window buttons Start Another Game button). Override to set. Internally uses the "notYourTurn" resource.

Overrides:
notYourTurnHtml in class Game
Parameters:
resourceName - 
(Optional) A resource name to override the default resource to use.
Returns:
HTML for the game prompts.

onboardFlip

onboardFlip(screenPoint)
Parameters:
screenPoint - 


onboardMouseDown

onboardMouseDown(event,
                 index)
Parameters:
event - 

index - 


onboardMouseMove

onboardMouseMove(screenPoint)
Parameters:
screenPoint - 


onboardMouseUp

onboardMouseUp(screenPoint)
Parameters:
screenPoint - 


onboardValueAtBoardPoint

onboardValueAtBoardPoint(value,
                         boardPoint,
                         insertIndex,
                         noUpdate)
Parameters:
value - 

boardPoint - 

insertIndex - 

noUpdate - 


perusePause

perusePause(boardPoint)
Parameters:
boardPoint - 


perusingOnMouseMove

perusingOnMouseMove(screenPoint)
Parameters:
screenPoint - 


perusingOnMouseOut

perusingOnMouseOut()

processLogMove0

processLogMove0(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove1

processLogMove1(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove2

processLogMove2(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove3

processLogMove3(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove4

processLogMove4(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove5

processLogMove5(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove6

processLogMove6(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processSecureMove

Boolean processSecureMove(/*GamesByEmail*/ game)

Gets called when the sending moves, fir processing secure move data on the client. Override to process secure data.

Overrides:
processSecureMove in class Game
Parameters:
game - 
The game object to process.
Returns:
false.

processText_pieceImages

processText_pieceImages(p1,
                        p2)
Parameters:
p1 - 

p2 - 


promotionResponse

promotionResponse(status)
Parameters:
status - 


promotionSubmit

promotionSubmit()

removeFromCaptured

removeFromCaptured(team,
                   value)
Parameters:
team - 

value - 


removeFromReserve

removeFromReserve(team,
                  value)
Parameters:
team - 

value - 


removeFromTrades

removeFromTrades(team,
                 value)
Parameters:
team - 

value - 


removeOnboardFromReserve

removeOnboardFromReserve(value)
Parameters:
value - 


sendMove

Boolean sendMove(/*Boolean*/ sendNow,
                 /*Player*/ player)

Gets called when the Send Move button is pushed. Override and set the game state, then call Super.sendMove.

Overrides:
sendMove in class Game
Parameters:
sendNow - 
(Optional) Send the moves to the server now. Else, save the move for sending later. Defaults to true.
player - 
(Optional) The player responsible for the move. Defaults to the current player (game.player).
Returns:
true.

setBottomOnboardAsEnigma

setBottomOnboardAsEnigma(boardPoint)
Parameters:
boardPoint - 


setCapturedList

setCapturedList(team,
                values,
                noSort)
Parameters:
team - 

values - 

noSort - 


setPerspective

void setPerspective(/*Team*/ team)

Called when synchronizing, sets the perspective of the board based on the player. By default sets the rotation property to 0.

Overrides:
setPerspective in class Game
Parameters:
team - 
The team to synchronize.

setReserveList

setReserveList(team,
               values,
               noSort)
Parameters:
team - 

values - 

noSort - 


setTradeList

setTradeList(team,
             values,
             noSort)
Parameters:
team - 

values - 

noSort - 


sortPieceList

sortPieceList(value)
Parameters:
value - 


synch

void synch()

Called when the game should synchronize with info properties from the server.

Overrides:
synch in class Game
Notes:
The game should set tangible properties or states for each custom property set in the info collection. The info collection should not be referenced outside the scope of the synch or sendMove methods.

synchTeam

void synchTeam(/*Team*/ team)

Called to synchronize the team properties with the raw team data. Just the color and title properties are set by default, override to set more.

Overrides:
synchTeam in class Game
Parameters:
team - 
The team to synchronize.

titlesSetCapturedVisibility

titlesSetCapturedVisibility(hidden)
Parameters:
hidden - 


titlesSetCapturedVisibilityAtIndex

titlesSetCapturedVisibilityAtIndex(hidden,
                                   index)
Parameters:
hidden - 

index - 


tradingAcceptingGetLogEntries

tradingAcceptingGetLogEntries()

tradingAddIndexToTable

tradingAddIndexToTable(index)
Parameters:
index - 


tradingAddPiecesToTable

tradingAddPiecesToTable(pieces)
Parameters:
pieces - 


tradingCalculateTotal

tradingCalculateTotal(values)
Parameters:
values - 


tradingDecline

tradingDecline()

tradingDeclinedAcknowledged

tradingDeclinedAcknowledged(noUpdate)
Parameters:
noUpdate - 


tradingDecliningGetLogEntries

tradingDecliningGetLogEntries()

tradingGetAskingHtml

tradingGetAskingHtml()

tradingGetBeginningHtml

tradingGetBeginningHtml()

tradingGetDeclinedHtml

tradingGetDeclinedHtml()

tradingGetDecliningHtml

tradingGetDecliningHtml()

tradingGetObligitoryTradesHtml

tradingGetObligitoryTradesHtml()

tradingGetPossibilities

tradingGetPossibilities(pieces)
Parameters:
pieces - 


tradingGetRespondHtml

tradingGetRespondHtml()

tradingGetSuggestionHtml

tradingGetSuggestionHtml(pieces)
Parameters:
pieces - 


tradingGetTabledPieceHtml

tradingGetTabledPieceHtml(value,
                          addMouseEvent)
Parameters:
value - 

addMouseEvent - 


tradingGetTabledPiecesHtml

tradingGetTabledPiecesHtml(values,
                           addMouseEvents)
Parameters:
values - 

addMouseEvents - 


tradingGetTeamTradingSpaceHtml

tradingGetTeamTradingSpaceHtml(team,
                               addMouseEvents)
Parameters:
team - 

addMouseEvents - 


tradingIsReadyToSend

tradingIsReadyToSend()

tradingMaybeShowBox

tradingMaybeShowBox()

tradingOfferingGetLogEntries

tradingOfferingGetLogEntries()

tradingOnSendMove

tradingOnSendMove()

tradingOrderPieces

tradingOrderPieces(pieces)
Parameters:
pieces - 


tradingParePossibilities

tradingParePossibilities(possibilities,
                         pareType,
                         value)
Parameters:
possibilities - 

pareType - 

value - 


tradingPossibiltyToString

tradingPossibiltyToString()

tradingPushPossibilities

tradingPushPossibilities(possibilities,
                         pieces,
                         rest,
                         size)
Parameters:
possibilities - 

pieces - 

rest - 

size - 


tradingRemovePiecesFromTable

tradingRemovePiecesFromTable(pieces)
Parameters:
pieces - 


undo

void undo(/*Boolean*/ skipUpdate)

Undos all moves since the last synch method call. The synch and update methods will be called again.

Overrides:
undo in class Game
Parameters:
skipUpdate - 
(Optional) Skips the update call if true. Defaults to false.

undoBeginCommand

undoBeginCommand()

undoBeginCommand_flip

undoBeginCommand_flip(boardPoint)
Parameters:
boardPoint - 


undoBeginCommand_move

undoBeginCommand_move(boardPoint)
Parameters:
boardPoint - 


undoBeginCommand_onboard

undoBeginCommand_onboard()

undoBeginCommand_tradingOffering

undoBeginCommand_tradingOffering(boardPoint)
Parameters:
boardPoint - 


undoClearRegistry

undoClearRegistry()

undoCloneArguments

undoCloneArguments(args)
Parameters:
args - 


undoCloneData

undoCloneData(data)
Parameters:
data - 


undoCompareArguments

undoCompareArguments(args1,
                     args2)
Parameters:
args1 - 

args2 - 


undoCompareData

undoCompareData(data1,
                data2)
Parameters:
data1 - 

data2 - 


undoGetLogEntries

undoGetLogEntries()

undoRegisterCommand

undoRegisterCommand()

undoRegisterCompareLastMove

undoRegisterCompareLastMove()

weCapturedAtIndex

weCapturedAtIndex(index,
                  value)
Parameters:
index - 

value -