File: Games\Politics\Game.js

GamesByEmail
Class PoliticsTerritory

Object
  
 
 
GamesByEmail.Territory
      
 
 
GamesByEmail.PoliticsTerritory

All Implemented Interfaces:

Class

GamesByEmail.PoliticsTerritory

extends Territory

Constructor Summary
GamesByEmail.PoliticsTerritory(/*Territories*/ territories, /*Number*/ index, /*String*/ indexString, /*Game*/ game, /*Object*/ territory)
Creates a territory.

Enum Summary
static  UNIT_LOCATION

Field Summary

Fields inherited from GamesByEmail.Territory
adjacent, adjacentIndices, color, game, index, indexString, polygon, territories, title

Method Summary
 addConvoyRoutes(toTerritory, routeList, route)
 addIdleOrder(color)
 addStandOrder(color)
 addToConvoyOriginList(tList)
StringBuilderappendOverlayHtml(/*StringBuilder*/ htmlBuilder)
Override to add HTML that shows above the territory.
 buildUnit(color, unitType, coast)
 calculateProximityToHome()
 canConvoyTo(toTerritory)
 canConvoyToCheck(toTerritory)
 canRetreatHere(toTerritory, coast)
 checkHealth()
 clearAttackerFrom()
 clearConvoyRouteChecked()
 clearOrder()
 clearStandoff()
 clearUnit(dislodged)
 clearUnits()
 closeAvailableOrdersBox(order)
 copyCoasts()
 couldBeConvoyedByOurUnits()
 couldBeConvoyedTo(toTerritory)
 couldBeMovedTo(toTerritory)
 couldParticipateInConvoy(fromTerritory, toTerritory)
 dispose()
 eliminateIdleOrder(color)
 eliminateStandOrder(color)
 findMoveHereOrder(bestTeam, butNotFromHere)
 getAttackOrderList()
 getAvailableOrdersHtml()
 getBuildImagesHtml(pieceSrc, color, unitType, coast)
 getBuildInfoFromPoint(point)
 getBuildOrderList()
 getClosestCoast(point)
 getConvoyDestinationList()
 getConvoyOriginList()
 getDisbandImagesHtml(pieceSrc)
 getDisolveOrderList()
 getHasOurOrders()
 getHasOurUnit(dislodged)
 getHasUnit(dislodged)
 getHoldImagesHtml(pieceSrc, color, isSuccessful)
 getIdleImagesHtml(pieceSrc, color)
 getIsArmy(dislodged)
 getIsFleet(dislodged)
 getListOfConvoyRoutes(toTerritory)
 getListOfConvoyTerritories(toTerritory)
 getMusterPoint()
 getNotation(includePassFail)
 getOrderImageCoastChar(coast, unitType, dislodged)
 getOrderIndex(dislodged)
 getOrderList()
 getOrderTeam()
 getOrderUnit(dislodged)
 getOverlayImageSrc()
 getPieceImage(dislodged)
 getPossibleAttackerList()
 getRetreatOrderList(anyColor)
 getTeam()
 getUnitAdjacentIndices(dislodged)
 getUnitTargetCoast(fromT, point, dislodged)
 getUnitTeam(dislodged)
 getValue()
 isColorBuildingUnit(color)
 isColorDisolvingUnit(color)
 isColorsBuildableSupply(color, occupiedOk)
 isColorsSupply(color)
 isColorsUnit(color, dislodged)
 isInConvoyList(territories)
 isMoveToTerritoryOrder(toTerritory)
 isOrphanedByOurConvoyUnits(toTerritory)
 isOurBuildableSupply()
 isUnitAdjacent(territory, dislodged, coast)
 isUnitAdjacentToIndex(index, dislodged, coast)
 isWaterAdjacentToTerritory(territory)
 moveUnit(toTerritory, coast)
 orderDescriptionHtml(coast, unitType)
 orderUnitImageHtml()
 receiveUnit(coast, color, isFleet, attackerFrom)
 removeUnit(dislodged)
 resetOrder()
 setAttackerFrom(attackerFrom)
 setCaptured()
 setDefaultOrder()
 setHoldingColor(color)
 setOrderByNotation(notation)
 setStandoff(standoff)
 setUnit(color, locationIndex, dislodged)
 setUnitByNotation(notation)
 setValue(value)
 shortOrderDescriptionHtml(orders)
 showHiliteIfHasOurDislodgedUnits()
 showHiliteIfHasOurOrders()
 showHiliteIfHasOurUnits()
 showHiliteIfIsOurBuildableSupply()
 unitTeamPlaying(dislodged)
 update()
 updateColor()
 updateUnit(dislodged)

Methods inherited from GamesByEmail.Territory
appendHtml, containsPoint, event, hideHilite, isColor, isOurs, setBlink, showHilite, showHiliteIfOurs

Methods inherited from Foundation.Class
getTypePath, isInstanceOf

Constructor Detail

PoliticsTerritory

GamesByEmail.PoliticsTerritory(/*Territories*/ territories,
                               /*Number*/ index,
                               /*String*/ indexString,
                               /*Game*/ game,
                               /*Object*/ territory)

Creates a territory.

Parameters: 
territories -
The parent territories collection.
index -
The position of this piece in the parent pieces object.
indexString -
The zero-padded index string of the position of this piece in the parent pieces object.
game -
The game this territory is in.
territory -
The data for this territory to inherit.

Enum Detail

UNIT_LOCATION

static UNIT_LOCATION
Values: 
COAST_0 - 

COAST_1 - 

TERRITORY -

Method Detail

addConvoyRoutes

addConvoyRoutes(toTerritory,
                routeList,
                route)
Parameters: 
toTerritory - 

routeList - 

route -

addIdleOrder

addIdleOrder(color)
Parameters: 
color -

addStandOrder

addStandOrder(color)
Parameters: 
color -

addToConvoyOriginList

addToConvoyOriginList(tList)
Parameters: 
tList -

appendOverlayHtml

StringBuilder appendOverlayHtml(/*StringBuilder*/ htmlBuilder)

Override to add HTML that shows above the territory.

Overrides:
appendOverlayHtml in class Territory
Parameters: 
htmlBuilder -
The builder to append the HTML for the territory.
Returns:
The string builder.

buildUnit

buildUnit(color,
          unitType,
          coast)
Parameters: 
color - 

unitType - 

coast -

calculateProximityToHome

calculateProximityToHome()

canConvoyTo

canConvoyTo(toTerritory)
Parameters: 
toTerritory -

canConvoyToCheck

canConvoyToCheck(toTerritory)
Parameters: 
toTerritory -

canRetreatHere

canRetreatHere(toTerritory,
               coast)
Parameters: 
toTerritory - 

coast -

checkHealth

checkHealth()

clearAttackerFrom

clearAttackerFrom()

clearConvoyRouteChecked

clearConvoyRouteChecked()

clearOrder

clearOrder()

clearStandoff

clearStandoff()

clearUnit

clearUnit(dislodged)
Parameters: 
dislodged -

clearUnits

clearUnits()

closeAvailableOrdersBox

closeAvailableOrdersBox(order)
Parameters: 
order -

copyCoasts

copyCoasts()

couldBeConvoyedByOurUnits

couldBeConvoyedByOurUnits()

couldBeConvoyedTo

couldBeConvoyedTo(toTerritory)
Parameters: 
toTerritory -

couldBeMovedTo

couldBeMovedTo(toTerritory)
Parameters: 
toTerritory -

couldParticipateInConvoy

couldParticipateInConvoy(fromTerritory,
                         toTerritory)
Parameters: 
fromTerritory - 

toTerritory -

dispose

dispose()
Overrides:
dispose in class Territory

eliminateIdleOrder

eliminateIdleOrder(color)
Parameters: 
color -

eliminateStandOrder

eliminateStandOrder(color)
Parameters: 
color -

findMoveHereOrder

findMoveHereOrder(bestTeam,
                  butNotFromHere)
Parameters: 
bestTeam - 

butNotFromHere -

getAttackOrderList

getAttackOrderList()

getAvailableOrdersHtml

getAvailableOrdersHtml()

getBuildImagesHtml

getBuildImagesHtml(pieceSrc,
                   color,
                   unitType,
                   coast)
Parameters: 
pieceSrc - 

color - 

unitType - 

coast -

getBuildInfoFromPoint

getBuildInfoFromPoint(point)
Parameters: 
point -

getBuildOrderList

getBuildOrderList()

getClosestCoast

getClosestCoast(point)
Parameters: 
point -

getConvoyDestinationList

getConvoyDestinationList()

getConvoyOriginList

getConvoyOriginList()

getDisbandImagesHtml

getDisbandImagesHtml(pieceSrc)
Parameters: 
pieceSrc -

getDisolveOrderList

getDisolveOrderList()

getHasOurOrders

getHasOurOrders()

getHasOurUnit

getHasOurUnit(dislodged)
Parameters: 
dislodged -

getHasUnit

getHasUnit(dislodged)
Parameters: 
dislodged -

getHoldImagesHtml

getHoldImagesHtml(pieceSrc,
                  color,
                  isSuccessful)
Parameters: 
pieceSrc - 

color - 

isSuccessful -

getIdleImagesHtml

getIdleImagesHtml(pieceSrc,
                  color)
Parameters: 
pieceSrc - 

color -

getIsArmy

getIsArmy(dislodged)
Parameters: 
dislodged -

getIsFleet

getIsFleet(dislodged)
Parameters: 
dislodged -

getListOfConvoyRoutes

getListOfConvoyRoutes(toTerritory)
Parameters: 
toTerritory -

getListOfConvoyTerritories

getListOfConvoyTerritories(toTerritory)
Parameters: 
toTerritory -

getMusterPoint

getMusterPoint()

getNotation

getNotation(includePassFail)
Parameters: 
includePassFail -

getOrderImageCoastChar

getOrderImageCoastChar(coast,
                       unitType,
                       dislodged)
Parameters: 
coast - 

unitType - 

dislodged -

getOrderIndex

getOrderIndex(dislodged)
Parameters: 
dislodged -

getOrderList

getOrderList()

getOrderTeam

getOrderTeam()

getOrderUnit

getOrderUnit(dislodged)
Parameters: 
dislodged -

getOverlayImageSrc

getOverlayImageSrc()

getPieceImage

getPieceImage(dislodged)
Parameters: 
dislodged -

getPossibleAttackerList

getPossibleAttackerList()

getRetreatOrderList

getRetreatOrderList(anyColor)
Parameters: 
anyColor -

getTeam

getTeam()

getUnitAdjacentIndices

getUnitAdjacentIndices(dislodged)
Parameters: 
dislodged -

getUnitTargetCoast

getUnitTargetCoast(fromT,
                   point,
                   dislodged)
Parameters: 
fromT - 

point - 

dislodged -

getUnitTeam

getUnitTeam(dislodged)
Parameters: 
dislodged -

getValue

getValue()

isColorBuildingUnit

isColorBuildingUnit(color)
Parameters: 
color -

isColorDisolvingUnit

isColorDisolvingUnit(color)
Parameters: 
color -

isColorsBuildableSupply

isColorsBuildableSupply(color,
                        occupiedOk)
Parameters: 
color - 

occupiedOk -

isColorsSupply

isColorsSupply(color)
Parameters: 
color -

isColorsUnit

isColorsUnit(color,
             dislodged)
Parameters: 
color - 

dislodged -

isInConvoyList

isInConvoyList(territories)
Parameters: 
territories -

isMoveToTerritoryOrder

isMoveToTerritoryOrder(toTerritory)
Parameters: 
toTerritory -

isOrphanedByOurConvoyUnits

isOrphanedByOurConvoyUnits(toTerritory)
Parameters: 
toTerritory -

isOurBuildableSupply

isOurBuildableSupply()

isUnitAdjacent

isUnitAdjacent(territory,
               dislodged,
               coast)
Parameters: 
territory - 

dislodged - 

coast -

isUnitAdjacentToIndex

isUnitAdjacentToIndex(index,
                      dislodged,
                      coast)
Parameters: 
index - 

dislodged - 

coast -

isWaterAdjacentToTerritory

isWaterAdjacentToTerritory(territory)
Parameters: 
territory -

moveUnit

moveUnit(toTerritory,
         coast)
Parameters: 
toTerritory - 

coast -

orderDescriptionHtml

orderDescriptionHtml(coast,
                     unitType)
Parameters: 
coast - 

unitType -

orderUnitImageHtml

orderUnitImageHtml()

receiveUnit

receiveUnit(coast,
            color,
            isFleet,
            attackerFrom)
Parameters: 
coast - 

color - 

isFleet - 

attackerFrom -

removeUnit

removeUnit(dislodged)
Parameters: 
dislodged -

resetOrder

resetOrder()

setAttackerFrom

setAttackerFrom(attackerFrom)
Parameters: 
attackerFrom -

setCaptured

setCaptured()

setDefaultOrder

setDefaultOrder()

setHoldingColor

setHoldingColor(color)
Parameters: 
color -

setOrderByNotation

setOrderByNotation(notation)
Parameters: 
notation -

setStandoff

setStandoff(standoff)
Parameters: 
standoff -

setUnit

setUnit(color,
        locationIndex,
        dislodged)
Parameters: 
color - 

locationIndex - 

dislodged -

setUnitByNotation

setUnitByNotation(notation)
Parameters: 
notation -

setValue

setValue(value)
Parameters: 
value -

shortOrderDescriptionHtml

shortOrderDescriptionHtml(orders)
Parameters: 
orders -

showHiliteIfHasOurDislodgedUnits

showHiliteIfHasOurDislodgedUnits()

showHiliteIfHasOurOrders

showHiliteIfHasOurOrders()

showHiliteIfHasOurUnits

showHiliteIfHasOurUnits()

showHiliteIfIsOurBuildableSupply

showHiliteIfIsOurBuildableSupply()

unitTeamPlaying

unitTeamPlaying(dislodged)
Parameters: 
dislodged -

update

update()

updateColor

updateColor()

updateUnit

updateUnit(dislodged)
Parameters: 
dislodged -