FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

FSM Documentation

Browse Source
This commit is contained in:
FlightControl 2017-01-04 10:40:58 +01:00
parent ccbe79c00c
commit 6bd4442d84
3 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Moose Development/Moose/Core/Fsm.lua
View File

@ -15,7 +15,7 @@
-- * A **State** defines a moment in the process.
-- * An **Event** describes an action, that can be triggered both internally as externally in the FSM. An Event can be triggered Embedded or Delayed over time.
--
-- ![Test Image](Presentations\FSM\Dia1.jpg)
-- ![Test Image](..\Presentations\FSM\Dia1.jpg)
--
-- An FSM transitions in **4 moments** when an Event is being handled.
-- Each moment can be catched by handling methods defined by the mission designer,
@ -27,7 +27,7 @@
--
-- ** The OnLeave and OnBefore transition methods may return false to cancel the transition.**
--
-- ![Test Image](.\Presentations\FSM\Dia3.jpg)
-- ![Test Image](..\Presentations\FSM\Dia3.jpg)
--
-- The FSM creates for each Event **two Event trigger methods**.
-- There are two modes how Events can be triggered, which is **embedded** and **delayed**:
@ -35,7 +35,7 @@
-- * The method **FSM:Event()** triggers an Event that will be processed **embedded** or **immediately**.
-- * The method **FSM:__Event( seconds )** triggers an Event that will be processed **delayed** over time, waiting x seconds.
--
-- ![Test Image](.\Presentations\FSM\Dia4.jpg)
-- ![Test Image](..\Presentations\FSM\Dia4.jpg)
--
-- 1.1) Define the FSM Rules
-- -------------------------

6
docs/Documentation/Fsm.html
View File

@ -89,7 +89,7 @@ It is a fantastic development, this module.</p>
<li>An <strong>Event</strong> describes an action, that can be triggered both internally as externally in the FSM. An Event can be triggered Embedded or Delayed over time.</li>
</ul>
<p><img src="Presentations\FSM\Dia1.jpg" alt="Test Image"/></p>
<p><img src="..\Presentations\FSM\Dia1.jpg" alt="Test Image"/></p>
<p>An FSM transitions in <strong>4 moments</strong> when an Event is being handled. <br/>
Each moment can be catched by handling methods defined by the mission designer, <br/>
@ -103,7 +103,7 @@ These methods define the flow of the FSM process; because in those methods the F
<p><em>* The OnLeave and OnBefore transition methods may return false to cancel the transition.</em>*</p>
<p> <img src=".\Presentations\FSM\Dia3.jpg" alt="Test Image"/></p>
<p> <img src="..\Presentations\FSM\Dia3.jpg" alt="Test Image"/></p>
<p>The FSM creates for each Event <strong>two Event trigger methods</strong>. <br/>
There are two modes how Events can be triggered, which is <strong>embedded</strong> and <strong>delayed</strong>:</p>
@ -113,7 +113,7 @@ There are two modes how Events can be triggered, which is <strong>embedded</stro
<li>The method <strong>FSM:__Event( seconds )</strong> triggers an Event that will be processed <strong>delayed</strong> over time, waiting x seconds.</li>
</ul>
<p> <img src=".\Presentations\FSM\Dia4.jpg" alt="Test Image"/></p>
<p> <img src="..\Presentations\FSM\Dia4.jpg" alt="Test Image"/></p>
<h2>1.1) Define the FSM Rules</h2>

9
docs/Documentation/Spawn.html
View File

@ -1692,9 +1692,6 @@ The group that was spawned. You can use this group for further actions.</p>
<p> Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.</p>
</dd>
</dl>
<dl class="function">
@ -2169,7 +2166,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em>#number</em>
<em></em>
<a id="#(SPAWN).SpawnMaxGroups" >
<strong>SPAWN.SpawnMaxGroups</strong>
</a>
@ -2186,7 +2183,7 @@ when nothing was spawned.</p>
<dl class="function">
<dt>
<em>#number</em>
<em></em>
<a id="#(SPAWN).SpawnMaxUnitsAlive" >
<strong>SPAWN.SpawnMaxUnitsAlive</strong>
</a>
@ -2489,7 +2486,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
</dd>
</dl>