FSM Documentation

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

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
-- -------------------------