GamesByEmail
Class CageGame

Object
  GamesByEmail.Game
      GamesByEmail.CageGame

All Implemented Interfaces:

GamesByEmail.CageGame

extends Game

Nested Class Summary
static Class	CageGame.MoveData

Constructor Summary

GamesByEmail.CageGame()

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
	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.
	compareMovePoints(moveStack, mouseStack)
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.
	countAdjacentAtXY(x, y, notThisPoint, board, color)
	countAdjacentPieces(point, notThisPoint, board, color, enemy)
	dispose()
	dragByClicks(up, origPoint, screenPoint)
	getMoveData(mustJump)
	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'.
	hiliteMoveData(moveData)
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.
	isPointOffPlayingSurface(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.
	legalDebug(msg, indent)
	mouseDown(screenPoint)
	mouseMove(screenPoint)
	mouseUp(screenPoint)
	moveNotation(x, y)
	pushLegalMoves(moveStack, toPoint, fromPoint, moveData, doNotCheckFurther)
	pushMovePoint(boardPoint)
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.
	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, moverColor, otherColor)
void	synch() Called when the game should synchronize with info properties from the server.
String	turnHeaderHtml(/*String*/ resourceName) Called when needing the it's-your-turn header HTML. Override to set. Internally uses the "turnHeader" resource.

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, 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, sendMoveHtml, sendReminderButtonHtml, setConstrainer, setEnded, setFloatHtml, setInnerHtml, setMouseHtml, setPlayerPrefs, setValueAtPoint, setValueAtXY, showTransactionPrompt, spectatingHtml, startAnotherGameButtonHtml, startAnotherGameHtml, synchTeam, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, undo, 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

CageGame

GamesByEmail.CageGame()

Field Detail

resourcePack

static Object resourcePack

Method Detail

canMove

canMove(moveData,
        color)

moveData - 

color - 

canMoveFrom(fromPoint,
            moveData,
            color)

fromPoint - 

moveData - 

color - 

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

toPoint - 

fromPoint - 

compareMovePoints(moveStack,
                  mouseStack)

moveStack - 

mouseStack - 

String completeYourTurnHtml(/*String*/ resourceName)

resourceName - 

String continueYourTurnHtml(/*String*/ resourceName)

resourceName - 

countAdjacentAtXY(x,
                  y,
                  notThisPoint,
                  board,
                  color)

x - 

y - 

notThisPoint - 

board - 

color - 

countAdjacentPieces(point,
                    notThisPoint,
                    board,
                    color,
                    enemy)

point - 

notThisPoint - 

board - 

color - 

enemy - 

dispose()

dragByClicks(up,
             origPoint,
             screenPoint)

up - 

origPoint - 

screenPoint - 

getMoveData(mustJump)

mustJump - 

getTeamScore(team)

team - 

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

team - 

top - 

hiliteMoveData(moveData)

moveData - 

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

isPointOffPlayingSurface(point)

point - 

String itsYourTurnHtml(/*String*/ resourceName)

resourceName - 

legalDebug(msg,
           indent)

msg - 

indent - 

mouseDown(screenPoint)

screenPoint - 

mouseMove(screenPoint)

screenPoint - 

mouseUp(screenPoint)

screenPoint - 

moveNotation(x,
             y)

x - 

y - 

pushLegalMoves(moveStack,
               toPoint,
               fromPoint,
               moveData,
               doNotCheckFurther)

moveStack - 

toPoint - 

fromPoint - 

moveData - 

doNotCheckFurther - 

pushMovePoint(boardPoint)

boardPoint - 

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

sendNow - 

player - 

setMoveData(moveData)

moveData - 

void setPerspective(/*Team*/ team)

team - 

showHilites(hilites,
            moverColor,
            otherColor)

hilites - 

moverColor - 

otherColor - 

void synch()

String turnHeaderHtml(/*String*/ resourceName)

resourceName -