Class Index | File Index

Classes


Class VictoryCalculator

VictoryCalculator
Defined in: victoryCalculator.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
VictoryCalculator(Wargame, Force, Terrain, Map)
VictoryCalculator
Method Summary
Method Attributes Method Name and Description
 
method to apply phase change rules
 
method to check victory conditions
 
method to get victory info
 
method to get victory status
 
method to check is wargame is over
Class Detail
VictoryCalculator(Wargame, Force, Terrain, Map)
VictoryCalculator
Parameters:
Wargame
{object}
Force
{object}
Terrain
{object}
Map
{object}
Method Detail
applyPhaseChangeRules()
method to apply phase change rules

checkVictoryConditions()
method to check victory conditions

{string} getVictoryInfo(index)
method to get victory info
Parameters:
index
{integer} The unit index in units array
Returns:
{string} victoryInfo

{string} getVictoryStatus()
method to get victory status
Returns:
{string} victoryInfo

{boolean} isWargameOver()
method to check is wargame is over
Returns:
{boolean} wargameIsOver

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