35 lines
1.3 KiB
Plaintext
35 lines
1.3 KiB
Plaintext
|
# BasicPlayer (object)
|
||
|
|
||
|
Basic player statistic information object
|
||
|
|
||
|
##Properties
|
||
|
+ name: `Jagernaut` (string, required) - the displayed username of the army member
|
||
|
+ fraction: `OPFOR` (string, required) - fraction of the player
|
||
|
+ kill: 5 (number, required) - sum of kills
|
||
|
+ friendlyFire: 0 (number, required) - sum of friendly fire kills
|
||
|
+ vehicle: 1 (number, required) - sum of vehicle kills
|
||
|
+ death: 3 (number, required) - sum of deaths
|
||
|
+ respawn: 2 (number, required) - sum of respawns
|
||
|
+ flagTouch: 1 (number, required) - sum of flag captures
|
||
|
+ revive: 0 (number, required) - sum of revives
|
||
|
|
||
|
|
||
|
# CampaignPlayer (BasicPlayer)
|
||
|
A player campaign statistics object
|
||
|
|
||
|
## Properties
|
||
|
+ _id: `5ab68d42f547ed304064e5f7` (string, required) - unique id of the army member
|
||
|
+ warId: `5abf65ae3fc5fa349ffd5ca3` (string, required) - war in which this player took part
|
||
|
+ steamUUID: `76561192214911200` (string, required) - unique ID for STEAM platform account
|
||
|
+ sort: 1 (number, required) - sorting number calculated by (kill + revive + flagTouch - friendlyFire - death - respawn)
|
||
|
+ timestamp: `2018-02-24T01:01:25.825Z` - the entity creation timestamp
|
||
|
+ updatedAt: `2018-02-24T01:01:25.825Z` - the version timestamp
|
||
|
+ __v: 0 (number, required) - the version number of the object
|
||
|
|
||
|
|
||
|
# HighscorePlayer (BasicPlayer)
|
||
|
A player object as resturned for the highscore arrays
|
||
|
|
||
|
## Properties
|
||
|
+ num: 1
|