From d2c5850a3d76db7799ed0847d8254ad42ed48d10 Mon Sep 17 00:00:00 2001
From: HardiReady <hardi@noarch.de>
Date: Mon, 2 Apr 2018 10:02:02 +0200
Subject: [PATCH] Add descriptions for log instance variables

---
 api/apib/data_structures/_log.apib | 50 +++++++++++++++---------------
 1 file changed, 25 insertions(+), 25 deletions(-)

diff --git a/api/apib/data_structures/_log.apib b/api/apib/data_structures/_log.apib
index 6efebd3..6feca45 100644
--- a/api/apib/data_structures/_log.apib
+++ b/api/apib/data_structures/_log.apib
@@ -7,9 +7,9 @@
 
 # LogPoints (Log)
 ## Properties
-+ ptBlufor: 2 (number, required) -
-+ ptOpfor: 4 (number, required) -
-+ fraction: `OPFOR` (enum, required)
++ ptBlufor: 2 (number, required) - standings for BLUFOR
++ ptOpfor: 4 (number, required) - standings for OPFOR
++ fraction: `OPFOR` (enum, required) - dominating fraction
         + Members
             + `BLUFOR`
             + `OPFOR`
@@ -17,28 +17,28 @@
 
 #LogBudget (Log)
 ## Properties
-+ oldBudget: 400000 (number, required)
-+ newBudget: 380000 (number, required)
-+ fraction: `BLUFOR` (enum, required)
++ oldBudget: 400000 (number, required) - budget before buy action
++ newBudget: 380000 (number, required) - budget after buy action
++ fraction: `BLUFOR` (enum, required) - buying fraction
         + Members
             + `BLUFOR`
             + `OPFOR`
 
 #LogFlag (Log)
 ## Properties
-+ player: `HardiReady` (string, required)
-+ capture: true (boolean, required)
-+ flagFraction: `BLUFOR` (enum, required)
++ player: `HardiReady` (string, required) - name of player who captured/secured flag
++ capture: true (boolean, required) - true if flag was captured, false if it was secured
++ flagFraction: `BLUFOR` (enum, required) - fraction who owns the flag
         + Members
             + `BLUFOR`
             + `OPFOR`
 
 #LogKill (Log)
 ## Properties
-+ shooter: `HardiReady` (string, required)
-+ target: `KalleK` (string, required)
-+ friendlyFire: true (boolean, required)
-+ fraction: `BLUFOR` (enum, required)
++ shooter: `HardiReady` (string, required) - name of player who made the kill
++ target: `KalleK` (string, required) - name of player which got killed
++ friendlyFire: true (boolean, required) - true if it was a friendly fire kill, false if it was a normal kill
++ fraction: `BLUFOR` (enum, required) - fraction  of shooter
         + Members
             + `BLUFOR`
             + `OPFOR`
@@ -46,33 +46,33 @@
 
 #LogRespawn (Log)
 ## Properties
-+ player: `radical1976` (string, required)
++ player: `radical1976` (string, required) - name of the player who respawns
 
 #LogRevive (Log)
 ## Properties
-+ medic: `radical1976` (string, required)
-+ patient: `radical1976` (string, required)
-+ stabilized: false (boolean, required)
-+ flagFraction: `BLUFOR` (enum, required)
++ medic: `radical1976` (string, required) - name of the player who revives/stabilizes
++ patient: `HardiReady` (string, required) - name of the player who is revived/stabilized
++ stabilized: false (boolean, required) - false if it is a revive, true if it is stabilizing
++ fraction: `BLUFOR` (enum, required) - fraction of the medic
         + Members
             + `BLUFOR`
             + `OPFOR`
 
 #LogTransport (Log)
 ## Properties
-+ driver: `radical1976` (string, required)
-+ passenger: `radical1976` (string, required)
-+ distance: 2435 (number, required)
-+ flagFraction: `BLUFOR` (enum, required)
++ driver: `radical1976` (string, required) - name of the vehicle driver/pilot
++ passenger: `radical1976` (string, required) - name of the passenger being transported
++ distance: 2435 (number, required) - distance of transport in meters
++ fraction: `BLUFOR` (enum, required) - fraction of the driver
         + Members
             + `BLUFOR`
             + `OPFOR`
 
 #LogVehicle (Log)
 ## Properties
-+ shooter: `HardiReady` (string, required)
-+ target: `Murda]X[` (string, required)
-+ fraction: `BLUFOR` (enum, required)
++ shooter: `HardiReady` (string, required) - name of player who shot the vehicle
++ target: `T-100` (string, required) - name of the vehicle
++ fraction: `BLUFOR` (enum, required) - fraction of the shooter
         + Members
             + `BLUFOR`
             + `OPFOR`