Lots of changes done...

Change trace prototypes.
Change DCS class prototypes
This commit is contained in:
FlightControl
2016-03-28 22:54:31 +02:00
parent 8eab8622c6
commit 260f109e40
40 changed files with 1251 additions and 1073 deletions

View File

@@ -1,9 +1,10 @@
-------------------------------------------------------------------------------
-- @module Airbase
-- @extends CoalitionObject#CoalitionObject
-- @module DCSAirbase
--- Represents airbases: airdromes, helipads and ships with flying decks or landing pads.
-- @type Airbase
-- @extends DCSCoalitionObject#CoalitionObject
-- @field #Airbase.ID ID Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not.
-- @field #Airbase.Category Category enum contains identifiers of airbase categories.
-- @field #Airbase.Desc Desc Airbase descriptor. Airdromes are unique and their types are unique, but helipads and ships are not always unique and may have the same type.

View File

@@ -1,8 +1,8 @@
-------------------------------------------------------------------------------
-- @module CoalitionObject
-- @extends Object#Object
-- @module DCSCoalitionObject
--- @type CoalitionObject
-- @extends DCSObject#Object
--- Returns coalition of the object.
-- @function [parent=#CoalitionObject] getCoalition

View File

@@ -1,6 +1,5 @@
-------------------------------------------------------------------------------
-- @module Controller
-- TODO Add Task templates
-- @module DCSController
--- Controller is an object that performs A.I.-routines. Other words controller is an instance of A.I.. Controller stores current main task, active enroute tasks and behavior options. Controller performs commands. Please, read DCS A-10C GUI Manual EN.pdf chapter "Task Planning for Unit Groups", page 91 to understand A.I. system of DCS:A-10C.
--

View File

@@ -1,6 +1,5 @@
-------------------------------------------------------------------------------
-- @module Group
-- @module DCSGroup
--- Represents group of Units.
-- @type Group
@@ -17,66 +16,67 @@
-- Static Functions
--- Returns group by the name assigned to the group in Mission Editor.
-- @function [parent=#Airbase] getByName
-- @function [parent=#Group] getByName
-- @param #string name
-- @return #Group
-- Member Functions
--- returns true if the group exist or false otherwise.
-- @function [parent=#Airbase] isExist
-- @param self
-- @function [parent=#Group] isExist
-- @param #Group self
-- @return #boolean
--- Destroys the group and all of its units.
-- @function [parent=#Airbase] destroy
-- @param self
-- @function [parent=#Group] destroy
-- @param #Group self
--- Returns category of the group.
-- @function [parent=#Airbase] getCategory
-- @param self
-- @function [parent=#Group] getCategory
-- @param #Group self
-- @return #Group.Category
--TODO check coalition.side
--- Returns coalition of the group.
-- @function [parent=#Airbase] getCoalition
-- @param self
-- @function [parent=#Group] getCoalition
-- @param #Group self
-- @return #coalition.side
--- Returns the group's name. This is the same name assigned to the group in Mission Editor.
-- @function [parent=#Airbase] getName
-- @param self
-- @function [parent=#Group] getName
-- @param #Group self
-- @return #string
--- Returns the group identifier.
-- @function [parent=#Airbase] getID
-- @param self
-- @function [parent=#Group] getID
-- @param #Group self
-- @return #ID
--- Returns the unit with number unitNumber. If the unit is not exists the function will return nil.
-- @function [parent=#Airbase] getUnit
-- @param self
-- @function [parent=#Group] getUnit
-- @param #Group self
-- @param #number unitNumber
-- @return Unit#Unit
-- @return DCSUnit#Unit
--- Returns current size of the group. If some of the units will be destroyed, As units are destroyed the size of the group will be changed.
-- @function [parent=#Airbase] getSize
-- @param self
-- @function [parent=#Group] getSize
-- @param #Group self
-- @return #number
--- Returns initial size of the group. If some of the units will be destroyed, initial size of the group will not be changed. Initial size limits the unitNumber parameter for Group.getUnit() function.
-- @function [parent=#Airbase] getInitialSize
-- @param self
-- @function [parent=#Group] getInitialSize
-- @param #Group self
-- @return #number
--- Returns array of the units present in the group now. Destroyed units will not be enlisted at all.
-- @function [parent=#Airbase] getUnits
-- @param self
-- @return #list<Unit#Unit> array of Units
-- @function [parent=#Group] getUnits
-- @param #Group self
-- @return #list<DCSUnit#Unit> array of Units
--- Returns controller of the group.
-- @function [parent=#Airbase] getController
-- @param self
-- @function [parent=#Group] getController
-- @param #Group self
-- @return Controller#Controller
Group = {} --#Group

View File

@@ -1,5 +1,5 @@
-------------------------------------------------------------------------------
-- @module Object
-- @module DCSObject
--- @type Object
-- @field #Object.Category Category
@@ -18,55 +18,55 @@
-- @field #Box3 box bounding box of collision geometry
--- @function [parent=#Object] isExist
-- @param self
-- @param #Object self
-- @return #boolean
--- @function [parent=#Object] destroy
-- @param self
-- @param #Object self
--- @function [parent=#Object] getCategory
-- @param self
-- @param #Object self
-- @return #Object.Category
--- Returns type name of the Object.
-- @function [parent=#Object] getTypeName
-- @param self
-- @param #Object self
-- @return #string
--- Returns object descriptor.
-- @function [parent=#Object] getDesc
-- @param self
-- @param #Object self
-- @return #Object.Desc
--- Returns true if the object belongs to the category.
-- @function [parent=#Object] hasAttribute
-- @param self
-- @param #Object self
-- @param #AttributeName attributeName Attribute name to check.
-- @return #boolean
--- Returns name of the object. This is the name that is assigned to the object in the Mission Editor.
-- @function [parent=#Object] getName
-- @param self
-- @param #Object self
-- @return #string
--- Returns object coordinates for current time.
-- @function [parent=#Object] getPoint
-- @param self
-- @param #Object self
-- @return #Vec3
--- Returns object position for current time.
-- @function [parent=#Object] getPosition
-- @param self
-- @param #Object self
-- @return #Position3
--- Returns the unit's velocity vector.
-- @function [parent=#Object] getVelocity
-- @param self
-- @param #Object self
-- @return #Vec3
--- Returns true if the unit is in air.
-- @function [parent=#Object] inAir
-- @param self
-- @param #Object self
-- @return #boolean
Object = {} --#Object

View File

@@ -1,5 +1,5 @@
-------------------------------------------------------------------------------
-- @module StaticObject
-- @module DCSStaticObject
-------------------------------------------------------------------------------
@@ -22,12 +22,12 @@
--- returns identifier of the static object.
-- @function [parent=#StaticObject] getID
-- @param self
-- @param #StaticObject self
-- @return #StaticObject.ID
--- Returns descriptor of the StaticObject.
-- @function [parent=#StaticObject] getDesc
-- @param self
-- @param #StaticObject self
-- @return #StaticObject.Desc

8
DCS/DCSTask.doclua Normal file
View File

@@ -0,0 +1,8 @@
--- @type DCSTask
-- @field #string id
-- @field #DCSTask.param param
--- @type DCSTask.param
env.info( "DCSTask defined" )

View File

@@ -1,8 +1,8 @@
-------------------------------------------------------------------------------
-- @module Unit
-- @extends CoalitionObject#CoalitionObject
-- @module DCSUnit
--- @type Unit
-- @extends DCSCoalitionObject#CoalitionObject
-- @field ID Identifier of an unit. It assigned to an unit by the Mission Editor automatically.
-- @field #Unit.Category Category
-- @field #Unit.RefuelingSystem RefuelingSystem
@@ -151,68 +151,68 @@
--- Returns if the unit is activated.
-- @function [parent=#Unit] isActive
-- @param self
-- @param #Unit self
-- @return #boolean
--- Returns name of the player that control the unit or nil if the unit is controlled by A.I.
-- @function [parent=#Unit] getPlayerName
-- @param self
-- @param #Unit self
-- @return #string
--- returns the unit's unique identifier.
-- @function [parent=#Unit] getID
-- @param self
-- @param #Unit self
-- @return #Unit.ID
--- Returns the unit's number in the group. The number is the same number the unit has in ME. It may not be changed during the mission. If any unit in the group is destroyed, the numbers of another units will not be changed.
-- @function [parent=#Unit] getNumber
-- @param self
-- @param #Unit self
-- @return #number
--- Returns controller of the unit if it exist and nil otherwise
-- @function [parent=#Unit] getController
-- @param self
-- @param #Unit self
-- @return #Controller
--- Returns the unit's group if it exist and nil otherwise
-- @function [parent=#Unit] getGroup
-- @param self
-- @return Group#Group
-- @param #Unit self
-- @return DCSGroup#Group
--- Returns the unit's callsign - the localized string.
-- @function [parent=#Unit] getCallsign
-- @param self
-- @param #Unit self
-- @return #string
--- Returns the unit's health. Dead units has health <= 1.0
-- @function [parent=#Unit] getLife
-- @param self
-- @param #Unit self
-- @return #number
--- returns the unit's initial health.
-- @function [parent=#Unit] getLife0
-- @param self
-- @param #Unit self
-- @return #number
--- Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks. If there are additional fuel tanks the value may be greater than 1.0.
-- @function [parent=#Unit] getFuel
-- @param self
-- @param #Unit self
-- @return #number
--- Returns the unit ammunition.
-- @function [parent=#Unit] getAmmo
-- @param self
-- @param #Unit self
-- @return #Unit.Ammo
--- Returns the unit sensors.
-- @function [parent=#Unit] getSensors
-- @param self
-- @param #Unit self
-- @return #Unit.Sensors
--- Returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors.
-- @function [parent=#Unit] hasSensors
-- @param self
-- @param #Unit self
-- @param #Unit.SensorType sensorType (= nil) Sensor type.
-- @param ... Additional parameters.
-- @return #boolean
@@ -229,13 +229,13 @@
-- First value indicates if at least one of the unit's radar(s) is on.
-- Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.
-- @function [parent=#Unit] getRadar
-- @param self
-- @param #Unit self
-- @return #boolean, Object#Object
--- Returns unit descriptor. Descriptor type depends on unit category.
-- @function [parent=#Unit] getDesc
-- @param self
-- @return Unit#Unit.Desc
-- @param #Unit self
-- @return #Unit.Desc
Unit = {} --#Unit

View File

@@ -1,5 +1,5 @@
-------------------------------------------------------------------------------
-- @module timer
-- @module DCStimer
--- @type timer