mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1605,7 +1605,7 @@
|
||||
|
||||
|
||||
|
||||
<p>Encapsules <strong>multiplayer</strong> environment scripting functions from <a href="https://wiki.hoggitworld.com/view/DCS_singleton_net">net</a></p>
|
||||
<p>Encapsules <strong>multiplayer server</strong> environment scripting functions from <a href="https://wiki.hoggitworld.com/view/DCS_singleton_net">net</a></p>
|
||||
|
||||
<hr/>
|
||||
|
||||
@@ -1676,6 +1676,12 @@ with some added FSM functions and options to block/unblock players in MP environ
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).BlockedPilots">NET.BlockedPilots</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="##(NET).BlockedUCIDs">NET.BlockedUCIDs</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1709,15 +1715,15 @@ with some added FSM functions and options to block/unblock players in MP environ
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerIDFromClient">NET:GetPlayerIDFromClient(Client)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerIDByName">NET:GetPlayerIDByName(Name)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Find the PlayerID from a CLIENT object.</p>
|
||||
<p>Find the PlayerID by name</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerIdByName">NET:GetPlayerIdByName(Name)</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerIDFromClient">NET:GetPlayerIDFromClient(Client)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Find the PlayerID by name</p>
|
||||
<p>Find the PlayerID from a CLIENT object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1736,6 +1742,12 @@ with some added FSM functions and options to block/unblock players in MP environ
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerStatistic">NET:GetPlayerStatistic(Client, StatisticID)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Return a statistic for a given client.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).GetPlayerUCID">NET:GetPlayerUCID(Client, Name)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Get player UCID from player CLIENT object or player name.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -1849,19 +1861,19 @@ with some added FSM functions and options to block/unblock players in MP environ
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).SetBlockMessage">NET:SetBlockMessage(Text)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Set block chat message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).SetBlockTime">NET:SetBlockTime(Seconds)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Set block time in seconds.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NET).SetUnblockMessage">NET:SetUnblockMessage(Text)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
<p>Set unblock chat message.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2756,6 +2768,17 @@ 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">
|
||||
|
||||
#table
|
||||
<a id="#(NET).BlockedUCIDs" ><strong>NET.BlockedUCIDs</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3116,12 +3139,12 @@ 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="#(NET).GetPlayerIDFromClient" ><strong>NET:GetPlayerIDFromClient(Client)</strong></a></h2>
|
||||
<h2><a id="#(NET).GetPlayerIDByName" ><strong>NET:GetPlayerIDByName(Name)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Find the PlayerID from a CLIENT object.</p>
|
||||
<p>Find the PlayerID by name</p>
|
||||
|
||||
<div id= "#Functions##GetPlayerIDFromClient" class="w3-show w3-white">
|
||||
<div id= "#Functions##GetPlayerIDByName" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
@@ -3131,13 +3154,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<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>Client</strong></strong>
|
||||
#string
|
||||
<strong><strong>Name</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The client</p>
|
||||
<p>The player name whose ID to find</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -3160,12 +3183,12 @@ 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="#(NET).GetPlayerIdByName" ><strong>NET:GetPlayerIdByName(Name)</strong></a></h2>
|
||||
<h2><a id="#(NET).GetPlayerIDFromClient" ><strong>NET:GetPlayerIDFromClient(Client)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Find the PlayerID by name</p>
|
||||
<p>Find the PlayerID from a CLIENT object.</p>
|
||||
|
||||
<div id= "#Functions##GetPlayerIdByName" class="w3-show w3-white">
|
||||
<div id= "#Functions##GetPlayerIDFromClient" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
@@ -3175,13 +3198,13 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Name</strong></strong>
|
||||
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
||||
<strong><strong>Client</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The player name whose ID to find</p>
|
||||
<p>The client</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -3377,6 +3400,66 @@ net.PS_EJECT (7) - of ejects
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(NET).GetPlayerUCID" ><strong>NET:GetPlayerUCID(Client, Name)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Get player UCID from player CLIENT object or player name.</p>
|
||||
|
||||
|
||||
<p>Provide either one. </p>
|
||||
|
||||
<div id= "#Functions##GetPlayerUCID" 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>NET</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>
|
||||
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
||||
<strong><strong>Client</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The client object to be used.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Name</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Player name to be used.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>success</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -4489,7 +4572,7 @@ net.PS_EJECT (7) - of ejects
|
||||
<h2><a id="#(NET).SetBlockMessage" ><strong>NET:SetBlockMessage(Text)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
<p>Set block chat message.</p>
|
||||
|
||||
<div id= "#Functions##SetBlockMessage" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4501,13 +4584,27 @@ net.PS_EJECT (7) - of ejects
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Text</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The message</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(NET)">#NET</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4519,7 +4616,7 @@ net.PS_EJECT (7) - of ejects
|
||||
<h2><a id="#(NET).SetBlockTime" ><strong>NET:SetBlockTime(Seconds)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
<p>Set block time in seconds.</p>
|
||||
|
||||
<div id= "#Functions##SetBlockTime" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4531,13 +4628,27 @@ net.PS_EJECT (7) - of ejects
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Seconds</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>Numnber of seconds this block will last. Defaults to 600.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(NET)">#NET</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4549,7 +4660,7 @@ net.PS_EJECT (7) - of ejects
|
||||
<h2><a id="#(NET).SetUnblockMessage" ><strong>NET:SetUnblockMessage(Text)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
|
||||
<p>Set unblock chat message.</p>
|
||||
|
||||
<div id= "#Functions##SetUnblockMessage" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
@@ -4561,13 +4672,27 @@ net.PS_EJECT (7) - of ejects
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>Text</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
<p></p>
|
||||
|
||||
<p>The message</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(NET)">#NET</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>self</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -4718,6 +4843,17 @@ net.PS_EJECT (7) - of ejects
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#table
|
||||
<a id="#(NET).BlockedUCIDs" ><strong>NET.BlockedUCIDs</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -6251,6 +6387,17 @@ net.PS_EJECT (7) - of ejects
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
#table
|
||||
<a id="#(NET).BlockedUCIDs" ><strong>NET.BlockedUCIDs</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user