mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
Auto commit by GitHub Actions Workflow
This commit is contained in:
MooseBotter
@@ -838,7 +838,7 @@
|
||||
<div class="w3-col s12 m6 l4">
|
||||
<div class="w3-card-4 w3-white w3-margin-16">
|
||||
<div class="w3-display-container w3-text-white w3-text-shadow">
|
||||
<img src= "../Images/ClientWatch.JPG" alt="Image">
|
||||
<img src= "../Images/clientwatch.jpg" alt="Image">
|
||||
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ClientWatch.html">Functional.ClientWatch</a></strong></h2></div>
|
||||
</div>
|
||||
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
||||
@@ -1702,7 +1702,7 @@
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<img src="..\Images\ClientWatch.JPG" alt="Banner Image"/>
|
||||
<img src="..\Images\clientwatch.jpg" alt="Banner Image"/>
|
||||
<div id="content">
|
||||
<div class="w3-container w3-theme-d5" id="module_title">
|
||||
<h1>Module <strong>Functional.ClientWatch</strong></h1>
|
||||
@@ -1794,7 +1794,7 @@
|
||||
|
||||
<pre><code> -- Create an instance with a client unit prefix and send them a message when they spawn
|
||||
local clientInstance = CLIENTWATCH:New("Rotary")
|
||||
function clientInstance:OnAfterSpawn(From,Event,To,ClientObject)
|
||||
function clientInstance:OnAfterSpawn(From,Event,To,ClientObject,EventData)
|
||||
MESSAGE:New("Welcome to your aircraft!",10):ToUnit(ClientObject.Unit)
|
||||
end
|
||||
</code></pre>
|
||||
@@ -1839,7 +1839,7 @@
|
||||
|
||||
<pre><code> -- Show a message to player when they take damage from a weapon
|
||||
local clientInstance = CLIENTWATCH:New("Rotary")
|
||||
function clientInstance:OnAfterSpawn(From,Event,To,ClientObject)
|
||||
function clientInstance:OnAfterSpawn(From,Event,To,ClientObject,EventData)
|
||||
function ClientObject:OnAfterHit(From,Event,To,EventData)
|
||||
local typeShooter = EventData.IniTypeName
|
||||
local nameWeapon = EventData.weapon_name
|
||||
@@ -1909,13 +1909,43 @@
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).New">CLIENTWATCH:New(,, client)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).DebugEventData">CLIENTWATCH.DebugEventData</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).FilterByCategory">CLIENTWATCH:FilterByCategory(Category, Category, value)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Filter out all clients that are not of the given category</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).FilterByCoalition">CLIENTWATCH:FilterByCoalition(Coalition, Coalition, value)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Filter out all clients not belonging to the provided coalition</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).FilterCategory">CLIENTWATCH.FilterCategory</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If not nil, will only activate for aircraft of the given category value.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).FilterCoalition">CLIENTWATCH.FilterCoalition</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>If not nil, will only activate for aircraft of the given coalition value.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).New">CLIENTWATCH:New(Will, Put, Provide, Leave, client)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Creates a new instance of CLIENTWATCH to add scripts to.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).OnAfterSpawn">CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).OnAfterSpawn">CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject, eventdata)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>User function for OnAfter "Spawn" event.</p>
|
||||
</td>
|
||||
@@ -2824,25 +2854,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENTWATCH).onEvent">CLIENTWATCH:onEvent(event)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>The main event handling function...</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(EVENTS.Birth)">Type <strong>EVENTS.Birth</strong></a></h2></div>
|
||||
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
||||
<strong><a href="##(EVENTS.Birth)">EVENTS.Birth</a></strong>
|
||||
</div>
|
||||
<div class="w3-card w3-margin">
|
||||
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
||||
<tr class="w3-theme-l1">
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from EVENTS.Birth</th>
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(EVENTS.Birth).Unit">EVENTS.Birth.Unit</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -2886,6 +2897,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CLIENTWATCH).DebugEventData" ><strong>CLIENTWATCH.DebugEventData</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCategory" ><strong>CLIENTWATCH.FilterCategory</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given category value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCoalition" ><strong>CLIENTWATCH.FilterCoalition</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given coalition value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -2915,7 +2959,119 @@ 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="#(CLIENTWATCH).New" ><strong>CLIENTWATCH:New(,, client)</strong></a></h2>
|
||||
<h2><a id="#(CLIENTWATCH).FilterByCategory" ><strong>CLIENTWATCH:FilterByCategory(Category, Category, value)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Filter out all clients that are not of the given category</p>
|
||||
|
||||
<div id= "#Functions##FilterByCategory" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CLIENTWATCH</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Category</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>number (0 = airplane, 1 = helicopter)</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Category</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>string ('airplane' or 'helicopter')</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<strong><strong>value</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CLIENTWATCH).FilterByCoalition" ><strong>CLIENTWATCH:FilterByCoalition(Coalition, Coalition, value)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Filter out all clients not belonging to the provided coalition</p>
|
||||
|
||||
<div id= "#Functions##FilterByCoalition" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>CLIENTWATCH</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Coalition</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>number (1 = red, 2 = blue)</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Coalition</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>string ('red' or 'blue')</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<strong><strong>value</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(CLIENTWATCH).New" ><strong>CLIENTWATCH:New(Will, Put, Provide, Leave, client)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Creates a new instance of CLIENTWATCH to add scripts to.</p>
|
||||
@@ -2934,12 +3090,51 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>,</strong></strong>
|
||||
<strong><strong>Will</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<h1>table, or Wrapper.Client#CLIENT client Takes multiple inputs. If provided a #string, it will watch for clients whos UNIT NAME or GROUP NAME matches part of the #string as a prefix. You can also provide it with a #table containing multiple #string prefixes. Lastly, you can provide it with a Wrapper.Client#CLIENT of the specific client you want to apply this to.</h1>
|
||||
<p>watch for clients whos UNIT NAME or GROUP NAME matches part of the #string as a prefix.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>Put</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>strings in a table to use multiple prefixes for the above method.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
||||
<strong><strong>Provide</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>a Moose CLIENT object to apply to that specific aircraft slot (static slots only!)</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#nil
|
||||
<strong><strong>Leave</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>blank to activate for ALL CLIENTS</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -2972,7 +3167,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="#(CLIENTWATCH).OnAfterSpawn" ><strong>CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject)</strong></a></h2>
|
||||
<h2><a id="#(CLIENTWATCH).OnAfterSpawn" ><strong>CLIENTWATCH:OnAfterSpawn(Controllable, From, Event, To, clientObject, eventdata)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>User function for OnAfter "Spawn" event.</p>
|
||||
@@ -3047,6 +3242,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
<p>Custom object that handles events and stores Moose object data. See top documentation for more details.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>eventdata</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Data from EVENTS.Birth.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -3078,6 +3286,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CLIENTWATCH).DebugEventData" ><strong>CLIENTWATCH.DebugEventData</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCategory" ><strong>CLIENTWATCH.FilterCategory</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given category value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCoalition" ><strong>CLIENTWATCH.FilterCoalition</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given coalition value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -3679,6 +3920,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CLIENTWATCH).DebugEventData" ><strong>CLIENTWATCH.DebugEventData</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCategory" ><strong>CLIENTWATCH.FilterCategory</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given category value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCoalition" ><strong>CLIENTWATCH.FilterCoalition</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given coalition value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -5168,6 +5442,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#boolean
|
||||
<a id="#(CLIENTWATCH).DebugEventData" ><strong>CLIENTWATCH.DebugEventData</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCategory" ><strong>CLIENTWATCH.FilterCategory</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given category value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#number
|
||||
<a id="#(CLIENTWATCH).FilterCoalition" ><strong>CLIENTWATCH.FilterCoalition</strong></a>
|
||||
|
||||
<p>If not nil, will only activate for aircraft of the given coalition value.</p>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
@@ -8583,36 +8890,13 @@ When moose is loading dynamically (for moose class development), tracing is swit
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div onclick="myFunction('#Types##EVENTS.Birth')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(EVENTS.Birth)">Type <strong>EVENTS.Birth</strong></a></h2></div>
|
||||
<div id= "#Types##EVENTS.Birth" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
||||
<div class="w3-white" id="record_type">
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
|
||||
<a id="#(EVENTS.Birth).Unit" ><strong>EVENTS.Birth.Unit</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<script>
|
||||
function myLoadFunction() {
|
||||
document.getElementById("myHeader").style.backgroundImage = "url('../Images/ClientWatch.JPG')";
|
||||
document.getElementById("myHeader").style.backgroundImage = "url('../Images/clientwatch.jpg')";
|
||||
}
|
||||
</script>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user