Skip to content

Reference

tilttek/wargame-army
TypeRole
CatalogueThe data of a game: units, detachment types, detachments taken and constraints; read from and written to arrays and JSON
UnitEntryA unit: categories, points, models and option groups
OptionGroupA choice among options, with its fewest and most selections
OptionAn option: its points, for the unit or each model, and the most times it is taken
DetachmentTypeA kind of detachment: its slots and the most of it an army takes
SlotThe fewest and the most units of a category a detachment takes
ArmyListA list: its catalogue and version, its points limit and its detachments; read from and written to arrays and JSON
DetachmentA detachment of a list: its type, its name and its units
UnitSelectionA unit chosen: its models and its options
CostingThe points of each unit, detachment and list
ArmyValidatorChecks a list against its catalogue, one rule at a time
ValidationEvery violation of a list, with its points
ViolationA rule a list breaks, with its message and values
RuleThe rules a list may break
IdentifiersThe shapes of codes, versions, identifiers and names
Constraint\SelectorOne unit, or the units of a category
Constraint\ScopeThe army, or each detachment
Constraint\UnitCountThe fewest and the most units selected
Constraint\PointsShareThe share of the points limit the units selected cost
Contract\ConstraintA rule a list keeps: the catalogue's, or the application's own
Contract\DeclaredConstraintA constraint a catalogue declares in its data
Contract\CatalogueProviderWhere the application keeps its catalogues
Catalog\InMemoryCatalogueProviderCatalogues in memory
Export\TextExportA list as plain text
Export\HtmlExportA list as a fragment of escaped HTML
Exception\WargameArmyExceptionThe interface of every exception of the library
Exception\InvalidCatalogue, InvalidArmyList, UnknownCatalogueSee Exceptions

ArrayInput, Fault and Export\Sheet are internal.