File: Games\Checkers\Game.js

GamesByEmail
Class CheckersGame

Object
  
 
 
GamesByEmail.Game
      
 
 
GamesByEmail.CheckersGame

All Implemented Interfaces:

Class, Elemental, Resourceful, Server

GamesByEmail.CheckersGame

extends Game

Nested Class Summary
static ClassCheckersGame.MoveData

Constructor Summary
GamesByEmail.CheckersGame()

Field Summary
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
PointboardPointFromValueIndex(/*Number*/ index)
Gets the board point from the board value index.
StringboardValueFromValueColor(/*String*/ value, /*Number*/ color)
Gets the board value from a value and color. By default, the value is returned if color is zero, else the upper case of the value is returned.
 canJumpFromPoint(point, moveData, jumps)
 canMove(moveData, color)
 canMoveFrom(fromPoint, moveData, color)
BooleancheckMove(/*Point*/ toPoint, /*Point*/ fromPoint)
Checks to see if a move is legal. By default calls isMoveLegal.
 colorCanJump(moveData, color)
 colorCanJumpFromPoint(point, moveData, jumps, color)
NumbercolorFromBoardValue(/*String*/ boardValue)
Gets the color from a board value. By default, lower case characters return 0, uppercase 1, and everything else -1.
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.
 dispose()
 dragByClicks(up, origPoint, screenPoint)
StringdrawDeclinedHeaderHtml(/*String*/ resourceName)
Called when needing the draw-declined header HTML. Override to set. Internally uses the "drawDeclinedHeader" resource.
StringdrawOfferedHeaderHtml(/*String*/ resourceName)
Called when needing the draw-offered header HTML. Override to set. Internally uses the "drawOfferedHeader" resource.
 getMoveData(board)
StringgetTeamTitleHtml(/*Team*/ team, /*Boolean*/ top)
Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.
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.
 isKingFromPieceValue(pieceValue)
 isMoveLegal(toPoint, fromPoint, moveData)
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.
 maybePromote(point, moveData)
 mouseDown(screenPoint)
 mouseMove(screenPoint)
 mouseUp(screenPoint)
 pieceNotation(pieceChar)
 promoteToKing(boardValue)
BooleansendMove(/*Boolean*/ sendNow, /*Player*/ player)
Gets called when the Send Move button is pushed. Override and set the game state, then call Super.sendMove.
StringsendMoveHtml(/*String*/ resourceName)
Called when needing the send-this-move prompts HTML (typically a short sentence and a Send This Move button). Override to set. Internally uses the "youMaySendYourMove" resource.
 setMoveData(moveData)
voidsetPerspective(/*Team*/ team)
Called when synchronizing, sets the perspective of the board based on the player. By default sets the rotation property to 0.
 showHilites(moveData, hilites)
 spaceNotation(x, y)
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.
StringturnHeaderHtml(/*String*/ resourceName)
Called when needing the it's-your-turn header HTML. Override to set. Internally uses the "turnHeader" resource.
StringvalueFromBoardValue(/*String*/ boardValue)
Gets the value from a board value. By default, the lower case of the board value is returned.
NumbervalueIndexFromBoardXY(/*Number*/ x, /*Number*/ y)
Gets the board string index of a coordinate.

Methods inherited from GamesByEmail.Game
aboveTeamTitleRowHtml, acceptDeclineDrawHtml, acceptDraw, acceptDrawButtonHtml, addNote, addToPage, appendAdditionalPreferencesHtml, appendBoardHtml, beginTurnHtml, belowTeamTitleRowHtml, boardPointFromScreenPoint, boardPointFromScreenXY, cancelGameButtonHtml, cancelGameHtml, clearHilites, clearMouseEvents, closeWindowButtonHtml, closeWindowHtml, colorFromPointBoard, colorFromXYBoard, completeTurnHtml, constrainPoint, constrainRectangle, continueTurnHtml, debug, diceRolls, dieRoll, drawAcceptedHeaderHtml, drawAcceptedHtml, drawDeclinedHtml, 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, movePiece, nextTeam, notYourTurnHtml, numInPath, numTeamsPlaying, offerDrawCheckBoxHtml, offerDrawHtml, openLogAnchorHtml, openPlayerChatAnchorHtml, openPreferencesAnchorHtml, openRulesAnchorHtml, pie, pieButtonHtml, pieHtml, processSecureMove, refreshGame, refreshGameButtonHtml, reportProblemAnchorHtml, resign, resignButtonHtml, resignHtml, resignedHeaderHtml, screenRectFromBoardPoint, screenRectFromBoardXY, sendMoveButtonHtml, sendReminderButtonHtml, setConstrainer, setEnded, setFloatHtml, setInnerHtml, setMouseHtml, setPlayerPrefs, setValueAtPoint, setValueAtXY, showTransactionPrompt, spectatingHtml, startAnotherGameButtonHtml, startAnotherGameHtml, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, undo, undoButtonHtml, undoMoveHtml, update, updateTeamTitles, valueFromPointBoard, valueFromXYBoard, valueIndexFromBoardPoint, 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

CheckersGame

GamesByEmail.CheckersGame()

Field Detail

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

boardPointFromValueIndex

Point boardPointFromValueIndex(/*Number*/ index)

Gets the board point from the board value index.

Overrides:
boardPointFromValueIndex in class Game
Parameters: 
index -
The board value index.
Returns:
The board point.

boardValueFromValueColor

String boardValueFromValueColor(/*String*/ value,
                                /*Number*/ color)

Gets the board value from a value and color. By default, the value is returned if color is zero, else the upper case of the value is returned.

Overrides:
boardValueFromValueColor in class Game
Parameters: 
value -
The value.
color -
The color.
Returns:
The board value.

canJumpFromPoint

canJumpFromPoint(point,
                 moveData,
                 jumps)
Parameters: 
point - 

moveData - 

jumps -

canMove

canMove(moveData,
        color)
Parameters: 
moveData - 

color -

canMoveFrom

canMoveFrom(fromPoint,
            moveData,
            color)
Parameters: 
fromPoint - 

moveData - 

color -

checkMove

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

Checks to see if a move is legal. By default calls isMoveLegal.

Overrides:
checkMove in class Game
Parameters: 
toPoint -
The board point moving to.
fromPoint -
The board point moving from.
Returns:
true if the move is legal.
See Also:
isMoveLegal

colorCanJump

colorCanJump(moveData,
             color)
Parameters: 
moveData - 

color -

colorCanJumpFromPoint

colorCanJumpFromPoint(point,
                      moveData,
                      jumps,
                      color)
Parameters: 
point - 

moveData - 

jumps - 

color -

colorFromBoardValue

Number colorFromBoardValue(/*String*/ boardValue)

Gets the color from a board value. By default, lower case characters return 0, uppercase 1, and everything else -1.

Overrides:
colorFromBoardValue in class Game
Parameters: 
boardValue -
The value to check, by default a single character.
Returns:
The color number.

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.

dispose

dispose()
Overrides:
dispose in class Game

dragByClicks

dragByClicks(up,
             origPoint,
             screenPoint)
Parameters: 
up - 

origPoint - 

screenPoint -

drawDeclinedHeaderHtml

String drawDeclinedHeaderHtml(/*String*/ resourceName)

Called when needing the draw-declined header HTML. Override to set. Internally uses the "drawDeclinedHeader" resource.

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

drawOfferedHeaderHtml

String drawOfferedHeaderHtml(/*String*/ resourceName)

Called when needing the draw-offered header HTML. Override to set. Internally uses the "drawOfferedHeader" resource.

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

getMoveData

getMoveData(board)
Parameters: 
board -

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.

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

isKingFromPieceValue

isKingFromPieceValue(pieceValue)
Parameters: 
pieceValue -

isMoveLegal

isMoveLegal(toPoint,
            fromPoint,
            moveData)
Parameters: 
toPoint - 

fromPoint - 

moveData -

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.

maybePromote

maybePromote(point,
             moveData)
Parameters: 
point - 

moveData -

mouseDown

mouseDown(screenPoint)
Parameters: 
screenPoint -

mouseMove

mouseMove(screenPoint)
Parameters: 
screenPoint -

mouseUp

mouseUp(screenPoint)
Parameters: 
screenPoint -

pieceNotation

pieceNotation(pieceChar)
Parameters: 
pieceChar -

promoteToKing

promoteToKing(boardValue)
Parameters: 
boardValue -

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.

sendMoveHtml

String sendMoveHtml(/*String*/ resourceName)

Called when needing the send-this-move prompts HTML (typically a short sentence and a Send This Move button). Override to set. Internally uses the "youMaySendYourMove" resource.

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

setMoveData

setMoveData(moveData)
Parameters: 
moveData -

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.

showHilites

showHilites(moveData,
            hilites)
Parameters: 
moveData - 

hilites -

spaceNotation

spaceNotation(x,
              y)
Parameters: 
x - 

y -

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.

turnHeaderHtml

String turnHeaderHtml(/*String*/ resourceName)

Called when needing the it's-your-turn header HTML. Override to set. Internally uses the "turnHeader" resource.

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

valueFromBoardValue

String valueFromBoardValue(/*String*/ boardValue)

Gets the value from a board value. By default, the lower case of the board value is returned.

Overrides:
valueFromBoardValue in class Game
Parameters: 
boardValue -
The value to check, by default a single character.
Returns:
The value.

valueIndexFromBoardXY

Number valueIndexFromBoardXY(/*Number*/ x,
                             /*Number*/ y)

Gets the board string index of a coordinate.

Overrides:
valueIndexFromBoardXY in class Game
Parameters: 
x -
The x coordinate, in board point space.
y -
The y coordinate, in board point space.
Returns:
The index of the coordinate.