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
@@ -1543,32 +1543,32 @@ Controls a network of short range air/missile defense groups.</p>
|
||||
<h1>Create a Marker</h1>
|
||||
|
||||
<pre><code>-- Create a MARKER object at Batumi with a trivial text.
|
||||
local Coordinate=AIRBASE:FindByName("Batumi"):GetCoordinate()
|
||||
mymarker=MARKER:New(Coordinate, "I am Batumi Airfield")
|
||||
local Coordinate = AIRBASE:FindByName( "Batumi" ):GetCoordinate()
|
||||
mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" )
|
||||
</code></pre>
|
||||
|
||||
<p>Now this does <strong>not</strong> show the marker yet. We still need to specifiy to whom it is shown. There are several options, i.e.
|
||||
show the marker to everyone, to a speficic coaliton only, or only to a specific group.</p>
|
||||
<p>Now this does <strong>not</strong> show the marker yet. We still need to specify to whom it is shown. There are several options, i.e.
|
||||
show the marker to everyone, to a specific coalition only, or only to a specific group.</p>
|
||||
|
||||
<h2>For Everyone</h2>
|
||||
|
||||
<p>If the marker should be visible to everyone, you can use the :ToAll() function.</p>
|
||||
|
||||
<pre><code>mymarker=MARKER:New(Coordinate, "I am Batumi Airfield"):ToAll()
|
||||
<pre><code>mymarker = MARKER:New( Coordinate, "I am Batumi Airfield" ):ToAll()
|
||||
</code></pre>
|
||||
|
||||
<h2>For a Coaliton</h2>
|
||||
<h2>For a Coalition</h2>
|
||||
|
||||
<p>If the maker should be visible to a specific coalition, you can use the :ToCoalition() function.</p>
|
||||
|
||||
<pre><code>mymarker=MARKER:New(Coordinate, "I am Batumi Airfield"):ToCoaliton(coaliton.side.BLUE)
|
||||
<pre><code>mymarker = MARKER:New( Coordinate , "I am Batumi Airfield" ):ToCoalition( coalition.side.BLUE )
|
||||
</code></pre>
|
||||
|
||||
<h3>To Blue Coaliton</h3>
|
||||
<h3>To Blue Coalition</h3>
|
||||
|
||||
<h3>To Red Coalition</h3>
|
||||
|
||||
<p>This would show the marker only to the Blue coaliton.</p>
|
||||
<p>This would show the marker only to the Blue coalition.</p>
|
||||
|
||||
<h2>For a Group</h2>
|
||||
|
||||
@@ -1580,31 +1580,31 @@ show the marker to everyone, to a speficic coaliton only, or only to a specific
|
||||
|
||||
<p>The marker text and coordinate can be updated easily as shown below.</p>
|
||||
|
||||
<p>However, note that <strong>updateing involves to remove and recreate the marker if either text or its coordinate is changed</strong>.
|
||||
<p>However, note that <strong>updating involves to remove and recreate the marker if either text or its coordinate is changed</strong>.
|
||||
<em>This is a DCS scripting engine limitation.</em></p>
|
||||
|
||||
<h2>Update Text</h2>
|
||||
|
||||
<p>If you created a marker "mymarker" as shown above, you can update the dispayed test by</p>
|
||||
<p>If you created a marker "mymarker" as shown above, you can update the displayed test by</p>
|
||||
|
||||
<pre><code>mymarker:UpdateText("I am the new text at Batumi")
|
||||
<pre><code>mymarker:UpdateText( "I am the new text at Batumi" )
|
||||
</code></pre>
|
||||
|
||||
<p>The update can also be delayed by, e.g. 90 seconds, using</p>
|
||||
|
||||
<pre><code>mymarker:UpdateText("I am the new text at Batumi", 90)
|
||||
<pre><code>mymarker:UpdateText( "I am the new text at Batumi", 90 )
|
||||
</code></pre>
|
||||
|
||||
<h2>Update Coordinate</h2>
|
||||
|
||||
<p>If you created a marker "mymarker" as shown above, you can update its coordinate on the F10 map by</p>
|
||||
|
||||
<pre><code>mymarker:UpdateCoordinate(NewCoordinate)
|
||||
<pre><code>mymarker:UpdateCoordinate( NewCoordinate )
|
||||
</code></pre>
|
||||
|
||||
<p>The update can also be delayed by, e.g. 60 seconds, using</p>
|
||||
|
||||
<pre><code>mymarker:UpdateCoordinate(NewCoordinate, 60)
|
||||
<pre><code>mymarker:UpdateCoordinate( NewCoordinate , 60 )
|
||||
</code></pre>
|
||||
|
||||
<h1>Retrieve Data</h1>
|
||||
@@ -1613,20 +1613,20 @@ show the marker to everyone, to a speficic coaliton only, or only to a specific
|
||||
|
||||
<h2>Text</h2>
|
||||
|
||||
<pre><code>local text=mymarker:GetText()
|
||||
env.info("Marker Text = " .. text)
|
||||
<pre><code>local text =mymarker:GetText()
|
||||
env.info( "Marker Text = " .. text )
|
||||
</code></pre>
|
||||
|
||||
<h2>Coordinate</h2>
|
||||
|
||||
<pre><code>local Coordinate=mymarker:GetCoordinate()
|
||||
env.info("Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS())
|
||||
<pre><code>local Coordinate = mymarker:GetCoordinate()
|
||||
env.info( "Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS() )
|
||||
</code></pre>
|
||||
|
||||
|
||||
<h1>FSM Events</h1>
|
||||
|
||||
<p>Moose creates addditonal events, so called FSM event, when markers are added, changed, removed, and text or the coordianteis updated.</p>
|
||||
<p>Moose creates additional events, so called FSM event, when markers are added, changed, removed, and text or the coordinate is updated.</p>
|
||||
|
||||
<p>These events can be captured and used for processing via OnAfter functions as shown below.</p>
|
||||
|
||||
@@ -1644,7 +1644,6 @@ env.info("Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS())
|
||||
<h1>Examples</h1>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -1946,7 +1945,7 @@ env.info("Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS())
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MARKER).message">MARKER.message</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Message dispayed when the mark is added.</p>
|
||||
<p>Message displayed when the mark is added.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -2016,7 +2015,7 @@ env.info("Marker Coordinate LL DSM = " .. Coordinate:ToStringLLDMS())
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MARKER).tocoaliton">MARKER.tocoaliton</a></p></td>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(MARKER).tocoalition">MARKER.tocoalition</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
|
||||
</td>
|
||||
@@ -2940,7 +2939,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
#string
|
||||
<a id="#(MARKER).message" ><strong>MARKER.message</strong></a>
|
||||
|
||||
<p>Message dispayed when the mark is added.</p>
|
||||
<p>Message displayed when the mark is added.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -4143,7 +4142,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Coalition 1=Red, 2=Blue, 0=Neutral. See <code>coaliton.side.RED</code>.</p>
|
||||
<p>Coalition 1=Red, 2=Blue, 0=Neutral. See <code>coalition.side.RED</code>.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
@@ -5046,7 +5045,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
#string
|
||||
<a id="#(MARKER).message" ><strong>MARKER.message</strong></a>
|
||||
|
||||
<p>Message dispayed when the mark is added.</p>
|
||||
<p>Message displayed when the mark is added.</p>
|
||||
|
||||
</div>
|
||||
|
||||
@@ -6660,7 +6659,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
|
||||
#string
|
||||
<a id="#(MARKER).message" ><strong>MARKER.message</strong></a>
|
||||
|
||||
<p>Message dispayed when the mark is added.</p>
|
||||
<p>Message displayed when the mark is added.</p>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user