File: Games\Rive\Game.js

GamesByEmail
Class RiveGame

Object
  
 
 
GamesByEmail.Game
 
 
GamesByEmail.RiveGame

All Implemented Interfaces:

Hex, Class, Elemental, Resourceful, Server


GamesByEmail.RiveGame

extends Game
implements GamesByEmail.Hex

Nested Class Summary
static ClassRiveGame.MoveData

Constructor Summary
GamesByEmail.RiveGame()

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
 captureCheckMove(point, quick)
 captureContinueYourTurnHtml()
 captureIsMoveLegal(point, moveData, groupPoint, color, quick)
 captureMouseDown(screenPoint)
BooleancheckMove(/*Point*/ toPoint, /*Point*/ fromPoint)
Checks to see if a move is legal. By default calls isMoveLegal.
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()
 endGameFindAGroup(board)
 endGameFindGroupPoint(point, board)
 endGameHasOnlyOneGroup(board)
 endGameHasOnlyOneGroupAndNoFreeSpots(board)
 getGroupSize(point, board)
 getMoveData()
 getTeamScore(team)
StringgetTeamTitleHtml(/*Team*/ team, /*Boolean*/ top)
Gets the HTML for the team title on the board. By default uses resources 'turnTeamTitle' or 'teamTitle'.
 hasMaxAdjacentGroupSize(point, board, size)
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.
voidinitializeNewGameForm(/*GameForm*/ gameForm, /*Array*/ userInfo)
Seeds the game form options with values from the current game.
 isMoveLegal(point, moveData, targetGroupSize, color, quick)
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.
 mouseDown(screenPoint)
 mouseMove(screenPoint)
 mouseOut(screenPoint)
 mouseOver(screenPoint)
 processLogMove0(moveIndex, data, info)
 processLogMove1(moveIndex, data, info)
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, mustMoveAgain)
voidsetPerspective(/*Team*/ team)
Called when synchronizing, sets the perspective of the board based on the player. By default sets the rotation property to 0.
 showAvailableCaptures(point, htmlBuilder, moveData, groupPoint, color)
 showAvailablePlacements(point, htmlBuilder, moveData, targetGroupSize, color)
 showMovesAndHilites(hilites)
 spaceNotation(x, y)
 stonePhrase(count)
voidsynch()
Called when the game should synchronize with info properties from the server.
 targetFindMinAdjacentGroupSize(board)
 targetHasMinAdjacentGroupSize(board, size)
 targetIsClearAndHasNoAdjacentGreaterThan(point, board, size)
 targetIsGroupSizeGreaterThan(point, data, target)
 targetSet(board)

Methods inherited from GamesByEmail.Game
aboveTeamTitleRowHtml, acceptDeclineDrawHtml, acceptDraw, acceptDrawButtonHtml, addNote, addToPage, appendAdditionalPreferencesHtml, appendBoardHtml, beginTurnHtml, belowTeamTitleRowHtml, boardPointFromScreenPoint, 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, 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, isBoardPointHidden, isColorAtPoint, isColorAtXY, isMyTurn, isPathClear, isPointBoardClear, isPointOnBoard, isValueColorAtPoint, isValueColorAtXY, isXYBoardClear, isXYOnBoard, maybePie, maybeResign, movePiece, nextTeam, notYourTurnHtml, numTeamsPlaying, offerDrawCheckBoxHtml, offerDrawHtml, openLogAnchorHtml, openPlayerChatAnchorHtml, openPreferencesAnchorHtml, openRulesAnchorHtml, pie, pieButtonHtml, pieHtml, processSecureMove, refreshGame, refreshGameButtonHtml, reportProblemAnchorHtml, resign, resignButtonHtml, resignHtml, resignedHeaderHtml, screenRectFromBoardPoint, 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, valueFromBoardValue, valueFromPointBoard, valueFromXYBoard, valueIndexFromBoardPoint, wonHeaderHtml, youLoseHtml, youResignedHtml, youTiedHtml, youWinHtml

Methods inherited from GamesByEmail.Hex
boardPointFromScreenXY, boardPointFromValueIndex, forEachBoardPoint, numInPath, screenRectFromBoardXY, valueIndexFromBoardXY

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

RiveGame

GamesByEmail.RiveGame()

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

captureCheckMove

captureCheckMove(point,
                 quick)
Parameters:
point - 

quick - 


captureContinueYourTurnHtml

captureContinueYourTurnHtml()

captureIsMoveLegal

captureIsMoveLegal(point,
                   moveData,
                   groupPoint,
                   color,
                   quick)
Parameters:
point - 

moveData - 

groupPoint - 

color - 

quick - 


captureMouseDown

captureMouseDown(screenPoint)
Parameters:
screenPoint - 


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

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

endGameFindAGroup

endGameFindAGroup(board)
Parameters:
board - 


endGameFindGroupPoint

endGameFindGroupPoint(point,
                      board)
Parameters:
point - 

board - 


endGameHasOnlyOneGroup

endGameHasOnlyOneGroup(board)
Parameters:
board - 


endGameHasOnlyOneGroupAndNoFreeSpots

endGameHasOnlyOneGroupAndNoFreeSpots(board)
Parameters:
board - 


getGroupSize

getGroupSize(point,
             board)
Parameters:
point - 

board - 


getMoveData

getMoveData()

getTeamScore

getTeamScore(team)
Parameters:
team - 


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.

hasMaxAdjacentGroupSize

hasMaxAdjacentGroupSize(point,
                        board,
                        size)
Parameters:
point - 

board - 

size - 


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

initializeNewGameForm

void initializeNewGameForm(/*GameForm*/ gameForm,
                           /*Array*/ userInfo)

Seeds the game form options with values from the current game.

Overrides:
initializeNewGameForm in class Game
Parameters:
gameForm - 
The game form to seed.
userInfo - 
An array of user information.

isMoveLegal

isMoveLegal(point,
            moveData,
            targetGroupSize,
            color,
            quick)
Parameters:
point - 

moveData - 

targetGroupSize - 

color - 

quick - 


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.

mouseDown

mouseDown(screenPoint)
Parameters:
screenPoint - 


mouseMove

mouseMove(screenPoint)
Parameters:
screenPoint - 


mouseOut

mouseOut(screenPoint)
Parameters:
screenPoint - 


mouseOver

mouseOver(screenPoint)
Parameters:
screenPoint - 


processLogMove0

processLogMove0(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


processLogMove1

processLogMove1(moveIndex,
                data,
                info)
Parameters:
moveIndex - 

data - 

info - 


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,
            mustMoveAgain)
Parameters:
moveData - 

mustMoveAgain - 


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.

showAvailableCaptures

showAvailableCaptures(point,
                      htmlBuilder,
                      moveData,
                      groupPoint,
                      color)
Parameters:
point - 

htmlBuilder - 

moveData - 

groupPoint - 

color - 


showAvailablePlacements

showAvailablePlacements(point,
                        htmlBuilder,
                        moveData,
                        targetGroupSize,
                        color)
Parameters:
point - 

htmlBuilder - 

moveData - 

targetGroupSize - 

color - 


showMovesAndHilites

showMovesAndHilites(hilites)
Parameters:
hilites - 


spaceNotation

spaceNotation(x,
              y)
Parameters:
x - 

y - 


stonePhrase

stonePhrase(count)
Parameters:
count - 


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.

targetFindMinAdjacentGroupSize

targetFindMinAdjacentGroupSize(board)
Parameters:
board - 


targetHasMinAdjacentGroupSize

targetHasMinAdjacentGroupSize(board,
                              size)
Parameters:
board - 

size - 


targetIsClearAndHasNoAdjacentGreaterThan

targetIsClearAndHasNoAdjacentGreaterThan(point,
                                         board,
                                         size)
Parameters:
point - 

board - 

size - 


targetIsGroupSizeGreaterThan

targetIsGroupSizeGreaterThan(point,
                             data,
                             target)
Parameters:
point - 

data - 

target - 


targetSet

targetSet(board)
Parameters:
board -