Package megamek.client.ratgenerator

Class TOCNode

java.lang.Object

megamek.client.ratgenerator.RulesetNode

megamek.client.ratgenerator.TOCNode

public class TOCNode
extends RulesetNode

Contains details about which units and echelon levels are available to this unit in given eras.

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<ValueNode>	echelonNodes
protected ArrayList<ValueNode>	flagNodes
protected ArrayList<ValueNode>	ratingNodes
protected ArrayList<ValueNode>	unitTypeNodes

Fields inherited from class megamek.client.ratgenerator.RulesetNode

assertions, name, predicates

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TOCNode()

Method Summary

Modifier and Type	Method	Description
static TOCNode	createFromXml(Node node)
ValueNode	findEchelons(ForceDescriptor fd)
ValueNode	findFlags(ForceDescriptor fd)
ValueNode	findRatings(ForceDescriptor fd)
ValueNode	findUnitTypes(ForceDescriptor fd)
boolean	isEmpty()	Whether this table of contents offers anything.
protected void	loadFromXml(Node node)
boolean	offersUnitTypes(String faction, int year)	Whether these menus offer a faction any unit type in a year.

Methods inherited from class megamek.client.ratgenerator.RulesetNode

apply, collectionMatchesProperty, getName, matches, matches, matches, matchesDate, matchesPredicate, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

unitTypeNodes

protected ArrayList<ValueNode> unitTypeNodes

echelonNodes

protected ArrayList<ValueNode> echelonNodes

ratingNodes

protected ArrayList<ValueNode> ratingNodes

flagNodes

protected ArrayList<ValueNode> flagNodes

Constructor Details

TOCNode

protected TOCNode()

Method Details

isEmpty

public boolean isEmpty()

Whether this table of contents offers anything. A ruleset file with no <toc> still gets an empty one, which means "use the parent's", not "offer nothing".

Returns:

true when there is no unit type, echelon, rating or flag option at all

offersUnitTypes

public boolean offersUnitTypes(String faction,
 int year)

Whether these menus offer a faction any unit type in a year. The Force Generator leaves out a faction they do not, since it could only show empty menus.

Parameters:

faction - the faction key

year - the year

Returns:

true when at least one unit type option applies

findUnitTypes

public ValueNode findUnitTypes(ForceDescriptor fd)

findEchelons

public ValueNode findEchelons(ForceDescriptor fd)

findRatings

public ValueNode findRatings(ForceDescriptor fd)

findFlags

public ValueNode findFlags(ForceDescriptor fd)

createFromXml

public static TOCNode createFromXml(Node node)

loadFromXml

protected void loadFromXml(Node node)

Overrides:

loadFromXml in class RulesetNode