weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2022-05-04 08:32:28 +00:00
parent b69a795711
commit cbea8561f1
106 changed files with 2211 additions and 1206 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
Documentation/Core.Event.html
View File

@@ -1640,24 +1640,22 @@ The Event Handler received the EVENTDATA object as a parameter, and can be used
There are basically 4 main categories of information stored in the EVENTDATA structure:</p>
<ul>
<li>Initiator Unit data: Several fields documenting the initiator unit related to the event.</li>
<li>Target Unit data: Several fields documenting the target unit related to the event.</li>
<li>Weapon data: Certain events populate weapon information.</li>
<li>Place data: Certain events populate place information.</li>
<li><p>Initiator Unit data: Several fields documenting the initiator unit related to the event.</p></li>
<li><p>Target Unit data: Several fields documenting the target unit related to the event.</p></li>
<li><p>Weapon data: Certain events populate weapon information.</p></li>
<li><p>Place data: Certain events populate place information.</p>
<p> --- This function is an Event Handling function that will be called when Tank1 is Dead.
-- EventData is an EVENTDATA structure.
-- We use the EventData.IniUnit to smoke the tank Green.
-- @param Wrapper.Unit#UNIT self
-- @param Core.Event#EVENTDATA EventData
function Tank1:OnEventDead( EventData )</p>
<p> EventData.IniUnit:SmokeGreen()
end</p></li>
</ul>
<p>Example code snippet:</p>
<pre><code> --- This function is an Event Handling function that will be called when Tank1 is Dead.
-- EventData is an EVENTDATA structure.
-- We use the EventData.IniUnit to smoke the tank Green.
-- @param Wrapper.Unit#UNIT self
-- @param Core.Event#EVENTDATA EventData
function Tank1:OnEventDead( EventData )
EventData.IniUnit:SmokeGreen()
end
</code></pre>
<p>Find below an overview which events populate which information categories:</p>
@@ -1667,9 +1665,8 @@ There are basically 4 main categories of information stored in the EVENTDATA str
In that case the initiator or target unit fields will refer to a STATIC object!
In case a STATIC object is involved, the documentation indicates which fields will and won't not be populated.
The fields <strong>IniObjectCategory</strong> and <strong>TgtObjectCategory</strong> contain the indicator which <strong>kind of object is involved</strong> in the event.
You can use the enumerator <strong>Object.Category.UNIT</strong> and <strong>Object.Category.STATIC</strong> to check on IniObjectCategory and TgtObjectCategory.</p>
<p>Example code snippet:</p>
You can use the enumerator <strong>Object.Category.UNIT</strong> and <strong>Object.Category.STATIC</strong> to check on IniObjectCategory and TgtObjectCategory.
Example code snippet:</p>
<pre><code> if Event.IniObjectCategory == Object.Category.UNIT then
...
@@ -1961,7 +1958,7 @@ You can use the enumerator <strong>Object.Category.UNIT</strong> and <strong>Obj
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).CreateEventCrash">EVENT:CreateEventCrash(EventTime, Initiator)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENT).CreateEventCrash">EVENT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Crash Event.</p>
</td>
@@ -2865,7 +2862,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).CreateEventCrash">EVENTHANDLER:CreateEventCrash(EventTime, Initiator)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTHANDLER).CreateEventCrash">EVENTHANDLER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creation of a Crash Event.</p>
</td>
@@ -5150,7 +5147,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENT).CreateEventCrash" ><strong>EVENT:CreateEventCrash(EventTime, Initiator)</strong></a></h2>
<h2><a id="#(EVENT).CreateEventCrash" ><strong>EVENT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
</div>
<p>Creation of a Crash Event.</p>
@@ -5188,6 +5185,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>IniObjectCategory</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
@@ -9054,7 +9061,7 @@ Note that at the beginning of each field description, there is an indication whi
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(EVENTHANDLER).CreateEventCrash" ><strong>EVENTHANDLER:CreateEventCrash(EventTime, Initiator)</strong></a></h2>
<h2><a id="#(EVENTHANDLER).CreateEventCrash" ><strong>EVENTHANDLER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
</div>
<p>Creation of a Crash Event.</p>
@@ -9092,6 +9099,16 @@ Note that at the beginning of each field description, there is an indication whi
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>IniObjectCategory</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>