Add descriptions for log instance variables
parent
4d50a9a5c0
commit
d2c5850a3d
|
@ -7,9 +7,9 @@
|
||||||
|
|
||||||
# LogPoints (Log)
|
# LogPoints (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ ptBlufor: 2 (number, required) -
|
+ ptBlufor: 2 (number, required) - standings for BLUFOR
|
||||||
+ ptOpfor: 4 (number, required) -
|
+ ptOpfor: 4 (number, required) - standings for OPFOR
|
||||||
+ fraction: `OPFOR` (enum, required)
|
+ fraction: `OPFOR` (enum, required) - dominating fraction
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
@ -17,28 +17,28 @@
|
||||||
|
|
||||||
#LogBudget (Log)
|
#LogBudget (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ oldBudget: 400000 (number, required)
|
+ oldBudget: 400000 (number, required) - budget before buy action
|
||||||
+ newBudget: 380000 (number, required)
|
+ newBudget: 380000 (number, required) - budget after buy action
|
||||||
+ fraction: `BLUFOR` (enum, required)
|
+ fraction: `BLUFOR` (enum, required) - buying fraction
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
|
||||||
#LogFlag (Log)
|
#LogFlag (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ player: `HardiReady` (string, required)
|
+ player: `HardiReady` (string, required) - name of player who captured/secured flag
|
||||||
+ capture: true (boolean, required)
|
+ capture: true (boolean, required) - true if flag was captured, false if it was secured
|
||||||
+ flagFraction: `BLUFOR` (enum, required)
|
+ flagFraction: `BLUFOR` (enum, required) - fraction who owns the flag
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
|
||||||
#LogKill (Log)
|
#LogKill (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ shooter: `HardiReady` (string, required)
|
+ shooter: `HardiReady` (string, required) - name of player who made the kill
|
||||||
+ target: `KalleK` (string, required)
|
+ target: `KalleK` (string, required) - name of player which got killed
|
||||||
+ friendlyFire: true (boolean, required)
|
+ friendlyFire: true (boolean, required) - true if it was a friendly fire kill, false if it was a normal kill
|
||||||
+ fraction: `BLUFOR` (enum, required)
|
+ fraction: `BLUFOR` (enum, required) - fraction of shooter
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
@ -46,33 +46,33 @@
|
||||||
|
|
||||||
#LogRespawn (Log)
|
#LogRespawn (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ player: `radical1976` (string, required)
|
+ player: `radical1976` (string, required) - name of the player who respawns
|
||||||
|
|
||||||
#LogRevive (Log)
|
#LogRevive (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ medic: `radical1976` (string, required)
|
+ medic: `radical1976` (string, required) - name of the player who revives/stabilizes
|
||||||
+ patient: `radical1976` (string, required)
|
+ patient: `HardiReady` (string, required) - name of the player who is revived/stabilized
|
||||||
+ stabilized: false (boolean, required)
|
+ stabilized: false (boolean, required) - false if it is a revive, true if it is stabilizing
|
||||||
+ flagFraction: `BLUFOR` (enum, required)
|
+ fraction: `BLUFOR` (enum, required) - fraction of the medic
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
|
||||||
#LogTransport (Log)
|
#LogTransport (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ driver: `radical1976` (string, required)
|
+ driver: `radical1976` (string, required) - name of the vehicle driver/pilot
|
||||||
+ passenger: `radical1976` (string, required)
|
+ passenger: `radical1976` (string, required) - name of the passenger being transported
|
||||||
+ distance: 2435 (number, required)
|
+ distance: 2435 (number, required) - distance of transport in meters
|
||||||
+ flagFraction: `BLUFOR` (enum, required)
|
+ fraction: `BLUFOR` (enum, required) - fraction of the driver
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
|
||||||
#LogVehicle (Log)
|
#LogVehicle (Log)
|
||||||
## Properties
|
## Properties
|
||||||
+ shooter: `HardiReady` (string, required)
|
+ shooter: `HardiReady` (string, required) - name of player who shot the vehicle
|
||||||
+ target: `Murda]X[` (string, required)
|
+ target: `T-100` (string, required) - name of the vehicle
|
||||||
+ fraction: `BLUFOR` (enum, required)
|
+ fraction: `BLUFOR` (enum, required) - fraction of the shooter
|
||||||
+ Members
|
+ Members
|
||||||
+ `BLUFOR`
|
+ `BLUFOR`
|
||||||
+ `OPFOR`
|
+ `OPFOR`
|
||||||
|
|
Loading…
Reference in New Issue