Class Index | File Index

Classes


Class LocCalculator

LocCalculator
Defined in: locCalculator.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
LocCalculator(Wargame, Force, Terrain, Map)
LocCalculator
Method Summary
Method Attributes Method Name and Description
 
addLocHexagonPoint(locHexagonName, locForceId)
method to add a starting loc hexagon point LocCalculator.prototype.addLocHexagonPoint = function(hexagonPoint, locForceId) {
 
addStartLocHexagon(locHexagonName, locForceId)
method to add a starting loc hexagon point
 
calculateLoc(locForceId)
method to calculate loc LocCalculator.prototype.addLocHexagonPoint = function(hexagonPoint, locForceId) {
 
getForceIdOfHexagonInStartLocArray(hexagonPoint, locForceId)
method to get force id of a hexagon point in the loc array
 
method to get loc array
 
method to get loc array
 
method to get loc array
 
getMapArray2(start, endX, endY)
method to get loc array
 
method to get start loc array
 
hexagonIsInLocArray(hexagonPoint, locForceId)
method to check if a hexagon point is in the loc array
 
hexagonIsInStartLocArray(hexagonPoint, locForceId)
method to check if a hexagon point is in the loc start array
 
hexagonIsNextToLOC(hexagonPoint, locForceId)
method to check if a hexagon point is next to a hexagon point in the loc array
 
hexagonIsStartLOC(hexagonPoint, locForceId)
method to check if a hexagon point is in the start loc array
Class Detail
LocCalculator(Wargame, Force, Terrain, Map)
LocCalculator
Parameters:
Wargame
{object}
Force
{object}
Terrain
{object}
Map
{object}
Method Detail
addLocHexagonPoint(locHexagonName, locForceId)
method to add a starting loc hexagon point LocCalculator.prototype.addLocHexagonPoint = function(hexagonPoint, locForceId) {
Parameters:
locHexagonName
{string} loc hexagon name
locForceId
{string} force name

addStartLocHexagon(locHexagonName, locForceId)
method to add a starting loc hexagon point
Parameters:
locHexagonName
{string} loc hexagon name
locForceId
{string} force name

calculateLoc(locForceId)
method to calculate loc LocCalculator.prototype.addLocHexagonPoint = function(hexagonPoint, locForceId) {
Parameters:
locForceId
{string} force name

{string} getForceIdOfHexagonInStartLocArray(hexagonPoint, locForceId)
method to get force id of a hexagon point in the loc array
Parameters:
hexagonPoint
{point} hexagon point
locForceId
{string} force name
Returns:
{string} forceId

{array} getLoc()
method to get loc array
Returns:
{array} this.locArray

{array} getLocArray()
method to get loc array
Returns:
{array} this.locArray

{array} getMapArray()
method to get loc array
Returns:
{array} hexagonArray

{array} getMapArray2(start, endX, endY)
method to get loc array
Parameters:
start
endX
endY
Returns:
{array} array

{array} getStartLoc()
method to get start loc array
Returns:
{array} this.startLocArray

{boolean} hexagonIsInLocArray(hexagonPoint, locForceId)
method to check if a hexagon point is in the loc array
Parameters:
hexagonPoint
{point} hexagon point
locForceId
{string} force name
Returns:
{boolean} isInLocArray

{boolean} hexagonIsInStartLocArray(hexagonPoint, locForceId)
method to check if a hexagon point is in the loc start array
Parameters:
hexagonPoint
{point} hexagon point
locForceId
{string} force name
Returns:
{boolean} isInStartLocArray

{boolean} hexagonIsNextToLOC(hexagonPoint, locForceId)
method to check if a hexagon point is next to a hexagon point in the loc array
Parameters:
hexagonPoint
{point} hexagon point
locForceId
{string} force name
Returns:
{boolean} isNextToLOC

{boolean} hexagonIsStartLOC(hexagonPoint, locForceId)
method to check if a hexagon point is in the start loc array
Parameters:
hexagonPoint
{point} hexagon point
locForceId
{string} force name
Returns:
{boolean} isStartLOC

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Oct 22 2018 10:31:22 GMT-0700 (PDT)