New versions with documentation

This commit is contained in:
FlightControl_Master
2018-05-29 22:34:33 +02:00
parent f03f9a3308
commit 43b320ca90
34 changed files with 85 additions and 148 deletions

View File

@@ -9,14 +9,13 @@
-- ===
--
-- @module Wrapper.Airbase
-- @image Wrapper_Airbase.JPG
--- @type AIRBASE
-- @extends Wrapper.Positionable#POSITIONABLE
--- # AIRBASE class, extends @{Wrapper.Positionable#POSITIONABLE}
--
-- AIRBASE is a wrapper class to handle the DCS Airbase objects:
--- AIRBASE is a wrapper class to handle the DCS Airbase objects:
--
-- * Support all DCS Airbase APIs.
-- * Enhance with Airbase specific APIs not in the DCS Airbase API set.

View File

@@ -9,6 +9,7 @@
-- ===
--
-- @module Wrapper.Client
-- @image Wrapper_Client.JPG
--- The CLIENT class
@@ -16,9 +17,7 @@
-- @extends Wrapper.Unit#UNIT
--- # CLIENT class, extends @{Wrapper.Unit#UNIT}
--
-- Clients are those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
--- Clients are those **Units** defined within the Mission Editor that have the skillset defined as __Client__ or __Player__.
-- Note that clients are NOT the same as Units, they are NOT necessarily alive.
-- The CLIENT class is a wrapper class to handle the DCS Unit objects that have the skillset defined as __Client__ or __Player__:
--

View File

@@ -9,7 +9,7 @@
-- ===
--
-- @module Wrapper.Controllable
-- @image Wrapper_Controllable.JPG
--- @type CONTROLLABLE
@@ -19,9 +19,7 @@
--- # CONTROLLABLE class, extends @{Wrapper.Positionable#POSITIONABLE}
--
-- CONTROLLABLE is a wrapper class to handle the "DCS Controllable objects", which are Groups and Units:
--- CONTROLLABLE is a wrapper class to handle the "DCS Controllable objects", which are Groups and Units:
--
-- * Support all DCS Controllable APIs.
-- * Enhance with Controllable specific APIs not in the DCS Controllable API set.

View File

@@ -24,6 +24,7 @@
-- ===
--
-- @module Wrapper.Group
-- @image Wrapper_Group.JPG
--- @type GROUP
@@ -31,10 +32,7 @@
-- @field #string GroupName The name of the group.
---
-- # GROUP class, extends @{Wrapper.Controllable#CONTROLLABLE}
--
-- For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _@{DATABASE} object.
--- For each DCS Group object alive within a running mission, a GROUP wrapper object (instance) will be created within the _@{DATABASE} object.
-- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Group objects are spawned (using the @{SPAWN} class).
--
-- The GROUP class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference

View File

@@ -14,9 +14,7 @@
-- @extends Wrapper.Object#OBJECT
-- @field #string IdentifiableName The name of the identifiable.
--- # IDENTIFIABLE class, extends @{Wrapper.Object#OBJECT}
--
-- The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects:
--- The IDENTIFIABLE class is a wrapper class to handle the DCS Identifiable objects:
--
-- * Support all DCS Identifiable APIs.
-- * Enhance with Identifiable specific APIs not in the DCS Identifiable API set.

View File

@@ -16,9 +16,7 @@
-- @field #string ObjectName The name of the Object.
--- # OBJECT class, extends @{Core.Base#BASE}
--
-- OBJECT handles the DCS Object objects:
--- OBJECT handles the DCS Object objects:
--
-- * Support all DCS Object APIs.
-- * Enhance with Object specific APIs not in the DCS Object API set.

View File

@@ -9,6 +9,7 @@
-- ===
--
-- @module Wrapper.Positionable
-- @image Wrapper_Positionable.JPG
--- @type POSITIONABLE.__ Methods which are not intended for mission designers, but which are used interally by the moose designer :-)
-- @extends Wrapper.Identifiable#IDENTIFIABLE
@@ -17,9 +18,7 @@
-- @extends Wrapper.Identifiable#IDENTIFIABLE
--- # POSITIONABLE class, extends @{Wrapper.Identifiable#IDENTIFIABLE}
--
-- The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:
--- The POSITIONABLE class is a wrapper class to handle the POSITIONABLE objects:
--
-- * Support all DCS APIs.
-- * Enhance with POSITIONABLE specific APIs not in the DCS API set.

View File

@@ -9,6 +9,7 @@
-- ===
--
-- @module Wrapper.Scenery
-- @image Wrapper_Scenery.JPG
@@ -16,9 +17,7 @@
-- @extends Wrapper.Positionable#POSITIONABLE
--- # SCENERY class, extends @{Wrapper.Positionable#POSITIONABLE}
--
-- Scenery objects are defined on the map.
--- Scenery objects are defined on the map.
-- The @{Scenery#SCENERY} class is a wrapper class to handle the DCS Scenery objects:
--
-- * Wraps the DCS Scenery objects.

View File

@@ -9,14 +9,13 @@
-- ===
--
-- @module Wrapper.Static
-- @image Wrapper_Static.JPG
--- @type STATIC
-- @extends Wrapper.Positionable#POSITIONABLE
--- # STATIC class, extends @{Wrapper.Positionable#POSITIONABLE}
--
-- Statics are **Static Units** defined within the Mission Editor.
--- Statics are **Static Units** defined within the Mission Editor.
-- Note that Statics are almost the same as Units, but they don't have a controller.
-- The @{Static#STATIC} class is a wrapper class to handle the DCS Static objects:
--

View File

@@ -18,15 +18,13 @@
-- ===
--
-- @module Wrapper.Unit
-- @image Wrapper_Unit.JPG
--- @type UNIT
-- @extends Wrapper.Controllable#CONTROLLABLE
---
-- # UNIT class, extends @{Wrapper.Controllable#CONTROLLABLE}
--
-- For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _@{DATABASE} object.
--- For each DCS Unit object alive within a running mission, a UNIT wrapper object (instance) will be created within the _@{DATABASE} object.
-- This is done at the beginning of the mission (when the mission starts), and dynamically when new DCS Unit objects are spawned (using the @{SPAWN} class).
--
-- The UNIT class **does not contain a :New()** method, rather it provides **:Find()** methods to retrieve the object reference