Static + documentation

This commit is contained in:
FlightControl
2017-01-23 14:17:23 +01:00
parent d4497fbf5e
commit 0109f011e8
8 changed files with 63371 additions and 51 deletions
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+3 -3
View File
@@ -240,7 +240,7 @@ Processing will just continue. Synchronous Event Trigger methods are useful to c
<p>The following example provides a little demonstration on the difference between synchronous and asynchronous Event Triggering.</p> <p>The following example provides a little demonstration on the difference between synchronous and asynchronous Event Triggering.</p>
<pre><code> function FSM:OnAfterEvent( From, Event, To, Amount ) <pre><code> function FSM:OnAfterEvent( From, Event, To, Amount )
self:E( { Amount = Amount } ) self:T( { Amount = Amount } )
end end
local Amount = 1 local Amount = 1
@@ -292,7 +292,7 @@ The next code implements this through the event handling method <strong>OnAfterS
<p><img src="..\Presentations\FSM\Dia7.JPG" alt="Transition Flow"/></p> <p><img src="..\Presentations\FSM\Dia7.JPG" alt="Transition Flow"/></p>
<pre><code> function FsmDemo:OnAfterSwitch( From, Event, To, FsmUnit ) <pre><code> function FsmDemo:OnAfterSwitch( From, Event, To, FsmUnit )
self:E( { From, Event, To, FsmUnit } ) self:T( { From, Event, To, FsmUnit } )
if From == "Green" then if From == "Green" then
FsmUnit:Flare(FLARECOLOR.Green) FsmUnit:Flare(FLARECOLOR.Green)
@@ -317,7 +317,7 @@ and one additional parameter that was given when the event was triggered, which
<p>For debugging reasons the received parameters are traced within the DCS.log.</p> <p>For debugging reasons the received parameters are traced within the DCS.log.</p>
<pre><code> self:E( { From, Event, To, FsmUnit } ) <pre><code> self:T( { From, Event, To, FsmUnit } )
</code></pre> </code></pre>
<p>The method will check if the From state received is either "Green" or "Red" and will flare the respective color from the FsmUnit.</p> <p>The method will check if the From state received is either "Green" or "Red" and will flare the respective color from the FsmUnit.</p>
+6 -5
View File
@@ -231,7 +231,7 @@
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToCoalition">POSITIONABLE:MessageToCoalition(Message, Duration, Name, MessageCoalition)</a></td> <td class="name" nowrap="nowrap"><a href="##(POSITIONABLE).MessageToCoalition">POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition, Name)</a></td>
<td class="summary"> <td class="summary">
<p>Send a message to a coalition.</p> <p>Send a message to a coalition.</p>
</td> </td>
@@ -851,7 +851,7 @@ The client object receiving the message.</p>
<dt> <dt>
<a id="#(POSITIONABLE).MessageToCoalition" > <a id="#(POSITIONABLE).MessageToCoalition" >
<strong>POSITIONABLE:MessageToCoalition(Message, Duration, Name, MessageCoalition)</strong> <strong>POSITIONABLE:MessageToCoalition(Message, Duration, MessageCoalition, Name)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@@ -877,13 +877,14 @@ The duration of the message.</p>
</li> </li>
<li> <li>
<p><code><em>#string Name </em></code>: <p><code><em><a href="Dcs.DCScoalition.html##(coalition)">Dcs.DCScoalition#coalition</a> MessageCoalition </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p> The Coalition receiving the message.</p>
</li> </li>
<li> <li>
<p><code><em> MessageCoalition </em></code>: </p> <p><code><em>#string Name </em></code>:
(optional) The Name of the sender. If not provided, the Name is the type of the Positionable.</p>
</li> </li>
</ul> </ul>
+2 -2
View File
@@ -2171,7 +2171,7 @@ when nothing was spawned.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em> <em>#number</em>
<a id="#(SPAWN).SpawnMaxGroups" > <a id="#(SPAWN).SpawnMaxGroups" >
<strong>SPAWN.SpawnMaxGroups</strong> <strong>SPAWN.SpawnMaxGroups</strong>
</a> </a>
@@ -2188,7 +2188,7 @@ when nothing was spawned.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em> <em>#number</em>
<a id="#(SPAWN).SpawnMaxUnitsAlive" > <a id="#(SPAWN).SpawnMaxUnitsAlive" >
<strong>SPAWN.SpawnMaxUnitsAlive</strong> <strong>SPAWN.SpawnMaxUnitsAlive</strong>
</a> </a>
+44 -7
View File
@@ -639,7 +639,13 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).onenterAborted">TASK:onenterAborted(Event, From, To)</a></td> <td class="name" nowrap="nowrap"><a href="##(TASK).onafterReplan">TASK:onafterReplan(From, Event, To)</a></td>
<td class="summary">
<p>FSM function for a TASK</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).onenterAborted">TASK:onenterAborted(From, Event, To)</a></td>
<td class="summary"> <td class="summary">
<p>FSM function for a TASK</p> <p>FSM function for a TASK</p>
</td> </td>
@@ -651,7 +657,7 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).onenterFailed">TASK:onenterFailed(Event, From, To)</a></td> <td class="name" nowrap="nowrap"><a href="##(TASK).onenterFailed">TASK:onenterFailed(From, Event, To)</a></td>
<td class="summary"> <td class="summary">
<p>FSM function for a TASK</p> <p>FSM function for a TASK</p>
</td> </td>
@@ -2311,8 +2317,8 @@ self</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<a id="#(TASK).onenterAborted" > <a id="#(TASK).onafterReplan" >
<strong>TASK:onenterAborted(Event, From, To)</strong> <strong>TASK:onafterReplan(From, Event, To)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@@ -2323,16 +2329,47 @@ self</p>
<ul> <ul>
<li> <li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p> <p><code><em>#string Event </em></code>: </p>
</li> </li>
<li> <li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK).onenterAborted" >
<strong>TASK:onenterAborted(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>FSM function for a TASK</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p> <p><code><em>#string From </em></code>: </p>
</li> </li>
<li> <li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p> <p><code><em>#string To </em></code>: </p>
</li> </li>
@@ -2374,7 +2411,7 @@ self</p>
<dt> <dt>
<a id="#(TASK).onenterFailed" > <a id="#(TASK).onenterFailed" >
<strong>TASK:onenterFailed(Event, From, To)</strong> <strong>TASK:onenterFailed(From, Event, To)</strong>
</a> </a>
</dt> </dt>
<dd> <dd>
@@ -2385,12 +2422,12 @@ self</p>
<ul> <ul>
<li> <li>
<p><code><em>#string Event </em></code>: </p> <p><code><em>#string From </em></code>: </p>
</li> </li>
<li> <li>
<p><code><em>#string From </em></code>: </p> <p><code><em>#string Event </em></code>: </p>
</li> </li>
<li> <li>