GamesByEmail
Class BackgammonGame

Object
  GamesByEmail.Game
      GamesByEmail.BackgammonGame

All Implemented Interfaces:

GamesByEmail.BackgammonGame

extends Game

Nested Class Summary
static Class	BackgammonGame.MoveData

Constructor Summary

GamesByEmail.BackgammonGame()

Field Summary
static Object	resourcePack 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
	acceptDoubling()
	acceptDoublingButtonHtml(additionalStyle)
	acceptDoublingHtml()
	addPiece(index, board, color)
	anyOnBar(color)
	anythingHigher(index, board, color)
	burnRolls()
	canMoveFromPoint(fromPoint, movingPieceImage)
	canUseRolls(rolls, color)
	centerDoublingValue(screenPoint, rail)
	changeDoubling(hasDoubled)
	checkForWin(color)
Boolean	checkMove(/*Point*/ toPoint, /*Point*/ fromPoint) Checks to see if a move is legal. By default calls isMoveLegal.
	colorAtIndex(index, board)
	colorFromValue(value)
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.
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.
	dispose()
	doublingCheckBoxHtml(additionalStyle)
	dragByClicks(up, origPoint, screenPoint)
	getCalcIndex(index)
	getHighestDie(rolls)
	getHiliteBoardValue()
	getMoveData(rolls)
	getScore(color)
	getStakesMultiplier(color)
String	getTeamTitleHtml(/*Team*/ team, /*Boolean*/ top) Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.
	hasAnyInOpponentsHome(color)
	hasAnyOut(color)
	hideHilites()
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.
	isMoveLegal(toPoint, fromPoint, data, color, quick)
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.
	missedRollsMessage()
	mouseDown(screenPoint)
	mouseDownDoubling(screenPoint)
	mouseMove(screenPoint)
	mouseMoveDoubling(screenPoint)
	mouseUp(screenPoint)
	mouseUpDoubling(screenPoint)
String	movePiece(/*Point*/ toPoint, /*Point*/ fromPoint, /*String*/ board) Moves a value in a board string to another point.
	numAtIndex(index, board)
	numFromValue(value)
	numOnBar(board, color)
	numRolls(rolls)
String	offerDrawHtml(/*String*/ resourceName) Called when needing the offer-a-draw-with-this-move prompts HTML (typically a short sentence and a Offer A Draw checkbox). Override to set. Internally uses the "youMayOfferDraw" and "offerDrawWithThisMove" resources.
	parkDoublingValue(rail)
	pointNotation(index)
	readyToBearOff(board, color)
	removePiece(index, board)
void	resign() Resignes the current player. Clears mouse events, sets the player as resigned, and sends the move.
String	resignHtml(/*String*/ resourceName) Called when needing the you-may-resign prompt HTML (typically a short sentence about resiging and a Resign button). Override to set. Internally uses the "youMayResign" resource.
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.
	setDoublingValue(doublingValue)
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.
	showRolls()
void	synch() Called when the game should synchronize with info properties from the server.
	valueFromNumColor(num, color)
String	wonHeaderHtml(/*String*/ resourceName) Called when needing the won-game header HTML. Override to set. Internally uses the "wonHeader" resource.
	zeroHighestDie(rolls)

Methods inherited from GamesByEmail.Game

aboveTeamTitleRowHtml, acceptDeclineDrawHtml, acceptDraw, acceptDrawButtonHtml, addNote, addToPage, appendAdditionalPreferencesHtml, appendBoardHtml, beginTurnHtml, belowTeamTitleRowHtml, boardPointFromScreenPoint, boardPointFromScreenXY, boardPointFromValueIndex, boardValueFromValueColor, cancelGameButtonHtml, cancelGameHtml, 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, gameOverHtml, getActionLinksHtml, getAnchorHtml, getButtonHtml, getCheckboxHtml, getGamePromptsHtml, getHeaderHtml, getHtml, 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, nextTeam, notYourTurnHtml, numInPath, numTeamsPlaying, offerDrawCheckBoxHtml, openLogAnchorHtml, openPlayerChatAnchorHtml, openPreferencesAnchorHtml, openRulesAnchorHtml, pie, pieButtonHtml, pieHtml, processSecureMove, refreshGame, refreshGameButtonHtml, reportProblemAnchorHtml, resignButtonHtml, resignedHeaderHtml, screenRectFromBoardPoint, screenRectFromBoardXY, sendMoveButtonHtml, sendMoveHtml, sendReminderButtonHtml, setConstrainer, setEnded, setFloatHtml, setInnerHtml, setMouseHtml, setPlayerPrefs, setValueAtPoint, setValueAtXY, showTransactionPrompt, spectatingHtml, startAnotherGameButtonHtml, startAnotherGameHtml, synchTeam, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, turnHeaderHtml, undo, undoButtonHtml, undoMoveHtml, update, updateTeamTitles, valueFromBoardValue, valueFromPointBoard, valueFromXYBoard, valueIndexFromBoardPoint, valueIndexFromBoardXY, 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

BackgammonGame

GamesByEmail.BackgammonGame()

Field Detail

resourcePack

static Object resourcePack

Method Detail

acceptDoubling

acceptDoubling()

acceptDoublingButtonHtml(additionalStyle)

additionalStyle - 

acceptDoublingHtml()

addPiece(index,
         board,
         color)

index - 

board - 

color - 

anyOnBar(color)

color - 

anythingHigher(index,
               board,
               color)

index - 

board - 

color - 

burnRolls()

canMoveFromPoint(fromPoint,
                 movingPieceImage)

fromPoint - 

movingPieceImage - 

canUseRolls(rolls,
            color)

rolls - 

color - 

centerDoublingValue(screenPoint,
                    rail)

screenPoint - 

rail - 

changeDoubling(hasDoubled)

hasDoubled - 

checkForWin(color)

color - 

Boolean checkMove(/*Point*/ toPoint,
                  /*Point*/ fromPoint)

toPoint - 

fromPoint - 

colorAtIndex(index,
             board)

index - 

board - 

colorFromValue(value)

value - 

String completeYourTurnHtml(/*String*/ resourceName)

resourceName - 

String continueYourTurnHtml(/*String*/ resourceName)

resourceName - 

dispose()

doublingCheckBoxHtml(additionalStyle)

additionalStyle - 

dragByClicks(up,
             origPoint,
             screenPoint)

up - 

origPoint - 

screenPoint - 

getCalcIndex(index)

index - 

getHighestDie(rolls)

rolls - 

getHiliteBoardValue()

getMoveData(rolls)

rolls - 

getScore(color)

color - 

getStakesMultiplier(color)

color - 

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

team - 

top - 

hasAnyInOpponentsHome(color)

color - 

hasAnyOut(color)

color - 

hideHilites()

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

numPlayers - 

turnTeamIndex - 

// 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);
   }

isMoveLegal(toPoint,
            fromPoint,
            data,
            color,
            quick)

toPoint - 

fromPoint - 

data - 

color - 

quick - 

String itsYourTurnHtml(/*String*/ resourceName)

resourceName - 

missedRollsMessage()

mouseDown(screenPoint)

screenPoint - 

mouseDownDoubling(screenPoint)

screenPoint - 

mouseMove(screenPoint)

screenPoint - 

mouseMoveDoubling(screenPoint)

screenPoint - 

mouseUp(screenPoint)

screenPoint - 

mouseUpDoubling(screenPoint)

screenPoint - 

String movePiece(/*Point*/ toPoint,
                 /*Point*/ fromPoint,
                 /*String*/ board)

toPoint - 

fromPoint - 

board - 

numAtIndex(index,
           board)

index - 

board - 

numFromValue(value)

value - 

numOnBar(board,
         color)

board - 

color - 

numRolls(rolls)

rolls - 

String offerDrawHtml(/*String*/ resourceName)

resourceName - 

parkDoublingValue(rail)

rail - 

pointNotation(index)

index - 

readyToBearOff(board,
               color)

board - 

color - 

removePiece(index,
            board)

index - 

board - 

void resign()

String resignHtml(/*String*/ resourceName)

resourceName - 

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

sendNow - 

player - 

setDoublingValue(doublingValue)

doublingValue - 

void setPerspective(/*Team*/ team)

team - 

showRolls()

void synch()

valueFromNumColor(num,
                  color)

num - 

color - 

String wonHeaderHtml(/*String*/ resourceName)

resourceName - 

zeroHighestDie(rolls)

rolls -