GamesByEmail
Class DipoleGame

Object
  GamesByEmail.Game
      GamesByEmail.DipoleGame

All Implemented Interfaces:

GamesByEmail.DipoleGame

extends Game

Nested Class Summary
static Class	DipoleGame.MoveData

Constructor Summary

GamesByEmail.DipoleGame()

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
Point	boardPointFromValueIndex(/*Number*/ index) Gets the board point from the board value index.
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.
	canBearOffLess()
	canBearOffMore()
	canMove(moveData, color)
	canMoveFrom(fromPoint, moveData, color)
Boolean	checkMove(/*Point*/ toPoint, /*Point*/ fromPoint) Checks to see if a move is legal. By default calls isMoveLegal.
Number	colorFromBoardValue(/*String*/ boardValue) Gets the color from a board value. By default, lower case characters return 0, uppercase 1, and everything else -1.
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.
	decreaseBearingOff()
	decreaseBearingOffButtonHtml(enabled)
	dispose()
	dragByClicks(up, origPoint, screenPoint)
	getMoveData(board)
Rectangle	getPieceRect(/*String*/ value, /*Number*/ color, /*Point*/ boardPoint) Gets the clipping rectangle for a piece.
	getTeamScore(team)
String	getTeamTitleHtml(/*Team*/ team, /*Boolean*/ top) Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.
	hasPieceOnBoard(moveData, color)
	increaseBearingOff()
	increaseBearingOffButtonHtml(enabled)
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, moveData, fourPlayers, quick)
	isOurPlayablePieceAtPoint(point, board, color)
	isPointBearingOff(point)
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.
	maybeShowBearingOff(showButtons)
	modifyAddSubPoints(addPoint, subPoint)
	mouseDown(screenPoint)
	mouseMove(screenPoint)
	mouseUp(screenPoint)
	pointScoreValue(point, color)
	removeOffPiece(point)
	removeOffPieces()
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.
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.
	setMoveData(moveData)
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.
	showHilites(hilites)
	spaceNotation(x, y)
void	synch() Called when the game should synchronize with info properties from the server.
	updateBearingOffButtons()
String	valueFromBoardValue(/*String*/ boardValue) Gets the value from a board value. By default, the lower case of the board value is returned.
Number	valueIndexFromBoardXY(/*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, continueYourTurnHtml, 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, 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, synchTeam, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, turnHeaderHtml, 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

DipoleGame

GamesByEmail.DipoleGame()

Field Detail

resourcePack

static Object resourcePack

Method Detail

boardPointFromValueIndex

Point boardPointFromValueIndex(/*Number*/ index)

index - 

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

value - 

color - 

canBearOffLess()

canBearOffMore()

canMove(moveData,
        color)

moveData - 

color - 

canMoveFrom(fromPoint,
            moveData,
            color)

fromPoint - 

moveData - 

color - 

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

toPoint - 

fromPoint - 

Number colorFromBoardValue(/*String*/ boardValue)

boardValue - 

String completeYourTurnHtml(/*String*/ resourceName)

resourceName - 

decreaseBearingOff()

decreaseBearingOffButtonHtml(enabled)

enabled - 

dispose()

dragByClicks(up,
             origPoint,
             screenPoint)

up - 

origPoint - 

screenPoint - 

getMoveData(board)

board - 

Rectangle getPieceRect(/*String*/ value,
                       /*Number*/ color,
                       /*Point*/ boardPoint)

value - 

color - 

boardPoint - 

getTeamScore(team)

team - 

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

team - 

top - 

hasPieceOnBoard(moveData,
                color)

moveData - 

color - 

increaseBearingOff()

increaseBearingOffButtonHtml(enabled)

enabled - 

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,
            moveData,
            fourPlayers,
            quick)

toPoint - 

fromPoint - 

moveData - 

fourPlayers - 

quick - 

isOurPlayablePieceAtPoint(point,
                          board,
                          color)

point - 

board - 

color - 

isPointBearingOff(point)

point - 

String itsYourTurnHtml(/*String*/ resourceName)

resourceName - 

maybeShowBearingOff(showButtons)

showButtons - 

modifyAddSubPoints(addPoint,
                   subPoint)

addPoint - 

subPoint - 

mouseDown(screenPoint)

screenPoint - 

mouseMove(screenPoint)

screenPoint - 

mouseUp(screenPoint)

screenPoint - 

pointScoreValue(point,
                color)

point - 

color - 

removeOffPiece(point)

point - 

removeOffPieces()

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

sendNow - 

player - 

String sendMoveHtml(/*String*/ resourceName)

resourceName - 

setMoveData(moveData)

moveData - 

void setPerspective(/*Team*/ team)

team - 

showHilites(hilites)

hilites - 

spaceNotation(x,
              y)

x - 

y - 

void synch()

updateBearingOffButtons()

String valueFromBoardValue(/*String*/ boardValue)

boardValue - 

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

x - 

y -