File: Games\Politics\Game.js

GamesByEmail
Class PoliticsTerritories

Array
  
 
 
GamesByEmail.Territories
      
 
 
GamesByEmail.PoliticsTerritories

All Implemented Interfaces:

Class

GamesByEmail.PoliticsTerritories

extends Territories

Constructor Summary
GamesByEmail.PoliticsTerritories(/*Game*/ game, /*Class*/ territoryClass, /*Array*/ territories)
Creates a territory collection.

Field Summary

Fields inherited from GamesByEmail.Territories
game

Fields inherited from Array
length

Method Summary
 addIdleOrders(color)
 addMissingDisbandOrders(orders)
 addMissingDisolveOrders(orders)
 addMissingHoldOrders(orders)
 addStandOrders(color)
 anyHasUnits(dislodged)
StringBuilderappendOverlayHtml(/*StringBuilder*/ htmlBuilder)
Override to add HTML that shows above all the territories.
 checkHealth()
 clearAttackerFroms()
 clearConvoyRouteChecked()
 clearOrders()
 clearStandoffs()
 clearUnits()
 colorHasBuildsOrDisolveChoiceAvailable(color)
 colorHasRetreatsAvailable(color)
 colorHasUnits(color, dislodged)
 colorOnlyHasDefaultOrders(color)
 countBuildableSupplyCenters(color, occupiedOk)
 countNumUnitsBeingBuilt(color)
 countNumUnitsBeingDisolved(color)
 countSupplyCenters(color)
 countUnits(color, dislodged)
 dispose()
 eliminateIdleOrders(color)
 eliminateStandOrders(color)
 findMoveToTerritoryOrders(toTerritory, butNotFromHere)
 getAdjacentFromIndex(index, water)
 getColorUnitsByHomeProximity(color)
 getMissingOrders(forced)
 getNotation(includePassFail)
 getOrders(color)
 getTerritoryFromOrder(order)
 getValue()
 resetOrders()
 setByNotation(notation)
 setCaptured()
 setDefaultOrders()
 setOrders(orders)
 setValue(value)
 update()

Methods inherited from GamesByEmail.Territories
appendHtml, clearMouseEvents, findAtPoint, hideHilites

Methods inherited from Array
indexOf

Methods inherited from Foundation.Class
getTypePath, isInstanceOf

Constructor Detail

PoliticsTerritories

GamesByEmail.PoliticsTerritories(/*Game*/ game,
                                 /*Class*/ territoryClass,
                                 /*Array*/ territories)

Creates a territory collection.

Parameters: 
game -
The parent game object.
territoryClass -
The class to use for individual territories.
territories -
The data for the territories to inherit.

Method Detail

addIdleOrders

addIdleOrders(color)
Parameters: 
color -

addMissingDisbandOrders

addMissingDisbandOrders(orders)
Parameters: 
orders -

addMissingDisolveOrders

addMissingDisolveOrders(orders)
Parameters: 
orders -

addMissingHoldOrders

addMissingHoldOrders(orders)
Parameters: 
orders -

addStandOrders

addStandOrders(color)
Parameters: 
color -

anyHasUnits

anyHasUnits(dislodged)
Parameters: 
dislodged -

appendOverlayHtml

StringBuilder appendOverlayHtml(/*StringBuilder*/ htmlBuilder)

Override to add HTML that shows above all the territories.

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

checkHealth

checkHealth()

clearAttackerFroms

clearAttackerFroms()

clearConvoyRouteChecked

clearConvoyRouteChecked()

clearOrders

clearOrders()

clearStandoffs

clearStandoffs()

clearUnits

clearUnits()

colorHasBuildsOrDisolveChoiceAvailable

colorHasBuildsOrDisolveChoiceAvailable(color)
Parameters: 
color -

colorHasRetreatsAvailable

colorHasRetreatsAvailable(color)
Parameters: 
color -

colorHasUnits

colorHasUnits(color,
              dislodged)
Parameters: 
color - 

dislodged -

colorOnlyHasDefaultOrders

colorOnlyHasDefaultOrders(color)
Parameters: 
color -

countBuildableSupplyCenters

countBuildableSupplyCenters(color,
                            occupiedOk)
Parameters: 
color - 

occupiedOk -

countNumUnitsBeingBuilt

countNumUnitsBeingBuilt(color)
Parameters: 
color -

countNumUnitsBeingDisolved

countNumUnitsBeingDisolved(color)
Parameters: 
color -

countSupplyCenters

countSupplyCenters(color)
Parameters: 
color -

countUnits

countUnits(color,
           dislodged)
Parameters: 
color - 

dislodged -

dispose

dispose()
Overrides:
dispose in class Territories

eliminateIdleOrders

eliminateIdleOrders(color)
Parameters: 
color -

eliminateStandOrders

eliminateStandOrders(color)
Parameters: 
color -

findMoveToTerritoryOrders

findMoveToTerritoryOrders(toTerritory,
                          butNotFromHere)
Parameters: 
toTerritory - 

butNotFromHere -

getAdjacentFromIndex

getAdjacentFromIndex(index,
                     water)
Parameters: 
index - 

water -

getColorUnitsByHomeProximity

getColorUnitsByHomeProximity(color)
Parameters: 
color -

getMissingOrders

getMissingOrders(forced)
Parameters: 
forced -

getNotation

getNotation(includePassFail)
Parameters: 
includePassFail -

getOrders

getOrders(color)
Parameters: 
color -

getTerritoryFromOrder

getTerritoryFromOrder(order)
Parameters: 
order -

getValue

getValue()

resetOrders

resetOrders()

setByNotation

setByNotation(notation)
Parameters: 
notation -

setCaptured

setCaptured()

setDefaultOrders

setDefaultOrders()

setOrders

setOrders(orders)
Parameters: 
orders -

setValue

setValue(value)
Parameters: 
value -

update

update()