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

EVENTDATA structure was hidden in documentation.

Browse Source
This commit is contained in:
FlightControl 2017-03-04 16:02:21 +01:00
parent bbc9ddf9a3
commit 842aa878ad
4 changed files with 113 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
Moose Development/Moose/Core/Event.lua
View File

@ -110,7 +110,7 @@
-- --
-- # 3) EVENTDATA type -- # 3) EVENTDATA type
-- --
-- The EVENTDATA contains all the fields that are populated with event information before -- The @{Event#EVENTDATA} structure contains all the fields that are populated with event information before
-- an Event Handler method is being called by the event dispatcher. -- an Event Handler method is being called by the event dispatcher.
-- The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events. -- The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events.
-- There are basically 4 main categories of information stored in the EVENTDATA structure: -- There are basically 4 main categories of information stored in the EVENTDATA structure:
@ -120,6 +120,17 @@
-- * Weapon data: Certain events populate weapon information. -- * Weapon data: Certain events populate weapon information.
-- * Place data: Certain events populate place information. -- * Place data: Certain events populate place information.
-- --
-- --- 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
--
--
-- Find below an overview which events populate which information categories: -- Find below an overview which events populate which information categories:
-- --
-- ![Objects](..\Presentations\EVENT\Dia14.JPG) -- ![Objects](..\Presentations\EVENT\Dia14.JPG)
@ -220,35 +231,35 @@ EVENTS = {
-- @type EVENTDATA -- @type EVENTDATA
-- @field #number id The identifier of the event. -- @field #number id The identifier of the event.
-- --
-- @field Dcs.DCSUnit#Unit initiator (UNIT/STATIC/SCENERY) The initiating @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}. -- @field Dcs.DCSUnit#Unit initiator (UNIT/STATIC/SCENERY) The initiating @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}.
-- @field Dcs.DCSObject#Object.Category IniObjectCategory (UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ). -- @field Dcs.DCSObject#Object.Category IniObjectCategory (UNIT/STATIC/SCENERY) The initiator object category ( Object.Category.UNIT or Object.Category.STATIC ).
-- @field Dcs.DCSUnit#Unit IniDCSUnit (UNIT/STATIC) The initiating @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}. -- @field Dcs.DCSUnit#Unit IniDCSUnit (UNIT/STATIC) The initiating @{DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
-- @field #string IniDCSUnitName (UNIT/STATIC) The initiating Unit name. -- @field #string IniDCSUnitName (UNIT/STATIC) The initiating Unit name.
-- @field Wrapper.Unit#UNIT IniUnit (UNIT/STATIC) The initiating MOOSE wrapper @{Wrapper.Unit#UNIT} of the initiator Unit object. -- @field Wrapper.Unit#UNIT IniUnit (UNIT/STATIC) The initiating MOOSE wrapper @{Unit#UNIT} of the initiator Unit object.
-- @field #string IniUnitName (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName). -- @field #string IniUnitName (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).
-- @field Dcs.DCSGroup#Group IniDCSGroup (UNIT) The initiating {Dcs.DCSGroup#Group}. -- @field Dcs.DCSGroup#Group IniDCSGroup (UNIT) The initiating {DCSGroup#Group}.
-- @field #string IniDCSGroupName (UNIT) The initiating Group name. -- @field #string IniDCSGroupName (UNIT) The initiating Group name.
-- @field Wrapper.Group#GROUP IniGroup (UNIT) The initiating MOOSE wrapper @{Wrapper.Group#GROUP} of the initiator Group object. -- @field Wrapper.Group#GROUP IniGroup (UNIT) The initiating MOOSE wrapper @{Group#GROUP} of the initiator Group object.
-- @field #string IniGroupName (UNIT) The initiating GROUP name (same as IniDCSGroupName). -- @field #string IniGroupName UNIT) The initiating GROUP name (same as IniDCSGroupName).
-- @field #string IniPlayerName (UNIT) The name of the initiating player in case the Unit is a client or player slot. -- @field #string IniPlayerName (UNIT) The name of the initiating player in case the Unit is a client or player slot.
-- @field Dcs.DCScoalition#coalition.side IniCoalition (UNIT) The coalition of the initiator. -- @field Dcs.DCScoalition#coalition.side IniCoalition (UNIT) The coalition of the initiator.
-- @field Dcs.DCSUnit#Unit.Category IniCategory (UNIT) The category of the initiator. -- @field Dcs.DCSUnit#Unit.Category IniCategory (UNIT) The category of the initiator.
-- @field #string IniTypeName (UNIT) The type name of the initiator. -- @field #string IniTypeName (UNIT) The type name of the initiator.
-- --
-- @field Dcs.DCSUnit#Unit target (UNIT/STATIC) The target @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}. -- @field Dcs.DCSUnit#Unit target (UNIT/STATIC) The target @{Dcs.DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
-- @field Dcs.DCSObject#Object.Category TgtObjectCategory (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ). -- @field Dcs.DCSObject#Object.Category TgtObjectCategory (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).
-- @field Dcs.DCSUnit#Unit TgtDCSUnit (UNIT/STATIC) The target @{Dcs.DCSUnit#Unit} or @{Dcs.DCSStaticObject#StaticObject}. -- @field Dcs.DCSUnit#Unit TgtDCSUnit (UNIT/STATIC) The target @{DCSUnit#Unit} or @{DCSStaticObject#StaticObject}.
-- @field #string TgtDCSUnitName (UNIT/STATIC) The target Unit name. -- @field #string TgtDCSUnitName (UNIT/STATIC) The target Unit name.
-- @field Wrapper.Unit#UNIT TgtUnit (UNIT/STATIC) The target MOOSE wrapper @{Wrapper.Unit#UNIT} of the target Unit object. -- @field Wrapper.Unit#UNIT TgtUnit (UNIT/STATIC) The target MOOSE wrapper @{Unit#UNIT} of the target Unit object.
-- @field #string TgtUnitName (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName). -- @field #string TgtUnitName (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).
-- @field Dcs.DCSGroup#Group TgtDCSGroup (UNIT) The target {Dcs.DCSGroup#Group}. -- @field Dcs.DCSGroup#Group TgtDCSGroup (UNIT) The target {DCSGroup#Group}.
-- @field #string TgtDCSGroupName (UNIT) The target Group name. -- @field #string TgtDCSGroupName (UNIT) The target Group name.
-- @field Wrapper.Group#GROUP TgtGroup (UNIT) The target MOOSE wrapper @{Wrapper.Group#GROUP} of the target Group object. -- @field Wrapper.Group#GROUP TgtGroup (UNIT) The target MOOSE wrapper @{Group#GROUP} of the target Group object.
-- @field #string TgtGroupName (UNIT) The target GROUP name (same as TgtDCSGroupName). -- @field #string TgtGroupName (UNIT) The target GROUP name (same as TgtDCSGroupName).
-- @field #string TgtPlayerName (UNIT) The name of the target player in case the Unit is a client or player slot. -- @field #string TgtPlayerName (UNIT) The name of the target player in case the Unit is a client or player slot.
-- @field Dcs.DCScoalition#coalition.side TgtCoalition (UNIT) The coalition of the target. -- @field Dcs.DCScoalition#coalition.side TgtCoalition (UNIT) The coalition of the target.
-- @field Dcs.DCSUnit#Unit.Category TgtCategory (UNIT) The category of the target. -- @field Dcs.DCSUnit#Unit.Category TgtCategory (UNIT) The category of the target.
-- @field #string TgtTypeName (UNIT) The type name of the target. -- @field #string TgtTypeName (UNIT) The type name of the target.
-- --
-- @field weapon The weapon used during the event. -- @field weapon The weapon used during the event.
-- @field Weapon -- @field Weapon

1
docs/Documentation/Cargo.html
View File

@ -2425,7 +2425,6 @@ The UNIT carrying the package.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em></em>
<a id="#(AI_CARGO_UNIT).CargoCarrier" > <a id="#(AI_CARGO_UNIT).CargoCarrier" >
<strong>AI_CARGO_UNIT.CargoCarrier</strong> <strong>AI_CARGO_UNIT.CargoCarrier</strong>
</a> </a>

175
docs/Documentation/Event.html
View File

@ -191,18 +191,29 @@ Always ensure that your event handling methods align with the events being subsc
<h1>3) EVENTDATA type</h1> <h1>3) EVENTDATA type</h1>
<p>The EVENTDATA contains all the fields that are populated with event information before <p>The <a href="Event.html##(EVENTDATA)">Event#EVENTDATA</a> structure contains all the fields that are populated with event information before
an Event Handler method is being called by the event dispatcher. an Event Handler method is being called by the event dispatcher.
The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events. The Event Handler received the EVENTDATA object as a parameter, and can be used to investigate further the different events.
There are basically 4 main categories of information stored in the EVENTDATA structure:</p> There are basically 4 main categories of information stored in the EVENTDATA structure:</p>
<ul> <ul>
<li>Initiator Unit data: Several fields documenting the initiator unit related to the event.</li> <li><p>Initiator Unit data: Several fields documenting the initiator unit related to the event.</p></li>
<li>Target Unit data: Several fields documenting the target unit related to the event.</li> <li><p>Target Unit data: Several fields documenting the target unit related to the event.</p></li>
<li>Weapon data: Certain events populate weapon information.</li> <li><p>Weapon data: Certain events populate weapon information.</p></li>
<li>Place data: Certain events populate place information.</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> </ul>
<p>Find below an overview which events populate which information categories:</p> <p>Find below an overview which events populate which information categories:</p>
<p><img src="..\Presentations\EVENT\Dia14.JPG" alt="Objects"/></p> <p><img src="..\Presentations\EVENT\Dia14.JPG" alt="Objects"/></p>
@ -591,55 +602,49 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCategory">EVENTDATA.IniCategory</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCategory">EVENTDATA.IniCategory</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The category of the initiator. <p>(UNIT) The category of the initiator.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCoalition">EVENTDATA.IniCoalition</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniCoalition">EVENTDATA.IniCoalition</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The coalition of the initiator. <p>(UNIT) The coalition of the initiator.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroup">EVENTDATA.IniDCSGroup</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroup">EVENTDATA.IniDCSGroup</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The initiating {Dcs.DCSGroup#Group}. <p>(UNIT) The initiating {DCSGroup#Group}.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroupName">EVENTDATA.IniDCSGroupName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSGroupName">EVENTDATA.IniDCSGroupName</a></td>
<td class="summary"> <td class="summary">
<p> (UNIT) The initiating Group name.</p> <p>(UNIT) The initiating Group name.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnit">EVENTDATA.IniDCSUnit</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnit">EVENTDATA.IniDCSUnit</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The initiating &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The initiating <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnitName">EVENTDATA.IniDCSUnitName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniDCSUnitName">EVENTDATA.IniDCSUnitName</a></td>
<td class="summary"> <td class="summary">
<p> (UNIT/STATIC) The initiating Unit name.</p> <p>(UNIT/STATIC) The initiating Unit name.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroup">EVENTDATA.IniGroup</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroup">EVENTDATA.IniGroup</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The initiating MOOSE wrapper &lt;a href="Wrapper.Group.html##(GROUP)"&gt;Wrapper.Group#GROUP&lt;/a&gt; of the initiator Group object. <p>(UNIT) The initiating MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the initiator Group object.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroupName">EVENTDATA.IniGroupName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniGroupName">EVENTDATA.IniGroupName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The initiating GROUP name (same as IniDCSGroupName). <p>UNIT) The initiating GROUP name (same as IniDCSGroupName).</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -651,120 +656,105 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniPlayerName">EVENTDATA.IniPlayerName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniPlayerName">EVENTDATA.IniPlayerName</a></td>
<td class="summary"> <td class="summary">
<pre><code>(UNIT) The name of the initiating player in case the Unit is a client or player slot. <p>(UNIT) The name of the initiating player in case the Unit is a client or player slot.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniTypeName">EVENTDATA.IniTypeName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniTypeName">EVENTDATA.IniTypeName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The type name of the initiator. <p>(UNIT) The type name of the initiator.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnit">EVENTDATA.IniUnit</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnit">EVENTDATA.IniUnit</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The initiating MOOSE wrapper &lt;a href="Wrapper.Unit.html##(UNIT)"&gt;Wrapper.Unit#UNIT&lt;/a&gt; of the initiator Unit object. <p>(UNIT/STATIC) The initiating MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the initiator Unit object.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnitName">EVENTDATA.IniUnitName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).IniUnitName">EVENTDATA.IniUnitName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName). <p>(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCategory">EVENTDATA.TgtCategory</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCategory">EVENTDATA.TgtCategory</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The category of the target. <p>(UNIT) The category of the target.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCoalition">EVENTDATA.TgtCoalition</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtCoalition">EVENTDATA.TgtCoalition</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The coalition of the target. <p>(UNIT) The coalition of the target.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroup">EVENTDATA.TgtDCSGroup</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroup">EVENTDATA.TgtDCSGroup</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The target {Dcs.DCSGroup#Group}. <p>(UNIT) The target {DCSGroup#Group}.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroupName">EVENTDATA.TgtDCSGroupName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSGroupName">EVENTDATA.TgtDCSGroupName</a></td>
<td class="summary"> <td class="summary">
<p> (UNIT) The target Group name.</p> <p>(UNIT) The target Group name.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnit">EVENTDATA.TgtDCSUnit</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnit">EVENTDATA.TgtDCSUnit</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The target &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The target <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnitName">EVENTDATA.TgtDCSUnitName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtDCSUnitName">EVENTDATA.TgtDCSUnitName</a></td>
<td class="summary"> <td class="summary">
<p> (UNIT/STATIC) The target Unit name.</p> <p>(UNIT/STATIC) The target Unit name.</p>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroup">EVENTDATA.TgtGroup</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroup">EVENTDATA.TgtGroup</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The target MOOSE wrapper &lt;a href="Wrapper.Group.html##(GROUP)"&gt;Wrapper.Group#GROUP&lt;/a&gt; of the target Group object. <p>(UNIT) The target MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the target Group object.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroupName">EVENTDATA.TgtGroupName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtGroupName">EVENTDATA.TgtGroupName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The target GROUP name (same as TgtDCSGroupName). <p>(UNIT) The target GROUP name (same as TgtDCSGroupName).</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtObjectCategory">EVENTDATA.TgtObjectCategory</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtObjectCategory">EVENTDATA.TgtObjectCategory</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ). <p>(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtPlayerName">EVENTDATA.TgtPlayerName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtPlayerName">EVENTDATA.TgtPlayerName</a></td>
<td class="summary"> <td class="summary">
<pre><code>(UNIT) The name of the target player in case the Unit is a client or player slot. <p>(UNIT) The name of the target player in case the Unit is a client or player slot.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtTypeName">EVENTDATA.TgtTypeName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtTypeName">EVENTDATA.TgtTypeName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT) The type name of the target. <p>(UNIT) The type name of the target.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnit">EVENTDATA.TgtUnit</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnit">EVENTDATA.TgtUnit</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The target MOOSE wrapper &lt;a href="Wrapper.Unit.html##(UNIT)"&gt;Wrapper.Unit#UNIT&lt;/a&gt; of the target Unit object. <p>(UNIT/STATIC) The target MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the target Unit object.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnitName">EVENTDATA.TgtUnitName</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).TgtUnitName">EVENTDATA.TgtUnitName</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName). <p>(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -795,15 +785,13 @@ YYYY-MM-DD: CLASS:<strong>NewFunction( Params )</strong> added</p>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).initiator">EVENTDATA.initiator</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).initiator">EVENTDATA.initiator</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC/SCENERY) The initiating &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="name" nowrap="nowrap"><a href="##(EVENTDATA).target">EVENTDATA.target</a></td> <td class="name" nowrap="nowrap"><a href="##(EVENTDATA).target">EVENTDATA.target</a></td>
<td class="summary"> <td class="summary">
<pre><code> (UNIT/STATIC) The target &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</td> </td>
</tr> </tr>
<tr> <tr>
@ -2584,8 +2572,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The category of the initiator. <p>(UNIT) The category of the initiator.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2599,8 +2586,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The coalition of the initiator. <p>(UNIT) The coalition of the initiator.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2614,8 +2600,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The initiating {Dcs.DCSGroup#Group}. <p>(UNIT) The initiating {DCSGroup#Group}.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2629,7 +2614,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<p> (UNIT) The initiating Group name.</p> <p>(UNIT) The initiating Group name.</p>
</dd> </dd>
</dl> </dl>
@ -2643,8 +2628,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The initiating &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The initiating <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2658,7 +2642,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<p> (UNIT/STATIC) The initiating Unit name.</p> <p>(UNIT/STATIC) The initiating Unit name.</p>
</dd> </dd>
</dl> </dl>
@ -2672,8 +2656,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The initiating MOOSE wrapper &lt;a href="Wrapper.Group.html##(GROUP)"&gt;Wrapper.Group#GROUP&lt;/a&gt; of the initiator Group object. <p>(UNIT) The initiating MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the initiator Group object.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2687,8 +2670,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The initiating GROUP name (same as IniDCSGroupName). <p>UNIT) The initiating GROUP name (same as IniDCSGroupName).</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2716,8 +2698,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code>(UNIT) The name of the initiating player in case the Unit is a client or player slot. <p>(UNIT) The name of the initiating player in case the Unit is a client or player slot.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2731,8 +2712,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The type name of the initiator. <p>(UNIT) The type name of the initiator.</p>
</code></pre>
</dd> </dd>
@ -2747,8 +2727,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The initiating MOOSE wrapper &lt;a href="Wrapper.Unit.html##(UNIT)"&gt;Wrapper.Unit#UNIT&lt;/a&gt; of the initiator Unit object. <p>(UNIT/STATIC) The initiating MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the initiator Unit object.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2762,8 +2741,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName). <p>(UNIT/STATIC) The initiating UNIT name (same as IniDCSUnitName).</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2777,8 +2755,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The category of the target. <p>(UNIT) The category of the target.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2792,8 +2769,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The coalition of the target. <p>(UNIT) The coalition of the target.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2807,8 +2783,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The target {Dcs.DCSGroup#Group}. <p>(UNIT) The target {DCSGroup#Group}.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2822,7 +2797,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<p> (UNIT) The target Group name.</p> <p>(UNIT) The target Group name.</p>
</dd> </dd>
</dl> </dl>
@ -2836,8 +2811,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The target &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The target <a href="DCSUnit.html##(Unit)">DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2851,7 +2825,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<p> (UNIT/STATIC) The target Unit name.</p> <p>(UNIT/STATIC) The target Unit name.</p>
</dd> </dd>
</dl> </dl>
@ -2865,8 +2839,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The target MOOSE wrapper &lt;a href="Wrapper.Group.html##(GROUP)"&gt;Wrapper.Group#GROUP&lt;/a&gt; of the target Group object. <p>(UNIT) The target MOOSE wrapper <a href="Group.html##(GROUP)">Group#GROUP</a> of the target Group object.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2880,8 +2853,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The target GROUP name (same as TgtDCSGroupName). <p>(UNIT) The target GROUP name (same as TgtDCSGroupName).</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2895,8 +2867,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ). <p>(UNIT/STATIC) The target object category ( Object.Category.UNIT or Object.Category.STATIC ).</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2910,8 +2881,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code>(UNIT) The name of the target player in case the Unit is a client or player slot. <p>(UNIT) The name of the target player in case the Unit is a client or player slot.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2925,8 +2895,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT) The type name of the target. <p>(UNIT) The type name of the target.</p>
</code></pre>
</dd> </dd>
@ -2941,8 +2910,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The target MOOSE wrapper &lt;a href="Wrapper.Unit.html##(UNIT)"&gt;Wrapper.Unit#UNIT&lt;/a&gt; of the target Unit object. <p>(UNIT/STATIC) The target MOOSE wrapper <a href="Unit.html##(UNIT)">Unit#UNIT</a> of the target Unit object.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -2956,8 +2924,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName). <p>(UNIT/STATIC) The target UNIT name (same as TgtDCSUnitName).</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -3025,8 +2992,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC/SCENERY) The initiating &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC/SCENERY) The initiating <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="Dcs.DCSStaticObject.html##(StaticObject)">Dcs.DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</dd> </dd>
</dl> </dl>
@ -3040,8 +3006,7 @@ Note that at the beginning of each field description, there is an indication whi
</dt> </dt>
<dd> <dd>
<pre><code> (UNIT/STATIC) The target &lt;a href="Dcs.DCSUnit.html##(Unit)"&gt;Dcs.DCSUnit#Unit&lt;/a&gt; or &lt;a href="Dcs.DCSStaticObject.html##(StaticObject)"&gt;Dcs.DCSStaticObject#StaticObject&lt;/a&gt;. <p>(UNIT/STATIC) The target <a href="Dcs.DCSUnit.html##(Unit)">Dcs.DCSUnit#Unit</a> or <a href="DCSStaticObject.html##(StaticObject)">DCSStaticObject#StaticObject</a>.</p>
</code></pre>
</dd> </dd>
</dl> </dl>

9
docs/Documentation/Spawn.html
View File

@ -1765,9 +1765,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> </dd>
</dl> </dl>
<dl class="function"> <dl class="function">
@ -2242,7 +2239,7 @@ when nothing was spawned.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em>#number</em> <em></em>
<a id="#(SPAWN).SpawnMaxGroups" > <a id="#(SPAWN).SpawnMaxGroups" >
<strong>SPAWN.SpawnMaxGroups</strong> <strong>SPAWN.SpawnMaxGroups</strong>
</a> </a>
@ -2259,7 +2256,7 @@ when nothing was spawned.</p>
<dl class="function"> <dl class="function">
<dt> <dt>
<em>#number</em> <em></em>
<a id="#(SPAWN).SpawnMaxUnitsAlive" > <a id="#(SPAWN).SpawnMaxUnitsAlive" >
<strong>SPAWN.SpawnMaxUnitsAlive</strong> <strong>SPAWN.SpawnMaxUnitsAlive</strong>
</a> </a>
@ -2562,7 +2559,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p> <p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
</dd> </dd>
</dl> </dl>