File: Games\Phalanx\Game.js

GamesByEmail
Class PhalanxGame

Object
  
 
 
GamesByEmail.Game
 
 
GamesByEmail.PhalanxGame

All Implemented Interfaces:

Class, Elemental, Resourceful, Server


GamesByEmail.PhalanxGame

extends Game

Constructor Summary
GamesByEmail.PhalanxGame()

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
 boardPointFromDataChars(data)
PointboardPointFromScreenXY(/*Number*/ screenX, /*Number*/ screenY)
Gets the board point from a screen coordinates.
 canMove(color)
BooleancheckMove(/*Point*/ toPoint, /*Point*/ fromPoint)
Checks to see if a move is legal. By default calls isMoveLegal.
 checkPointForOnBoardAndClear(point, board)
 checkPointsForOnBoardAndClear(points, board)
 dataCharsFromBoardPoint(point)
 dispose()
 dragByClicks(up, origPoint, screenPoint)
 getExtendedPoints(pieceValue, whenAtPoint)
 getExtendedPoints(pieceValue, whenAtPoint)
 getExtendedScreenRect(pieceValue, boardPoint)
 getHiliteData()
StringgetHtml()
Gets the HTML of the entire game.
RectanglegetPieceRect(/*String*/ value, /*Number*/ color, /*Point*/ boardPoint)
Gets the clipping rectangle for a piece.
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.
 isPiecePhalanxedAt(pieceValue, point, board, attackerColor)
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.
 markPhalanxedPieces(fullBoard, targetColor)
 mouseDown(screenPoint)
 mouseMove(screenPoint)
 mouseUp(screenPoint)
 pieceCanMoveInCardinalDirection(pieceValue, fromPoint, cardinal, fullBoardValue)
 pieceNotation(pieceChar)
 pieceWouldOccupyBoardPoint(pieceValue, whenAtPoint, targetPoint)
 processMousePosition(screenPoint)
 screenDirectionToCardinalDirection(screenDirection)
RectanglescreenRectFromBoardXY(/*Number*/ boardX, /*Number*/ boardY)
Gets the screen rectangle from board coordinates.
BooleansendMove(/*Boolean*/ sendNow, /*Player*/ player)
Gets called when the Send Move button is pushed. Override and set the game state, then call Super.sendMove.
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(data)
 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.
 translatePieceCenterByMuster(pieceValue, screenCenter, reverse)

Methods inherited from GamesByEmail.Game
aboveTeamTitleRowHtml, acceptDeclineDrawHtml, acceptDraw, acceptDrawButtonHtml, addNote, addToPage, appendAdditionalPreferencesHtml, appendBoardHtml, beginTurnHtml, belowTeamTitleRowHtml, boardPointFromScreenPoint, boardPointFromValueIndex, boardValueFromValueColor, cancelGameButtonHtml, cancelGameHtml, clearHilites, clearMouseEvents, closeWindowButtonHtml, closeWindowHtml, colorFromBoardValue, colorFromPointBoard, colorFromXYBoard, completeTurnHtml, completeYourTurnHtml, 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, 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, sendMoveButtonHtml, sendMoveHtml, sendReminderButtonHtml, setConstrainer, setEnded, setFloatHtml, setInnerHtml, setMouseHtml, setPlayerPrefs, setValueAtPoint, setValueAtXY, showTransactionPrompt, spectatingHtml, startAnotherGameButtonHtml, startAnotherGameHtml, teamColorFromTeam, theyResignedHtml, tieGameHeaderHtml, titleFromTeamColor, transformHashLinksToOnClicks, turnHeaderHtml, 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

PhalanxGame

GamesByEmail.PhalanxGame()

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

boardPointFromDataChars

boardPointFromDataChars(data)
Parameters:
data - 


boardPointFromScreenXY

Point boardPointFromScreenXY(/*Number*/ screenX,
                             /*Number*/ screenY)

Gets the board point from a screen coordinates.

Overrides:
boardPointFromScreenXY in class Game
Parameters:
screenX - 
The x coordinate, in screen space.
screenY - 
The y coordinate, in screen space.
Returns:
The board point.

canMove

canMove(color)
Parameters:
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

checkPointForOnBoardAndClear

checkPointForOnBoardAndClear(point,
                             board)
Parameters:
point - 

board - 


checkPointsForOnBoardAndClear

checkPointsForOnBoardAndClear(points,
                              board)
Parameters:
points - 

board - 


dataCharsFromBoardPoint

dataCharsFromBoardPoint(point)
Parameters:
point - 


dispose

dispose()
Overrides:
dispose in class Game

dragByClicks

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

origPoint - 

screenPoint - 


getExtendedPoints

getExtendedPoints(pieceValue,
                  whenAtPoint)
Parameters:
pieceValue - 

whenAtPoint - 


getExtendedPoints

getExtendedPoints(pieceValue,
                  whenAtPoint)
Parameters:
pieceValue - 

whenAtPoint - 


getExtendedScreenRect

getExtendedScreenRect(pieceValue,
                      boardPoint)
Parameters:
pieceValue - 

boardPoint - 


getHiliteData

getHiliteData()

getHtml

String getHtml()

Gets the HTML of the entire game.

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

getPieceRect

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

Gets the clipping rectangle for a piece.

Overrides:
getPieceRect in class Game
Parameters:
value - 
The value of the piece.
color - 
(Optional) The color of the piece. Not used by default.
boardPoint - 
(Optional) The board point of the piece. Not used by default.
Returns:
The clipping rectangle.

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

isPiecePhalanxedAt

isPiecePhalanxedAt(pieceValue,
                   point,
                   board,
                   attackerColor)
Parameters:
pieceValue - 

point - 

board - 

attackerColor - 


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.

markPhalanxedPieces

markPhalanxedPieces(fullBoard,
                    targetColor)
Parameters:
fullBoard - 

targetColor - 


mouseDown

mouseDown(screenPoint)
Parameters:
screenPoint - 


mouseMove

mouseMove(screenPoint)
Parameters:
screenPoint - 


mouseUp

mouseUp(screenPoint)
Parameters:
screenPoint - 


pieceCanMoveInCardinalDirection

pieceCanMoveInCardinalDirection(pieceValue,
                                fromPoint,
                                cardinal,
                                fullBoardValue)
Parameters:
pieceValue - 

fromPoint - 

cardinal - 

fullBoardValue - 


pieceNotation

pieceNotation(pieceChar)
Parameters:
pieceChar - 


pieceWouldOccupyBoardPoint

pieceWouldOccupyBoardPoint(pieceValue,
                           whenAtPoint,
                           targetPoint)
Parameters:
pieceValue - 

whenAtPoint - 

targetPoint - 


processMousePosition

processMousePosition(screenPoint)
Parameters:
screenPoint - 


screenDirectionToCardinalDirection

screenDirectionToCardinalDirection(screenDirection)
Parameters:
screenDirection - 


screenRectFromBoardXY

Rectangle screenRectFromBoardXY(/*Number*/ boardX,
                                /*Number*/ boardY)

Gets the screen rectangle from board coordinates.

Overrides:
screenRectFromBoardXY in class Game
Parameters:
boardX - 
The x coordinate, in board point space.
boardY - 
The y coordinate, in board point space.
Returns:
The screen rectangle.

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.

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(data)
Parameters:
data - 


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.

translatePieceCenterByMuster

translatePieceCenterByMuster(pieceValue,
                             screenCenter,
                             reverse)
Parameters:
pieceValue - 

screenCenter - 

reverse -