Documentation

This commit is contained in:
FlightControl 2016-06-17 23:53:08 +02:00
parent 396662657f
commit c211f4f603
5 changed files with 46 additions and 12 deletions

View File

@ -21,6 +21,13 @@
-- * @{#AIBALANCER.ReturnToNearestAirbases}: Returns the AI to the nearest friendly @{Airbase#AIRBASE}.
--
-- ===
--
-- CREDITS
-- =======
-- **Dutch_Baron (James)** Who you can search on the Eagle Dynamics Forums.
-- Working together with James has resulted in the creation of the AIBALANCER class.
-- James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)
--
-- @module AIBalancer
-- @author FlightControl

View File

@ -1,7 +1,9 @@
--- Provides missile training functions.
--- This module contains the MISSILETRAINER class.
--
-- @{#MISSILETRAINER} class
-- ========================
-- ===
--
-- 1) @{MissileTrainer#MISSILETRAINER} class, extends @{Base#BASE}
-- ===============================================================
-- The @{#MISSILETRAINER} class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
-- the class will destroy the missile within a certain range, to avoid damage to your aircraft.
-- It suports the following functionality:
@ -43,16 +45,16 @@
-- * **200 meter**: Destroys the missile when the distance to the aircraft is below or equal to 200 meter.
--
--
-- MISSILETRAINER construction methods:
-- ====================================
-- 1.1) MISSILETRAINER construction methods:
-- -----------------------------------------
-- Create a new MISSILETRAINER object with the @{#MISSILETRAINER.New} method:
--
-- * @{#MISSILETRAINER.New}: Creates a new MISSILETRAINER object taking the maximum distance to your aircraft to evaluate when a missile needs to be destroyed.
--
-- MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.
--
-- MISSILETRAINER initialization methods:
-- ======================================
-- 1.2) MISSILETRAINER initialization methods:
-- -------------------------------------------
-- A MISSILETRAINER object will behave differently based on the usage of initialization methods:
--
-- * @{#MISSILETRAINER.InitMessagesOnOff}: Sets by default the display of any message to be ON or OFF.
@ -66,6 +68,15 @@
-- * @{#MISSILETRAINER.InitBearingOnOff}: Sets by default the display of bearing information of missiles ON of OFF.
-- * @{#MISSILETRAINER.InitMenusOnOff}: Allows to configure the options through the radio menu.
--
-- ===
--
-- CREDITS
-- =======
-- **Stuka (Danny)** Who you can search on the Eagle Dynamics Forums.
-- Working together with Danny has resulted in the MISSILETRAINER class.
-- Danny has shared his ideas and together we made a design.
-- Together with the **476 virtual team**, we tested the MISSILETRAINER class, and got much positive feedback!
--
-- @module MissileTrainer
-- @author FlightControl

View File

@ -100,6 +100,12 @@ There will be as many AI GROUPS spawned as there at CLIENTS in SET</em>CLIENT no
<hr/>
<h1>CREDITS</h1>
<p><strong>Dutch_Baron (James)</strong> Who you can search on the Eagle Dynamics Forums.
Working together with James has resulted in the creation of the AIBALANCER class.
James has shared his ideas on balancing AI with air units, and together we made a first design which you can use now :-)</p>
<h2>Global(s)</h2>
<table class="function_list">
<tr>

View File

@ -73,11 +73,13 @@
<div id="content">
<h1>Module <code>MissileTrainer</code></h1>
<p>Provides missile training functions.</p>
<p>This module contains the MISSILETRAINER class.</p>
<h1><a href="##(MISSILETRAINER)">#MISSILETRAINER</a> class</h1>
<hr/>
<h1>1) <a href="MissileTrainer.html##(MISSILETRAINER)">MissileTrainer#MISSILETRAINER</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
<p>The <a href="##(MISSILETRAINER)">#MISSILETRAINER</a> class uses the DCS world messaging system to be alerted of any missiles fired, and when a missile would hit your aircraft,
the class will destroy the missile within a certain range, to avoid damage to your aircraft.
It suports the following functionality:</p>
@ -133,7 +135,7 @@ It suports the following functionality:</p>
</ul>
<h1>MISSILETRAINER construction methods:</h1>
<h2>1.1) MISSILETRAINER construction methods:</h2>
<p>Create a new MISSILETRAINER object with the <a href="##(MISSILETRAINER).New">MISSILETRAINER.New</a> method:</p>
<ul>
@ -142,7 +144,7 @@ It suports the following functionality:</p>
<p>MISSILETRAINER will collect each unit declared in the mission with a skill level "Client" and "Player", and will monitor the missiles shot at those.</p>
<h1>MISSILETRAINER initialization methods:</h1>
<h2>1.2) MISSILETRAINER initialization methods:</h2>
<p>A MISSILETRAINER object will behave differently based on the usage of initialization methods:</p>
<ul>
@ -158,6 +160,14 @@ It suports the following functionality:</p>
<li><a href="##(MISSILETRAINER).InitMenusOnOff">MISSILETRAINER.InitMenusOnOff</a>: Allows to configure the options through the radio menu.</li>
</ul>
<hr/>
<h1>CREDITS</h1>
<p><strong>Stuka (Danny)</strong> Who you can search on the Eagle Dynamics Forums.
Working together with Danny has resulted in the MISSILETRAINER class.
Danny has shared his ideas and together we made a design.
Together with the <strong>476 virtual team</strong>, we tested the MISSILETRAINER class, and got much positive feedback!</p>
<h2>Global(s)</h2>
<table class="function_list">

View File

@ -262,7 +262,7 @@
<tr>
<td class="name" nowrap="nowrap"><a href="MissileTrainer.html">MissileTrainer</a></td>
<td class="summary">
<p>Provides missile training functions.</p>
<p>This module contains the MISSILETRAINER class.</p>
</td>
</tr>
<tr>