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

Auto commit by GitHub Actions Workflow

Browse Source
This commit is contained in:
MooseBotter
2024-03-13 08:11:22 +00:00
parent 363aa95165
commit 491c3d17d2
28 changed files with 952 additions and 514 deletions
Download Patch File Download Diff File Expand all files Collapse all files

81
Documentation/Utilities.Utils.html
View File

@@ -2121,6 +2121,12 @@
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).ClampAngle">UTILS.ClampAngle(value)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Clamp an angle so that it's always between 0 and 360 while still being correct</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(UTILS).ClockHeadingString">UTILS.ClockHeadingString(refHdg, tgtHdg)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the clock position from a relative heading</p>
</td>
</tr>
<tr class="w3-border">
@@ -3850,6 +3856,81 @@ use negative idp for rounding ahead of decimal place, positive for rounding afte
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(UTILS).ClockHeadingString" ><strong>UTILS.ClockHeadingString(refHdg, tgtHdg)</strong></a></h2>
</div>
<p>Get the clock position from a relative heading</p>
<div id= "#Functions##ClockHeadingString" 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</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>refHdg</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The heading of the reference object (such as a Wrapper.UNIT) in 0-360</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>tgtHdg</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The absolute heading from the reference object to the target object/point in 0-360</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>text Text in clock heading such as "4 O'CLOCK"</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>Display the range and clock distance of a BTR in relation to REAPER 1-1's heading:
myUnit = UNIT:FindByName( "REAPER 1-1" )
myTarget = GROUP:FindByName( "BTR-1" )
coordUnit = myUnit:GetCoordinate()
coordTarget = myTarget:GetCoordinate()
hdgUnit = myUnit:GetHeading()
hdgTarget = coordUnit:HeadingTo( coordTarget )
distTarget = coordUnit:Get3DDistance( coordTarget )
clockString = UTILS.ClockHeadingString( hdgUnit, hdgTarget )
-- Will show this message to REAPER 1-1 in-game: Contact BTR at 3 o'clock for 1134m!
MESSAGE:New("Contact BTR at " .. clockString .. " for " .. distTarget .. "m!):ToUnit( myUnit )</code></pre>
</div>
</div>
</div>