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

Various Fixes

Browse Source 
-- Documentation fixes with links not working.
-- MENU_CLIENT_COMMAND had a small glitch, fixed that one too.
-- Implemented new Event Dispatcher.
--
This commit is contained in:
FlightControl
2017-02-04 15:16:32 +01:00
parent be4d51237b
commit 52f4051901
104 changed files with 65657 additions and 749 deletions
Download Patch File Download Diff File Expand all files Collapse all files

94
docs/Documentation/Base.html
View File

@@ -33,6 +33,7 @@
<li><a href="Controllable.html">Controllable</a></li>
<li><a href="Database.html">Database</a></li>
<li><a href="Detection.html">Detection</a></li>
<li><a href="DetectionManager.html">DetectionManager</a></li>
<li><a href="Escort.html">Escort</a></li>
<li><a href="Event.html">Event</a></li>
<li><a href="Fsm.html">Fsm</a></li>
@@ -88,7 +89,7 @@
<h2>1.1) BASE constructor</h2>
<p>Any class derived from BASE, must use the <a href="Core.Base.html##(BASE).New">Core.Base#BASE.New</a> method how this is done.</p>
<p>Any class derived from BASE, must use the <a href="Base.html##(BASE).New">Base#BASE.New</a> method how this is done.</p>
<h2>1.2) BASE Trace functionality</h2>
@@ -166,8 +167,8 @@ Therefore, the BASE class exposes the following event handling functions:</p>
<li><a href="##(BASE).EventOnTookControl">BASE.EventOnTookControl</a>(): Handle the event when a player takes control of a unit.</li>
</ul>
<p>The EventOn() methods provide the <a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> structure to the event handling function.
The <a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> structure contains an enriched data set of information about the event being handled.</p>
<p>The EventOn() methods provide the <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure to the event handling function.
The <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure contains an enriched data set of information about the event being handled.</p>
<p>Find below an example of the prototype how to write an event handling function: </p>
@@ -189,7 +190,7 @@ The <a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> structure co
<ul>
<li>self = the object that is handling the EventOnPlayerEnterUnit.</li>
<li>EventData = the <a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> structure, containing more information of the Event.</li>
<li>EventData = the <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure, containing more information of the Event.</li>
</ul>
<h2>1.4) Class identification methods</h2>
@@ -524,6 +525,12 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
<td class="name" nowrap="nowrap"><a href="##(BASE).GetClassNameAndID">BASE:GetClassNameAndID()</a></td>
<td class="summary">
<p>Get the ClassName + ClassID of the class instance.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(BASE).GetEventPriority">BASE:GetEventPriority()</a></td>
<td class="summary">
<p>Get the Class <a href="Event.html">Event</a> processing Priority.</p>
</td>
</tr>
<tr>
@@ -554,6 +561,12 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
<td class="name" nowrap="nowrap"><a href="##(BASE).New">BASE:New()</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(BASE).SetEventPriority">BASE:SetEventPriority(EventPriority)</a></td>
<td class="summary">
<p>Set the Class <a href="Event.html">Event</a> processing Priority.</p>
</td>
</tr>
<tr>
@@ -628,6 +641,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name" nowrap="nowrap"><a href="##(BASE)._F">BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</a></td>
<td class="summary">
<p>Trace a function call.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(BASE)._Private">BASE._Private</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -1731,6 +1750,28 @@ The ClassName + ClassID of the class instance.</p>
<dl class="function">
<dt>
<a id="#(BASE).GetEventPriority" >
<strong>BASE:GetEventPriority()</strong>
</a>
</dt>
<dd>
<p>Get the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
reflecting the order of the classes subscribed to the Event to be processed.</p>
<h3>Return value</h3>
<p><em>#number:</em>
The <a href="Event.html">Event</a> processing Priority.</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(BASE).GetParent" >
<strong>BASE:GetParent(Child)</strong>
</a>
@@ -1867,6 +1908,37 @@ Child</p>
<dl class="function">
<dt>
<a id="#(BASE).SetEventPriority" >
<strong>BASE:SetEventPriority(EventPriority)</strong>
</a>
</dt>
<dd>
<p>Set the Class <a href="Event.html">Event</a> processing Priority.</p>
<p>The Event processing Priority is a number from 1 to 10,
reflecting the order of the classes subscribed to the Event to be processed.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number EventPriority </em></code>:
The <a href="Event.html">Event</a> processing Priority.</p>
</li>
</ul>
<h3>Return value</h3>
<p>self</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(BASE).SetState" >
<strong>BASE:SetState(Object, Key, Value)</strong>
</a>
@@ -2176,6 +2248,20 @@ A #table or any field.</p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(BASE)._Private" >
<strong>BASE._Private</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">