36 lines
1.2 KiB
Plaintext
36 lines
1.2 KiB
Plaintext
|
# ArmyOverview (object)
|
||
|
|
Army object representing both fractions with all their army-squads and army-members
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ BLUFOR (Fraction, required) - BLUFOR fraction object
|
||
|
|
+ OPFOR (Fraction, required) - OPFOR fraction object
|
||
|
|
|
||
|
|
|
||
|
|
# Fraction (object)
|
||
|
|
Single fraction object
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
+ squads (array[ArmySquad], required) - Array containing all squads of the fraction, sorted by 'sortingNumber'
|
||
|
|
+ memberCount: 1 (number, required) - sum of fraction members in all squads
|
||
|
|
|
||
|
|
|
||
|
|
# ArmySquad (object)
|
||
|
|
A single squad as appearing in the army overview
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
+ _id: `59146e6aef2ad810623ed519` (string, required) - the unique id of the squad
|
||
|
|
+ name: `Führungsstab` (string, required) - the squad display name
|
||
|
|
+ members (array[ArmyMember], required) - List of participants being member in this squad
|
||
|
|
+ memberCount: 1 (number, required) - Number of members the squad has
|
||
|
|
|
||
|
|
|
||
|
|
# ArmyMember (object)
|
||
|
|
Unique member in a army squad
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
+ _id: `5918d2ca574b0b16820a0b28` (string, required) - unique id of the army member
|
||
|
|
+ username: `Jagernaut` (string, required) - display name of the army member
|
||
|
|
+ rank: `General` (string, required) - display name of the rank which is assigned to this army member
|