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
@@ -3108,6 +3108,12 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).VecTranslate">UTILS.VecTranslate(a, distance, angle)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Translate 3D vector in the 2D (x,z) plane.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).Weather">UTILS.Weather</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3186,6 +3192,61 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).tostringMGRS">UTILS.tostringMGRS(MGRS, acc)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(UTILS.Weather)">Type <strong>UTILS.Weather</strong></a></h2></div>
|
||||
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
||||
<strong><a href="##(UTILS.Weather)">UTILS.Weather</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 UTILS.Weather</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="##(UTILS.Weather).GetFogThickness">UTILS.Weather.GetFogThickness()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the current fog thickness in meters.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).GetFogVisibilityDistanceMax">UTILS.Weather.GetFogVisibilityDistanceMax()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Gets the maximum visibility distance of the current fog setting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).RemoveFog">UTILS.Weather.RemoveFog()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Removes the fog.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).SetFogAnimation">UTILS.Weather.SetFogAnimation(AnimationKeys)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p> Uses data from the passed table to change the fog visibility and thickness over a desired timeframe.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).SetFogThickness">UTILS.Weather.SetFogThickness(Thickness)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the fog to the desired thickness in meters at sea level. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).SetFogVisibilityDistance">UTILS.Weather.SetFogVisibilityDistance(Thickness)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the maximum visibility at sea level in meters.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS.Weather).StopFogAnimation">UTILS.Weather.StopFogAnimation()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>The fog animation will be discarded and whatever the current thickness and visibility are set to will remain</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -3653,6 +3714,17 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
|
||||
<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 href="##(UTILS.Weather)">#UTILS.Weather</a>
|
||||
<a id="#(UTILS).Weather" ><strong>UTILS.Weather</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
@@ -12541,6 +12613,232 @@ So:
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div onclick="myFunction('#Types##UTILS.Weather')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(UTILS.Weather)">Type <strong>UTILS.Weather</strong></a></h2></div>
|
||||
<div id= "#Types##UTILS.Weather" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
||||
<div class="w3-white" id="record_type">
|
||||
|
||||
<p>Utilities weather class for fog mainly.</p>
|
||||
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS.Weather).GetFogThickness" ><strong>UTILS.Weather.GetFogThickness()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the current fog thickness in meters.</p>
|
||||
|
||||
|
||||
<p>Returns zero if fog is not present. </p>
|
||||
|
||||
<div id= "#Functions##GetFogThickness" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS.Weather).GetFogVisibilityDistanceMax" ><strong>UTILS.Weather.GetFogVisibilityDistanceMax()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Gets the maximum visibility distance of the current fog setting.</p>
|
||||
|
||||
|
||||
<p>Returns 0 if no fog is present. </p>
|
||||
|
||||
<div id= "#Functions##GetFogVisibilityDistanceMax" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS.Weather).RemoveFog" ><strong>UTILS.Weather.RemoveFog()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Removes the fog.</p>
|
||||
|
||||
<div id= "#Functions##RemoveFog" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS.Weather).SetFogAnimation" ><strong>UTILS.Weather.SetFogAnimation(AnimationKeys)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p> Uses data from the passed table to change the fog visibility and thickness over a desired timeframe.</p>
|
||||
|
||||
|
||||
<p>This allows for a gradual increase/decrease of fog values rather than abruptly applying the values.
|
||||
Animation Key Format: {time, visibility, thickness}</p>
|
||||
|
||||
<div id= "#Functions##SetFogAnimation" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#table
|
||||
<strong><strong>AnimationKeys</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Table of AnimationKey tables</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2><strong>Usage:</strong></h2>
|
||||
<pre class="example"><code>Time: in seconds 0 to infinity
|
||||
Time is relative to when the function was called. Time value for each key must be larger than the previous key. If time is set to 0 then the fog will be applied to the corresponding visibility and thickness values at that key. Any time value greater than 0 will result in the current fog being inherited and changed to the first key.
|
||||
Visibility: in meters 100 to 100000
|
||||
Thickness: in meters 100 to 5000
|
||||
The speed at which the visibility and thickness changes is based on the time between keys and the values that visibility and thickness are being set to.
|
||||
|
||||
When the function is passed an empty table {} or nil the fog animation will be discarded and whatever the current thickness and visibility are set to will remain.
|
||||
|
||||
The following will set the fog in the mission to disappear in 1 minute.
|
||||
|
||||
UTILS.Weather.SetFogAnimation({ {60, 0, 0} })
|
||||
|
||||
The following will take 1 hour to get to the first fog setting, it will maintain that fog setting for another hour, then lightly removes the fog over the 2nd and 3rd hour, the completely removes the fog after 3 hours and 3 minutes from when the function was called.
|
||||
|
||||
UTILS.Weather.SetFogAnimation({
|
||||
{3600, 10000, 3000}, -- one hour to get to that fog setting
|
||||
{7200, 10000, 3000}, -- will maintain for 2 hours
|
||||
{10800, 20000, 2000}, -- at 3 hours visibility will have been increased while thickness decreases slightly
|
||||
{12600, 0, 0}, -- at 3:30 after the function was called the fog will be completely removed.
|
||||
})
|
||||
</code></pre>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(UTILS.Weather).SetFogThickness" ><strong>UTILS.Weather.SetFogThickness(Thickness)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the fog to the desired thickness in meters at sea level. </p>
|
||||
|
||||
<div id= "#Functions##SetFogThickness" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Thickness</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Thickness in meters.
|
||||
Any fog animation will be discarded.
|
||||
Valid range : 100 to 5000 meters</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="#(UTILS.Weather).SetFogVisibilityDistance" ><strong>UTILS.Weather.SetFogVisibilityDistance(Thickness)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the maximum visibility at sea level in meters.</p>
|
||||
|
||||
<div id= "#Functions##SetFogVisibilityDistance" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>Thickness</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Thickness in meters.
|
||||
Limit: 100 to 100000 </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="#(UTILS.Weather).StopFogAnimation" ><strong>UTILS.Weather.StopFogAnimation()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>The fog animation will be discarded and whatever the current thickness and visibility are set to will remain</p>
|
||||
|
||||
<div id= "#Functions##StopFogAnimation" 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>UTILS.Weather</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user