opt-cc/server/apib/data_structures/_player.apib

40 lines
1.7 KiB
Plaintext
Raw Normal View History

2018-03-31 19:23:49 +02:00
# 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
2018-04-15 13:47:48 +02:00
+ vehicleLight: 1 (number, required) - sum of light vehicle kills
+ vehicleHeavy: 1 (number, required) - sum of heavy vehicle kills
+ vehicleAir: 0 (number, required) - sum of air vehicle kills
2018-03-31 19:23:49 +02:00
+ 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
+ travelDistance: 16535 (number, optional) - sum of transport meters as passenger
+ driverDistance: 1250 (number, optional) - sum of transport meters as pilot/driver
2018-03-31 19:23:49 +02:00
2018-04-01 10:59:09 +02:00
# WarPlayer (BasicPlayer)
2018-03-31 19:23:49 +02:00
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
2019-02-10 11:01:11 +01:00
+ steamUUID: 76561192214911200 (number, optional) - unique ID for STEAM platform account
+ performance: `5abf65ae3fc5fa349ffd5cs2` (string, optional) - id of corresponding performance log entry
2018-03-31 19:23:49 +02:00
+ 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)
2019-02-10 11:01:11 +01:00
A player object as returned for the highscore arrays
2018-03-31 19:23:49 +02:00
## Properties
2019-02-10 11:01:11 +01:00
+ warId: War (War, required) - war in which this player took part
2018-03-31 19:23:49 +02:00
+ num: 1