mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2026-07-16 14:23:02 +00:00
14542 lines
500 KiB
HTML
14542 lines
500 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-97385487-1"></script>
|
|
<script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'UA-97385487-1');</script>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="https://www.w3schools.com/lib/w3-theme-indigo.css">
|
|
<link rel="stylesheet" href="../Highlight/styles/github.css">
|
|
<script src="../Highlight/highlight.pack.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
<link rel="stylesheet" href="w3.css" type="text/css"/>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
|
|
<style>
|
|
.picturebox {
|
|
height:100px;
|
|
}
|
|
|
|
</style>
|
|
</head>
|
|
<body onload="myLoadFunction()" >
|
|
<div id="myHeader" class="w3-container sticky w3-border-white w3-bottombar" style="background-image:url('../Images/MOOSE.JPG');">
|
|
<h1>
|
|
<i class="fa fa-bars w3-text-white fa-2x" onclick="w3_open()"></i>
|
|
</h1>
|
|
</div>
|
|
<div id="main">
|
|
<nav class="w3-sidenav w3-theme-l5 w3-animate-left" style="display:none">
|
|
<a href="javascript:void(0)"
|
|
onclick="w3_close()"
|
|
class="w3-closenav w3-large">Close ×</a>
|
|
<div class="w3-row">
|
|
<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/CORE_Astar.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Astar.html">Core.Astar</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - A* Pathfinding.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Base.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Base.html">Core.Base</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - The base class within the framework.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Beacon.html">Core.Beacon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - TACAN and other beacons.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Menu.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ClientMenu.html">Core.ClientMenu</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Client Menu Management.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Condition.html">Core.Condition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define any or all conditions to be evaluated.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Database.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Database.html">Core.Database</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manages several databases containing templates, mission objects, and mission information.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Event.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Event.html">Core.Event</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models DCS event dispatching using a publish-subscribe model.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Finite_State_Machine.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Fsm.html">Core.Fsm</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Goal.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Goal.html">Core.Goal</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models the process to achieve goal(s).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE_Core.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.MarkerOps_Base.html">Core.MarkerOps_Base</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Tap into markers added to the F10 map by users.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Menu.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Menu.html">Core.Menu</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manage hierarchical menu structures and commands for players within a mission.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Message.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Message.html">Core.Message</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Informs the players using messages during a simulation.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/CORE_Pathline.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Pathline.html">Core.Pathline</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Path from A to B.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Coordinate.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Point.html">Core.Point</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Report.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Report.html">Core.Report</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Provides a handy means to create messages and reports.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Schedule_Dispatcher.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ScheduleDispatcher.html">Core.ScheduleDispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<ul>
|
|
<li><strong>Core</strong> - SCHEDULEDISPATCHER dispatches the different schedules.</li>
|
|
</ul>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Scheduler.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Scheduler.html">Core.Scheduler</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Prepares and handles the execution of functions over scheduled time (intervals).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Sets.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Set.html">Core.Set</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define collections of objects to perform bulk actions and logically group objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Settings.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Settings.html">Core.Settings</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manages various settings for missions, providing a menu for players to tweak settings in running missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Spawn.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spawn.html">Core.Spawn</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Spawn dynamically new groups of units in running missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Spawnstatic.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.SpawnStatic.html">Core.SpawnStatic</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Spawn statics.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Spot.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spot.html">Core.Spot</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.TextAndSound.html">Core.TextAndSound</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - A Moose GetText system.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Scheduler.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Timer scheduler.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Userflag.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserFlag.html">Core.UserFlag</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manage user flags to interact with the mission editor trigger system and server side scripts.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/CORE_Vector.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Vector.html">Core.Vector</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>CORE</strong> - Vector algebra.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Velocity.html">Core.Velocity</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models a velocity or speed, which can be expressed in various formats according the settings.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Zones.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone.html">Core.Zone</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define zones within your mission of various forms, with various capabilities.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone_Detection.html">Core.Zone_Detection</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="DCS.html">DCS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>DCS API</strong> Prototypes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AICSAR.html">Functional.AICSAR</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - AI CSAR system.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Air_Traffic_Control_Ground_Operations.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ATC_Ground.html">Functional.ATC_Ground</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Monitor airbase traffic and regulate speed while taxiing.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Artillery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AmmoTruck.html">Functional.AmmoTruck</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> -- Send a truck to supply artillery groups.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Artillery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Artillery.html">Functional.Artillery</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Control artillery units.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Designation.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Autolase.html">Functional.Autolase</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Autolase targets in the field.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/CleanUp_Airbases.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.CleanUp.html">Functional.CleanUp</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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">
|
|
<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>
|
|
<p><strong>Functional</strong> - Manage and track client slots easily to add your own client-based menus and modules to.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Designation.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Designate.html">Functional.Designate</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Management of target <strong>Designation</strong>.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Detection.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Detection.html">Functional.Detection</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Models the detection of enemy units by FACs or RECCEs and group them according various methods.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.DetectionZones.html">Functional.DetectionZones</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Captures the class DETECTION_ZONES.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Escorting.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Escort.html">Functional.Escort</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Taking the lead of AI escorting your flight.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/AI_Large_Formations.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.FORMATION.html">Functional.FORMATION</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Build large airborne formations of aircraft.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Functional_FOX.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Fox.html">Functional.Fox</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Yet Another Missile Trainer.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Functional.Mantis.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Mantis.html">Functional.Mantis</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Movement.html">Functional.Movement</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Limit the movement of simulaneous moving ground vehicles.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Pseudo_ATC.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.PseudoATC.html">Functional.PseudoATC</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Basic ATC.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/RAT.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.RAT.html">Functional.RAT</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Create random air traffic in your missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Range.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Range.html">Functional.Range</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Range Practice.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Scoring.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Scoring.html">Functional.Scoring</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Administer the scoring of player achievements, file and log the scoring events for use at websites.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/SEAD.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Sead.html">Functional.Sead</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Make SAM sites evasive and execute defensive behaviour when being fired upon.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Functional.Shorad.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Shorad.html">Functional.Shorad</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Short Range Air Defense System.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Functional.Stratego.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Stratego.html">Functional.Stratego</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Stratego.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Suppression.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Suppression.html">Functional.Suppression</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Suppress fire of ground units when they get hit.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Functional.Tiresias.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Tiresias.html">Functional.Tiresias</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Warehouse.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Warehouse.html">Functional.Warehouse</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Simulation of logistic operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Capture_Zones.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneCaptureCoalition.html">Functional.ZoneCaptureCoalition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Models the process to zone guarding and capturing.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoal.html">Functional.ZoneGoal</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Base class that models processes to achieve goals involving a Zone.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoalCoalition.html">Functional.ZoneGoalCoalition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional (WIP)</strong> - Base class modeling processes to achieve goals involving coalition zones.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Beacons.html">Navigation.Beacons</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Beacons of the map/theatre.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Point.html">Navigation.Point</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Navigation Airspace Points, Fixes and Aids.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Radios.html">Navigation.Radios</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Airbase radios.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Towns.html">Navigation.Towns</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Towns of the map/theatre.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_FlightControl.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="OPS.FlightControl.html">OPS.FlightControl</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>OPS</strong> - Air Traffic Control for AI and human players.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_ATIS.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ATIS.html">Ops.ATIS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_AWACS.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.AWACS.html">Ops.AWACS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - MOOSE AI AWACS Operations using text-to-speech.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Ops_Airboss.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airboss.html">Ops.Airboss</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_AirWing.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airwing.html">Ops.Airwing</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Airwing Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_ArmyGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ArmyGroup.html">Ops.ArmyGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Ground Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Auftrag.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Auftrag.html">Ops.Auftrag</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Brigade_.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Brigade.html">Ops.Brigade</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Brigade Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_CSAR.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CSAR.html">Ops.CSAR</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Combat Search and Rescue.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_CTLD.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CTLD.html">Ops.CTLD</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Combat Troops & Logistics Department.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Chief.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Chief.html">Ops.Chief</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Chief of Staff.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Cohort.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Cohort.html">Ops.Cohort</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Cohort encompassed all characteristics of SQUADRONs, PLATOONs and FLOTILLAs.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Commander.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Commander.html">Ops.Commander</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Commander of Airwings, Brigades and Fleets.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/AI_Air_To_Ground_Dispatching.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.EasyAG.html">Ops.EasyAG</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Create your A2G Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/AI_Combat_Air_Patrol.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.EasyGCICAP.html">Ops.EasyGCICAP</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Create your A2A Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Fleet.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Fleet.html">Ops.Fleet</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Fleet Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_FlightGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.FlightGroup.html">Ops.FlightGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Airborne Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Flotilla.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Flotilla.html">Ops.Flotilla</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Flotilla is a small naval group belonging to a fleet.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Intel.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Intel.html">Ops.Intel</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Office of Military Intelligence.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Legion.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Legion.html">Ops.Legion</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Legion Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_NavyGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.NavyGroup.html">Ops.NavyGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Naval Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Operation.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Operation.html">Ops.Operation</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Operation with multiple phases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_OpsGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsGroup.html">Ops.OpsGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Generic group enhancement.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_OpsTransport.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsTransport.html">Ops.OpsTransport</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Transport assignment for OPS groups and storage.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_OpsZone.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsZone.html">Ops.OpsZone</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Strategic Zone.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Platoon.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Platoon.html">Ops.Platoon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Brigade Platoon.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Ops_PlayerRecce.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerRecce.html">Ops.PlayerRecce</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Allow a player in a helo like the Gazelle, KA-50 to recon and lase ground targets.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_PlayerTask.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerTask.html">Ops.PlayerTask</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - PlayerTask (mission) for Players.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Ops_RecoveryTanker.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RecoveryTanker.html">Ops.RecoveryTanker</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Recovery tanker for carrier operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Ops_RescueHelo.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RescueHelo.html">Ops.RescueHelo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Rescue helicopter for carrier operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Squadron.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Squadron.html">Ops.Squadron</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Airwing Squadron.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Ops_PlayerRecce.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.TARS.html">Ops.TARS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/OPS_Target.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Target.html">Ops.Target</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Target.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.CUBE.html">Shapes.CUBE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.LINE.html">Shapes.LINE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.OVAL.html">Shapes.OVAL</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.POLYGON.html">Shapes.POLYGON</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/CORE_Pathline.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.SHAPE_BASE.html">Shapes.SHAPE_BASE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Shapes</strong> - Class that serves as the base shapes drawn in the Mission Editor</p>
|
|
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.TRIANGLE.html">Shapes.TRIANGLE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p>TRIANGLE class with properties and methods for handling triangles.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.Radio.html">Sound.Radio</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Radio transmissions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioQueue.html">Sound.RadioQueue</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Queues Radio Transmissions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioSpeech.html">Sound.RadioSpeech</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Makes the radio talk.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Sound_MSRS.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SRS.html">Sound.SRS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Simple Radio Standalone (SRS) Integration and Text-to-Speech.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Sound_SoundOutput.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SoundOutput.html">Sound.SoundOutput</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Sound output classes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Core_Usersound.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.UserSound.html">Sound.UserSound</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Manage user sound.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Enums.html">Utilities.Enums</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> Enumerators.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.FiFo.html">Utilities.FiFo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p> <strong>UTILS</strong> - Classic FiFo Stack.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Utils_Profiler.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Profiler.html">Utilities.Profiler</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utils</strong> - Lua Profiler.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Socket.html">Utilities.Socket</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - Socket.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Utils.html">Utilities.Utils</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Airbase.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Airbase.html">Wrapper.Airbase</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - AIRBASE is a wrapper class to handle the DCS Airbase objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Client.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Client.html">Wrapper.Client</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - CLIENT wraps DCS Unit objects acting as a <strong>Client</strong> or <strong>Player</strong> within a mission.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Controllable.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Controllable.html">Wrapper.Controllable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Storage.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.DynamicCargo.html">Wrapper.DynamicCargo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Dynamic Cargo create from the F8 menu.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Group.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Group.html">Wrapper.Group</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - GROUP wraps the DCS Class Group objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Identifiable.html">Wrapper.Identifiable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE_Core.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Markers On the F10 map.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Utils_Profiler.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Net.html">Wrapper.Net</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - DCS net functions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Object.html">Wrapper.Object</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - OBJECT wraps the DCS Object derived objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Positionable.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Positionable.html">Wrapper.Positionable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - POSITIONABLE wraps DCS classes that are "positionable".</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Scenery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Scenery.html">Wrapper.Scenery</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - SCENERY models scenery within the DCS simulator.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Static.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Static.html">Wrapper.Static</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - STATIC wraps the DCS StaticObject class.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Storage.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Storage.html">Wrapper.Storage</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Warehouse storage of DCS airbases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Unit.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Unit.html">Wrapper.Unit</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - UNIT is a wrapper class for the DCS Class Unit.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<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/Wrapper_Weapon.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Weapon.html">Wrapper.Weapon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Weapon functions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<img src="..\Images\MOOSE.JPG" alt="Banner Image"/>
|
|
<div id="content">
|
|
<div class="w3-container w3-theme-d5" id="module_title">
|
|
<h1>Module <strong>Navigation.Point</strong></h1>
|
|
</div>
|
|
<div class="w3-container w3-white" id="module_description">
|
|
|
|
<p><strong>NAVIGATION</strong> - Navigation Airspace Points, Fixes and Aids.</p>
|
|
|
|
|
|
|
|
<p><strong>Main Features:</strong></p>
|
|
|
|
<ul>
|
|
<li>Navigation Fixes</li>
|
|
<li>Navigation Aids</li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
<h2>Example Missions:</h2>
|
|
|
|
<p>Demo missions can be found on <a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Navigation%20-%20NavFix">github</a>.</p>
|
|
|
|
<hr/>
|
|
|
|
<h3>Author: <strong>funkyfranky</strong></h3>
|
|
|
|
<hr/>
|
|
|
|
</div>
|
|
<div class="w3-container w3-theme-d2"><h2><strong>Global(s)</strong></h2></div>
|
|
<div class="w3-theme-d2 w3-margin-top ">
|
|
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##NAVAID')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>NAVAID</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p><em>A fleet of British ships at war are the best negotiators.</em> -- Horatio Nelson</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The NAVAID Concept</h1>
|
|
|
|
<p>A NAVAID consists of one or multiple FLOTILLAs.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##NAVAID" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(NAVAID)">#NAVAID</a>
|
|
<a id="NAVAID" ><strong>NAVAID</strong></a>
|
|
|
|
<p><em>A fleet of British ships at war are the best negotiators.</em> -- Horatio Nelson</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The NAVAID Concept</h1>
|
|
|
|
<p>A NAVAID consists of one or multiple FLOTILLAs.</p>
|
|
|
|
|
|
<p>These flotillas "live" in a WAREHOUSE that has a phyiscal struction (STATIC or UNIT) and can be captured or destroyed.</p>
|
|
|
|
<h1>Basic Setup</h1>
|
|
|
|
<p>A new <code>NAVAID</code> object can be created with the <a href="##(NAVAID).New">NAVAID.New</a>(<code>WarehouseName</code>, <code>FleetName</code>) function, where <code>WarehouseName</code> is the name of the static or unit object hosting the fleet
|
|
and <code>FleetName</code> is the name you want to give the fleet. This must be <em>unique</em>!</p>
|
|
|
|
<pre><code>myFleet=NAVAID:New("myWarehouseName", "1st Fleet")
|
|
myFleet:SetPortZone(ZonePort1stFleet)
|
|
myFleet:Start()
|
|
</code></pre>
|
|
|
|
<p>A fleet needs a <em>port zone</em>, which is set via the <a href="##(NAVAID).SetPortZone">NAVAID.SetPortZone</a>(<code>PortZone</code>) function. This is the zone where the naval assets are spawned and return to.</p>
|
|
|
|
<p>Finally, the fleet needs to be started using the <a href="##(NAVAID).Start">NAVAID.Start</a>() function. If the fleet is not started, it will not process any requests.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-theme-d2 w3-margin-top ">
|
|
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##NAVFIX')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>NAVFIX</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p><em>A fleet of British ships at war are the best negotiators.</em> -- Horatio Nelson</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The NAVFIX Concept</h1>
|
|
|
|
<p>The NAVFIX class has a great concept!</p>
|
|
|
|
<p>A NAVFIX describes a geo position and can, <em>e.g.</em>, be part of a FLIGHTPLAN.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##NAVFIX" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(NAVFIX)">#NAVFIX</a>
|
|
<a id="NAVFIX" ><strong>NAVFIX</strong></a>
|
|
|
|
<p><em>A fleet of British ships at war are the best negotiators.</em> -- Horatio Nelson</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The NAVFIX Concept</h1>
|
|
|
|
<p>The NAVFIX class has a great concept!</p>
|
|
|
|
<p>A NAVFIX describes a geo position and can, <em>e.g.</em>, be part of a FLIGHTPLAN.</p>
|
|
|
|
|
|
<p>It has a unique name and is of a certain type, <em>e.g.</em> "Intersection", "VOR", "Airbase" etc.
|
|
It can also have further properties as min/max altitudes and speeds that aircraft need to obey when they pass the point.</p>
|
|
|
|
<h1>Basic Setup</h1>
|
|
|
|
<p>A new <code>NAVFIX</code> object can be created with the <a href="##(NAVFIX).New">NAVFIX.New</a>() function.</p>
|
|
|
|
<pre><code>myNavPoint=NAVFIX:New()
|
|
myTemplate:SetXYZ(X, Y, Z)
|
|
</code></pre>
|
|
|
|
<p>This is how it works.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><strong>Type(s)</strong></h2></div>
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(NAVAID)">Type <strong>NAVAID</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(NAVAID)">NAVAID</a></strong>
|
|
, extends <strong><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></strong>
|
|
, extends <strong><a href="Core.Base.html##(BASE)">Core.Base#BASE</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 NAVAID</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="##(NAVAID).ClassName">NAVAID.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromScenery">NAVAID:NewFromScenery(Name, Type, ZoneName, SceneryName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVAID class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetChannel">NAVAID:SetChannel(Channel, Band)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set channel of, <em>e.g.</em>, TACAN beacons.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetFrequency">NAVAID:SetFrequency(Frequency)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set frequency the beacon transmits on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).alias">NAVAID.alias</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="##(NAVAID).band">NAVAID.band</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="##(NAVAID).channel">NAVAID.channel</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="##(NAVAID).frequency">NAVAID.frequency</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="##(NAVAID).lid">NAVAID.lid</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="##(NAVAID).scenery">NAVAID.scenery</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="##(NAVAID).verbose">NAVAID.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Verbosity of output.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).version">NAVAID.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>NAVAID class version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).zone">NAVAID.zone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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 NAVFIX</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="##(NAVAID).ClassName">NAVAID.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetAltitude">NAVAID:GetAltitude()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the altitude in feet MSL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetSpeed">NAVAID:GetSpeed()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the speed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).MarkerRemove">NAVAID:MarkerRemove()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove marker of the NAVFIX from the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).MarkerShow">NAVAID:MarkerShow()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add marker the NAVFIX on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromBeacon">NAVAID:NewFromBeacon(Beacon)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from BEACONS.Beacon data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromCoordinate">NAVAID:NewFromCoordinate(Name, Type, Coordinate)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from a given COORDINATE.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromLLDD">NAVAID:NewFromLLDD(Name, Type, Latitude, Longitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromLLDMS">NAVAID:NewFromLLDMS(Name, Type, Latitude, Longitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromNavFix">NAVAID:NewFromNavFix(Name, Type, NavFix, Distance, Bearing, Reciprocal)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance relative to a given other NAVFIX.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).NewFromVector">NAVAID:NewFromVector(Name, Type, Vector)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from a given VECTOR.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetAltMandatory">NAVAID:SetAltMandatory(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set mandatory altitude (min alt = max alt).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetAltMax">NAVAID:SetAltMax(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set maximum altitude.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetAltMin">NAVAID:SetAltMin(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set minimum altitude.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetCompulsory">NAVAID:SetCompulsory(Compulsory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this fix is compulsory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetFinalApproachFix">NAVAID:SetFinalApproachFix(FinalApproachFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetFlyOver">NAVAID:SetFlyOver(FlyOver)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is a fly-over fix fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetInitialApproachFix">NAVAID:SetInitialApproachFix(IntermediateFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is an initial approach fix (IAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetIntermediateFix">NAVAID:SetIntermediateFix(IntermediateFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the intermediate fix (IF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetMissedApproachFix">NAVAID:SetMissedApproachFix(FinalApproachFix, MissedApproachFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetSpeedMandatory">NAVAID:SetSpeedMandatory(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set mandatory speed (min speed = max speed) at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetSpeedMax">NAVAID:SetSpeedMax(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set maximum allowed speed at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetSpeedMin">NAVAID:SetSpeedMin(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set minimum allowed speed at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).Type">NAVAID.Type</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="##(NAVAID)._GetMarkerText">NAVAID:_GetMarkerText()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get text displayed in the F10 marker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).altMax">NAVAID.altMax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum altitude in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).altMin">NAVAID.altMin</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Minimum altitude in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isCompulsory">NAVAID.isCompulsory</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a compulsory fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isFAF">NAVAID.isFAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a final approach fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isFlyover">NAVAID.isFlyover</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a flyover fix (<code>true</code>) or turning point otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isIAF">NAVAID.isIAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial approach fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isIF">NAVAID.isIF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).isMAF">NAVAID.isMAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial fix.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).lid">NAVAID.lid</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="##(NAVAID).marker">NAVAID.marker</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Marker on F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).name">NAVAID.name</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the point.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).speedMax">NAVAID.speedMax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum speed in knots.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).speedMin">NAVAID.speedMin</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Minimum speed in knots.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).typePoint">NAVAID.typePoint</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Type of the point, *e.g. "Intersection", "VOR", "Airport".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).vector">NAVAID.vector</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Position vector of the fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).verbose">NAVAID.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Verbosity of output.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).version">NAVAID.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>NAVFIX class version.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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 BASE</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="##(NAVAID).ClassID">NAVAID.ClassID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The ID number of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).ClassName">NAVAID.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).ClassNameAndID">NAVAID.ClassNameAndID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The name of the class concatenated with the ID number of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).ClearState">NAVAID:ClearState(Object, StateName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Clear the state of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventBirth">NAVAID:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Birth Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventCrash">NAVAID:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventDead">NAVAID:CreateEventDead(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Dead Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventDynamicCargoLoaded">NAVAID:CreateEventDynamicCargoLoaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventDynamicCargoRemoved">NAVAID:CreateEventDynamicCargoRemoved(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventDynamicCargoUnloaded">NAVAID:CreateEventDynamicCargoUnloaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventNewDynamicCargo">NAVAID:CreateEventNewDynamicCargo(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventPlayerEnterAircraft">NAVAID:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventRemoveUnit">NAVAID:CreateEventRemoveUnit(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Remove Unit Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventTakeoff">NAVAID:CreateEventTakeoff(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Takeoff Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).CreateEventUnitLost">NAVAID:CreateEventUnitLost(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).E">NAVAID:E(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Log an exception which will be traced always.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).EventDispatcher">NAVAID:EventDispatcher()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the event dispatcher</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).EventRemoveAll">NAVAID:EventRemoveAll()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove all subscribed events</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).F">NAVAID:F(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).F2">NAVAID:F2(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call level 2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).F3">NAVAID:F3(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call level 3.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetClassID">NAVAID:GetClassID()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassID of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetClassName">NAVAID:GetClassName()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassName of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetClassNameAndID">NAVAID:GetClassNameAndID()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassName + ClassID of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetEventPriority">NAVAID:GetEventPriority()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetParent">NAVAID:GetParent(Child, FromClass)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetProperties">NAVAID:GetProperties()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetProperty">NAVAID:GetProperty(Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get one property of an object by the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).GetState">NAVAID:GetState(Object, Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).HandleEvent">NAVAID:HandleEvent(EventID, EventFunction)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subscribe to a DCS Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).I">NAVAID:I(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Log an information which will be traced always.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).Inherit">NAVAID:Inherit(Child, Parent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to inherit from a parent class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).IsInstanceOf">NAVAID:IsInstanceOf(ClassName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).IsTrace">NAVAID:IsTrace()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Enquires if tracing is on (for the class).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).New">NAVAID:New()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BASE constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEvent">NAVAID:OnEvent(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventBDA">NAVAID:OnEventBDA(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BDA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventBaseCaptured">NAVAID:OnEventBaseCaptured(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventBirth">NAVAID:OnEventBirth(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventCrash">NAVAID:OnEventCrash(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDead">NAVAID:OnEventDead(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an object is dead.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDetailedFailure">NAVAID:OnEventDetailedFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDiscardChairAfterEjection">NAVAID:OnEventDiscardChairAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Discard chair after ejection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDynamicCargoLoaded">NAVAID:OnEventDynamicCargoLoaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDynamicCargoRemoved">NAVAID:OnEventDynamicCargoRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventDynamicCargoUnloaded">NAVAID:OnEventDynamicCargoUnloaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventEjection">NAVAID:OnEventEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventEngineShutdown">NAVAID:OnEventEngineShutdown(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventEngineStartup">NAVAID:OnEventEngineStartup(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventHit">NAVAID:OnEventHit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventHumanFailure">NAVAID:OnEventHumanFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventKill">NAVAID:OnEventKill(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs on the death of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventLand">NAVAID:OnEventLand(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventLandingAfterEjection">NAVAID:OnEventLandingAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventLandingQualityMark">NAVAID:OnEventLandingQualityMark(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Landing quality mark.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventMarkAdded">NAVAID:OnEventMarkAdded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a new mark was added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventMarkChange">NAVAID:OnEventMarkChange(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark text was changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventMarkRemoved">NAVAID:OnEventMarkRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark was removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventMissionEnd">NAVAID:OnEventMissionEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventMissionStart">NAVAID:OnEventMissionStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventNewDynamicCargo">NAVAID:OnEventNewDynamicCargo(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventParatrooperLanding">NAVAID:OnEventParatrooperLanding(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Weapon add.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventPilotDead">NAVAID:OnEventPilotDead(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventPlayerEnterAircraft">NAVAID:OnEventPlayerEnterAircraft(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventPlayerEnterUnit">NAVAID:OnEventPlayerEnterUnit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventPlayerLeaveUnit">NAVAID:OnEventPlayerLeaveUnit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventRefueling">NAVAID:OnEventRefueling(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventRefuelingStop">NAVAID:OnEventRefuelingStop(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventScore">NAVAID:OnEventScore(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventShootingEnd">NAVAID:OnEventShootingEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventShootingStart">NAVAID:OnEventShootingStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventShot">NAVAID:OnEventShot(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventTakeoff">NAVAID:OnEventTakeoff(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventTriggerZone">NAVAID:OnEventTriggerZone(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).OnEventUnitLost">NAVAID:OnEventUnitLost(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).Properties">NAVAID.Properties</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="##(NAVAID).ScheduleOnce">NAVAID:ScheduleOnce(Start, SchedulerFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Schedule a new time event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).ScheduleRepeat">NAVAID:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Schedule a new time event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).ScheduleStop">NAVAID:ScheduleStop(SchedulerID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Stops the Schedule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).Scheduler">NAVAID.Scheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The scheduler object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetEventPriority">NAVAID:SetEventPriority(EventPriority)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetProperty">NAVAID:SetProperty(Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set one property of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).SetState">NAVAID:SetState(Object, Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).T">NAVAID:T(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).T2">NAVAID:T2(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).T3">NAVAID:T3(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 3.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceAll">NAVAID:TraceAll(TraceAll)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace all methods in MOOSE</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceClass">NAVAID:TraceClass(Class)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set tracing for a class</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceClassMethod">NAVAID:TraceClassMethod(Class, Method)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set tracing for a specific method of class</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceLevel">NAVAID:TraceLevel(Level)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace level</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceOff">NAVAID:TraceOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceOn">NAVAID:TraceOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).TraceOnOff">NAVAID:TraceOnOff(TraceOnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on or off
|
|
Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
|
|
When Moose is loaded statically, (as one file), tracing is switched off by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).UnHandleEvent">NAVAID:UnHandleEvent(EventID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID)._">NAVAID._</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="##(NAVAID)._F">NAVAID:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID)._Serialize">NAVAID:_Serialize(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>(Internal) Serialize arguments</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID)._T">NAVAID:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVAID).__">NAVAID.__</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="##(NAVAID).onEvent">NAVAID: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="#(NAVFIX)">Type <strong>NAVFIX</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(NAVFIX)">NAVFIX</a></strong>
|
|
, extends <strong><a href="Core.Base.html##(BASE)">Core.Base#BASE</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 NAVFIX</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="##(NAVFIX).ClassName">NAVFIX.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetAltitude">NAVFIX:GetAltitude()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the altitude in feet MSL.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetSpeed">NAVFIX:GetSpeed()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the speed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).MarkerRemove">NAVFIX:MarkerRemove()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove marker of the NAVFIX from the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).MarkerShow">NAVFIX:MarkerShow()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add marker the NAVFIX on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromBeacon">NAVFIX:NewFromBeacon(Beacon)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from BEACONS.Beacon data.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromCoordinate">NAVFIX:NewFromCoordinate(Name, Type, Coordinate)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from a given COORDINATE.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromLLDD">NAVFIX:NewFromLLDD(Name, Type, Latitude, Longitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromLLDMS">NAVFIX:NewFromLLDMS(Name, Type, Latitude, Longitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromNavFix">NAVFIX:NewFromNavFix(Name, Type, NavFix, Distance, Bearing, Reciprocal)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance relative to a given other NAVFIX.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).NewFromVector">NAVFIX:NewFromVector(Name, Type, Vector)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new NAVFIX class instance from a given VECTOR.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetAltMandatory">NAVFIX:SetAltMandatory(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set mandatory altitude (min alt = max alt).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetAltMax">NAVFIX:SetAltMax(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set maximum altitude.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetAltMin">NAVFIX:SetAltMin(Altitude)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set minimum altitude.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetCompulsory">NAVFIX:SetCompulsory(Compulsory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this fix is compulsory.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetFinalApproachFix">NAVFIX:SetFinalApproachFix(FinalApproachFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetFlyOver">NAVFIX:SetFlyOver(FlyOver)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is a fly-over fix fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetInitialApproachFix">NAVFIX:SetInitialApproachFix(IntermediateFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is an initial approach fix (IAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetIntermediateFix">NAVFIX:SetIntermediateFix(IntermediateFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the intermediate fix (IF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetMissedApproachFix">NAVFIX:SetMissedApproachFix(FinalApproachFix, MissedApproachFix)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetSpeedMandatory">NAVFIX:SetSpeedMandatory(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set mandatory speed (min speed = max speed) at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetSpeedMax">NAVFIX:SetSpeedMax(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set maximum allowed speed at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetSpeedMin">NAVFIX:SetSpeedMin(Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set minimum allowed speed at this fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).Type">NAVFIX.Type</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="##(NAVFIX)._GetMarkerText">NAVFIX:_GetMarkerText()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get text displayed in the F10 marker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).altMax">NAVFIX.altMax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum altitude in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).altMin">NAVFIX.altMin</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Minimum altitude in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isCompulsory">NAVFIX.isCompulsory</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a compulsory fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isFAF">NAVFIX.isFAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a final approach fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isFlyover">NAVFIX.isFlyover</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this a flyover fix (<code>true</code>) or turning point otherwise.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isIAF">NAVFIX.isIAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial approach fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isIF">NAVFIX.isIF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).isMAF">NAVFIX.isMAF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is this an initial fix.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).lid">NAVFIX.lid</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="##(NAVFIX).marker">NAVFIX.marker</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Marker on F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).name">NAVFIX.name</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the point.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).speedMax">NAVFIX.speedMax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum speed in knots.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).speedMin">NAVFIX.speedMin</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Minimum speed in knots.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).typePoint">NAVFIX.typePoint</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Type of the point, *e.g. "Intersection", "VOR", "Airport".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).vector">NAVFIX.vector</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Position vector of the fix.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).verbose">NAVFIX.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Verbosity of output.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).version">NAVFIX.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>NAVFIX class version.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</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 BASE</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="##(NAVFIX).ClassID">NAVFIX.ClassID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The ID number of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).ClassName">NAVFIX.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).ClassNameAndID">NAVFIX.ClassNameAndID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The name of the class concatenated with the ID number of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).ClearState">NAVFIX:ClearState(Object, StateName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Clear the state of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventBirth">NAVFIX:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Birth Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventCrash">NAVFIX:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventDead">NAVFIX:CreateEventDead(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Dead Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventDynamicCargoLoaded">NAVFIX:CreateEventDynamicCargoLoaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventDynamicCargoRemoved">NAVFIX:CreateEventDynamicCargoRemoved(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventDynamicCargoUnloaded">NAVFIX:CreateEventDynamicCargoUnloaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventNewDynamicCargo">NAVFIX:CreateEventNewDynamicCargo(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventPlayerEnterAircraft">NAVFIX:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventRemoveUnit">NAVFIX:CreateEventRemoveUnit(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Remove Unit Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventTakeoff">NAVFIX:CreateEventTakeoff(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Takeoff Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).CreateEventUnitLost">NAVFIX:CreateEventUnitLost(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).E">NAVFIX:E(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Log an exception which will be traced always.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).EventDispatcher">NAVFIX:EventDispatcher()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the event dispatcher</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).EventRemoveAll">NAVFIX:EventRemoveAll()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove all subscribed events</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).F">NAVFIX:F(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).F2">NAVFIX:F2(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call level 2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).F3">NAVFIX:F3(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call level 3.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetClassID">NAVFIX:GetClassID()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassID of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetClassName">NAVFIX:GetClassName()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassName of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetClassNameAndID">NAVFIX:GetClassNameAndID()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the ClassName + ClassID of the class instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetEventPriority">NAVFIX:GetEventPriority()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetParent">NAVFIX:GetParent(Child, FromClass)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetProperties">NAVFIX:GetProperties()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetProperty">NAVFIX:GetProperty(Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get one property of an object by the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).GetState">NAVFIX:GetState(Object, Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).HandleEvent">NAVFIX:HandleEvent(EventID, EventFunction)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subscribe to a DCS Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).I">NAVFIX:I(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Log an information which will be traced always.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).Inherit">NAVFIX:Inherit(Child, Parent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to inherit from a parent class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).IsInstanceOf">NAVFIX:IsInstanceOf(ClassName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).IsTrace">NAVFIX:IsTrace()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Enquires if tracing is on (for the class).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).New">NAVFIX:New()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BASE constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEvent">NAVFIX:OnEvent(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventBDA">NAVFIX:OnEventBDA(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BDA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventBaseCaptured">NAVFIX:OnEventBaseCaptured(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventBirth">NAVFIX:OnEventBirth(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventCrash">NAVFIX:OnEventCrash(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDead">NAVFIX:OnEventDead(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an object is dead.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDetailedFailure">NAVFIX:OnEventDetailedFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDiscardChairAfterEjection">NAVFIX:OnEventDiscardChairAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Discard chair after ejection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDynamicCargoLoaded">NAVFIX:OnEventDynamicCargoLoaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDynamicCargoRemoved">NAVFIX:OnEventDynamicCargoRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventDynamicCargoUnloaded">NAVFIX:OnEventDynamicCargoUnloaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventEjection">NAVFIX:OnEventEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventEngineShutdown">NAVFIX:OnEventEngineShutdown(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventEngineStartup">NAVFIX:OnEventEngineStartup(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventHit">NAVFIX:OnEventHit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventHumanFailure">NAVFIX:OnEventHumanFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventKill">NAVFIX:OnEventKill(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs on the death of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventLand">NAVFIX:OnEventLand(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventLandingAfterEjection">NAVFIX:OnEventLandingAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventLandingQualityMark">NAVFIX:OnEventLandingQualityMark(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Landing quality mark.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventMarkAdded">NAVFIX:OnEventMarkAdded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a new mark was added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventMarkChange">NAVFIX:OnEventMarkChange(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark text was changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventMarkRemoved">NAVFIX:OnEventMarkRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark was removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventMissionEnd">NAVFIX:OnEventMissionEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventMissionStart">NAVFIX:OnEventMissionStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventNewDynamicCargo">NAVFIX:OnEventNewDynamicCargo(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventParatrooperLanding">NAVFIX:OnEventParatrooperLanding(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Weapon add.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventPilotDead">NAVFIX:OnEventPilotDead(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventPlayerEnterAircraft">NAVFIX:OnEventPlayerEnterAircraft(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventPlayerEnterUnit">NAVFIX:OnEventPlayerEnterUnit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventPlayerLeaveUnit">NAVFIX:OnEventPlayerLeaveUnit(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventRefueling">NAVFIX:OnEventRefueling(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventRefuelingStop">NAVFIX:OnEventRefuelingStop(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventScore">NAVFIX:OnEventScore(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventShootingEnd">NAVFIX:OnEventShootingEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventShootingStart">NAVFIX:OnEventShootingStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventShot">NAVFIX:OnEventShot(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventTakeoff">NAVFIX:OnEventTakeoff(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventTriggerZone">NAVFIX:OnEventTriggerZone(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).OnEventUnitLost">NAVFIX:OnEventUnitLost(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).Properties">NAVFIX.Properties</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="##(NAVFIX).ScheduleOnce">NAVFIX:ScheduleOnce(Start, SchedulerFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Schedule a new time event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).ScheduleRepeat">NAVFIX:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Schedule a new time event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).ScheduleStop">NAVFIX:ScheduleStop(SchedulerID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Stops the Schedule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).Scheduler">NAVFIX.Scheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The scheduler object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetEventPriority">NAVFIX:SetEventPriority(EventPriority)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetProperty">NAVFIX:SetProperty(Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set one property of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).SetState">NAVFIX:SetState(Object, Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).T">NAVFIX:T(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 1.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).T2">NAVFIX:T2(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 2.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).T3">NAVFIX:T3(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic level 3.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceAll">NAVFIX:TraceAll(TraceAll)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace all methods in MOOSE</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceClass">NAVFIX:TraceClass(Class)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set tracing for a class</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceClassMethod">NAVFIX:TraceClassMethod(Class, Method)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set tracing for a specific method of class</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceLevel">NAVFIX:TraceLevel(Level)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace level</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceOff">NAVFIX:TraceOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceOn">NAVFIX:TraceOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).TraceOnOff">NAVFIX:TraceOnOff(TraceOnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on or off
|
|
Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
|
|
When Moose is loaded statically, (as one file), tracing is switched off by default.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).UnHandleEvent">NAVFIX:UnHandleEvent(EventID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX)._">NAVFIX._</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="##(NAVFIX)._F">NAVFIX:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function call.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX)._Serialize">NAVFIX:_Serialize(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>(Internal) Serialize arguments</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX)._T">NAVFIX:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trace a function logic.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX).__">NAVFIX.__</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="##(NAVFIX).onEvent">NAVFIX: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="#(NAVFIX.Type)">Type <strong>NAVFIX.Type</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(NAVFIX.Type)">NAVFIX.Type</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 NAVFIX.Type</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="##(NAVFIX.Type).AIRPORT">NAVFIX.Type.AIRPORT</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).DME">NAVFIX.Type.DME</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Distance Measuring Equipment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).ILS">NAVFIX.Type.ILS</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Instrument Landing System.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).INTERSECTION">NAVFIX.Type.INTERSECTION</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Intersection of airway.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).LOC">NAVFIX.Type.LOC</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Localizer.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).NDB">NAVFIX.Type.NDB</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Non-Directional Beacon.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).POINT">NAVFIX.Type.POINT</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Waypoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).TACAN">NAVFIX.Type.TACAN</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>TACtical Air Navigation System (TACAN).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).VOR">NAVFIX.Type.VOR</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Very High Frequency Omnidirectional Range Station.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(NAVFIX.Type).VORDME">NAVFIX.Type.VORDME</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Combined VHF omnidirectional range (VOR) with a distance-measuring equipment (DME).</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Navigation.Point)" >Type <strong>Navigation.Point</strong></a></h2></div>
|
|
<div class="w3-container w3-white w3-padding-16" id="module_current_type">
|
|
<div class="w3-white" id="record_type">
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##NAVAID')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(NAVAID)">Type <strong>NAVAID</strong></a></h2></div>
|
|
<div id= "#Types##NAVAID" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>NAVAID class.</p>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVAID).ClassName" ><strong>NAVAID.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).alias" ><strong>NAVAID.alias</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Alias. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).channel" ><strong>NAVAID.channel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).frequency" ><strong>NAVAID.frequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).lid" ><strong>NAVAID.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).scenery" ><strong>NAVAID.scenery</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVAID).verbose" ><strong>NAVAID.verbose</strong></a>
|
|
|
|
<p>Verbosity of output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVAID).version" ><strong>NAVAID.version</strong></a>
|
|
|
|
<p>NAVAID class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).zone" ><strong>NAVAID.zone</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set zone.</p>
|
|
|
|
</div>
|
|
|
|
</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="#(NAVAID).NewFromScenery" ><strong>NAVAID:NewFromScenery(Name, Type, ZoneName, SceneryName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVAID class instance.</p>
|
|
|
|
<div id= "#Functions##NewFromScenery" 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>NAVAID</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name/ident of this navaid.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ZoneName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the zone to scan the scenery.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>SceneryName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the scenery object.</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="##(NAVAID)">#NAVAID</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetChannel" ><strong>NAVAID:SetChannel(Channel, Band)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set channel of, <em>e.g.</em>, TACAN beacons.</p>
|
|
|
|
<div id= "#Functions##SetChannel" 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>NAVAID</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>Channel</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The channel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Band</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The band either <code>"X"</code> (default) or <code>"Y"</code>. </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="##(NAVAID)">#NAVAID</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetFrequency" ><strong>NAVAID:SetFrequency(Frequency)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set frequency the beacon transmits on.</p>
|
|
|
|
<div id= "#Functions##SetFrequency" 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>NAVAID</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>Frequency</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Frequency in Hz.</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="##(NAVAID)">#NAVAID</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVAID).ClassName" ><strong>NAVAID.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).alias" ><strong>NAVAID.alias</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Alias. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).channel" ><strong>NAVAID.channel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).frequency" ><strong>NAVAID.frequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).lid" ><strong>NAVAID.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).scenery" ><strong>NAVAID.scenery</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVAID).verbose" ><strong>NAVAID.verbose</strong></a>
|
|
|
|
<p>Verbosity of output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVAID).version" ><strong>NAVAID.version</strong></a>
|
|
|
|
<p>NAVAID class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).zone" ><strong>NAVAID.zone</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set zone.</p>
|
|
|
|
</div>
|
|
|
|
</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="#(NAVAID).GetAltitude" ><strong>NAVAID:GetAltitude()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the altitude in feet MSL.</p>
|
|
|
|
|
|
<p>If min and max altitudes are set, it will return a random altitude between min and max.</p>
|
|
|
|
<div id= "#Functions##GetAltitude" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Altitude in feet MSL. Can be <code>nil</code>, if neither min nor max altitudes have beeen set. </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="#(NAVAID).GetSpeed" ><strong>NAVAID:GetSpeed()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the speed.</p>
|
|
|
|
|
|
<p>If min and max speeds are set, it will return a random speed between min and max.</p>
|
|
|
|
<div id= "#Functions##GetSpeed" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Speed in knots. Can be <code>nil</code>, if neither min nor max speeds have beeen set. </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="#(NAVAID).MarkerRemove" ><strong>NAVAID:MarkerRemove()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove marker of the NAVFIX from the F10 map.</p>
|
|
|
|
<div id= "#Functions##MarkerRemove" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).MarkerShow" ><strong>NAVAID:MarkerShow()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add marker the NAVFIX on the F10 map.</p>
|
|
|
|
<div id= "#Functions##MarkerShow" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromBeacon" ><strong>NAVAID:NewFromBeacon(Beacon)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from BEACONS.Beacon data.</p>
|
|
|
|
<div id= "#Functions##NewFromBeacon" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
<a href="Navigation.Beacons.html##(BEACONS.Beacon)">Navigation.Beacons#BEACONS.Beacon</a>
|
|
<strong><strong>Beacon</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The beacon data.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromCoordinate" ><strong>NAVAID:NewFromCoordinate(Name, Type, Coordinate)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from a given COORDINATE.</p>
|
|
|
|
<div id= "#Functions##NewFromCoordinate" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>Coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coordinate of the point.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromLLDD" ><strong>NAVAID:NewFromLLDD(Name, Type, Latitude, Longitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).</p>
|
|
|
|
<div id= "#Functions##NewFromLLDD" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Latitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Latitude in DD.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Longitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Longitude in DD.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromLLDMS" ><strong>NAVAID:NewFromLLDMS(Name, Type, Latitude, Longitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).</p>
|
|
|
|
<div id= "#Functions##NewFromLLDMS" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Latitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Latitude in DMS as string.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Longitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Longitude in DMS as string.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromNavFix" ><strong>NAVAID:NewFromNavFix(Name, Type, NavFix, Distance, Bearing, Reciprocal)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance relative to a given other NAVFIX.</p>
|
|
|
|
|
|
<p>You have to specify the distance and bearing from the new point to the given point. <em>E.g.</em>, for a distance of 5 NM and a bearing of 090° (West), the
|
|
new nav point is created 5 NM East of the given nav point. The reason is that this corresponts to convention used in most maps.
|
|
You can, however, use the <code>Reciprocal</code> switch to create the new point in the direction you specify.</p>
|
|
|
|
<div id= "#Functions##NewFromNavFix" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of navfix.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(NAVFIX)">#NAVFIX</a>
|
|
<strong><strong>NavFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The given/existing navigation fix relative to which the new fix is created.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Distance</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Distance from the given to the new point in nautical miles.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Bearing</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Bearing [Deg] from the new point to the given one.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Reciprocal</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code> the reciprocal <code>Bearing</code> is taken so it specifies the direction from the given point to the new one. </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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).NewFromVector" ><strong>NAVAID:NewFromVector(Name, Type, Vector)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from a given VECTOR.</p>
|
|
|
|
<div id= "#Functions##NewFromVector" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name/ident of the point. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Vector.html##(VECTOR)">Core.Vector#VECTOR</a>
|
|
<strong><strong>Vector</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Position vector of the navpoint.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetAltMandatory" ><strong>NAVAID:SetAltMandatory(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set mandatory altitude (min alt = max alt).</p>
|
|
|
|
<div id= "#Functions##SetAltMandatory" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetAltMax" ><strong>NAVAID:SetAltMax(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set maximum altitude.</p>
|
|
|
|
<div id= "#Functions##SetAltMax" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Max altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetAltMin" ><strong>NAVAID:SetAltMin(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set minimum altitude.</p>
|
|
|
|
<div id= "#Functions##SetAltMin" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Min altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetCompulsory" ><strong>NAVAID:SetCompulsory(Compulsory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this fix is compulsory.</p>
|
|
|
|
<div id= "#Functions##SetCompulsory" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#boolean
|
|
<strong><strong>Compulsory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a compulsory fix. If <code>false</code> or nil, it is non-compulsory.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetFinalApproachFix" ><strong>NAVAID:SetFinalApproachFix(FinalApproachFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
|
|
<div id= "#Functions##SetFinalApproachFix" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#boolean
|
|
<strong><strong>FinalApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a final approach fix.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetFlyOver" ><strong>NAVAID:SetFlyOver(FlyOver)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is a fly-over fix fix.</p>
|
|
|
|
<div id= "#Functions##SetFlyOver" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#boolean
|
|
<strong><strong>FlyOver</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a fly over fix. If <code>false</code> or nil, it is not.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetInitialApproachFix" ><strong>NAVAID:SetInitialApproachFix(IntermediateFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is an initial approach fix (IAF).</p>
|
|
|
|
|
|
<p>The IAF is the point where the initial approach segment of an instrument approach begins.
|
|
It is usually a designated intersection, VHF omidirectional range (VOR) non-directional beacon (NDB)
|
|
or distance measuring equipment (DME) fix.
|
|
The IAF may be collocated with the intermediate fix (IF) of the instrument apprach an in such case they designate the
|
|
beginning of the intermediate segment of the approach. When the IAF and the IF are combined, there is no inital approach segment.</p>
|
|
|
|
<div id= "#Functions##SetInitialApproachFix" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#boolean
|
|
<strong><strong>IntermediateFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is an intermediate fix.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetIntermediateFix" ><strong>NAVAID:SetIntermediateFix(IntermediateFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the intermediate fix (IF).</p>
|
|
|
|
<div id= "#Functions##SetIntermediateFix" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
<strong><strong>IntermediateFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetMissedApproachFix" ><strong>NAVAID:SetMissedApproachFix(FinalApproachFix, MissedApproachFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
|
|
<div id= "#Functions##SetMissedApproachFix" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>
|
|
#boolean
|
|
<strong><strong>FinalApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a final approach fix.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>MissedApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetSpeedMandatory" ><strong>NAVAID:SetSpeedMandatory(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set mandatory speed (min speed = max speed) at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMandatory" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Mandatory speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetSpeedMax" ><strong>NAVAID:SetSpeedMax(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set maximum allowed speed at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMax" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Max speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetSpeedMin" ><strong>NAVAID:SetSpeedMin(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set minimum allowed speed at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMin" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Min speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID)._GetMarkerText" ><strong>NAVAID:_GetMarkerText()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get text displayed in the F10 marker.</p>
|
|
|
|
<div id= "#Functions##_GetMarkerText" 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><a href="Navigation.Point.html##(NAVFIX)">Navigation.Point#NAVFIX</a></p>
|
|
</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>Marker text.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVAID).ClassName" ><strong>NAVAID.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).alias" ><strong>NAVAID.alias</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Alias. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).channel" ><strong>NAVAID.channel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).frequency" ><strong>NAVAID.frequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).lid" ><strong>NAVAID.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).scenery" ><strong>NAVAID.scenery</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVAID).verbose" ><strong>NAVAID.verbose</strong></a>
|
|
|
|
<p>Verbosity of output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVAID).version" ><strong>NAVAID.version</strong></a>
|
|
|
|
<p>NAVAID class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVAID).zone" ><strong>NAVAID.zone</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set zone.</p>
|
|
|
|
</div>
|
|
|
|
</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="#(NAVAID).ClearState" ><strong>NAVAID:ClearState(Object, StateName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Clear the state of an object.</p>
|
|
|
|
<div id= "#Functions##ClearState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>StateName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is should be cleared.</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="#(NAVAID).CreateEventBirth" ><strong>NAVAID:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Birth Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventBirth" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>IniUnitName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating unit name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>place</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>subplace</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="#(NAVAID).CreateEventCrash" ><strong>NAVAID:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventCrash" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</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="#(NAVAID).CreateEventDead" ><strong>NAVAID:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Dead Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</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="#(NAVAID).CreateEventDynamicCargoLoaded" ><strong>NAVAID:CreateEventDynamicCargoLoaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoLoaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVAID).CreateEventDynamicCargoRemoved" ><strong>NAVAID:CreateEventDynamicCargoRemoved(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVAID).CreateEventDynamicCargoUnloaded" ><strong>NAVAID:CreateEventDynamicCargoUnloaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoUnloaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVAID).CreateEventNewDynamicCargo" ><strong>NAVAID:CreateEventNewDynamicCargo(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
|
|
<div id= "#Functions##CreateEventNewDynamicCargo" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVAID).CreateEventPlayerEnterAircraft" ><strong>NAVAID:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
|
|
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
|
<strong><strong>PlayerUnit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The aircraft unit the player entered.</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="#(NAVAID).CreateEventRemoveUnit" ><strong>NAVAID:CreateEventRemoveUnit(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Remove Unit Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventRemoveUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVAID).CreateEventTakeoff" ><strong>NAVAID:CreateEventTakeoff(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Takeoff Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventTakeoff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVAID).CreateEventUnitLost" ><strong>NAVAID:CreateEventUnitLost(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventUnitLost" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVAID).E" ><strong>NAVAID:E(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Log an exception which will be traced always.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##E" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).EventDispatcher" ><strong>NAVAID:EventDispatcher()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the event dispatcher</p>
|
|
|
|
<div id= "#Functions##EventDispatcher" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).EventRemoveAll" ><strong>NAVAID:EventRemoveAll()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove all subscribed events</p>
|
|
|
|
<div id= "#Functions##EventRemoveAll" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).F" ><strong>NAVAID:F(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).F2" ><strong>NAVAID:F2(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call level 2.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F2" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).F3" ><strong>NAVAID:F3(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call level 3.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F3" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).GetClassID" ><strong>NAVAID:GetClassID()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassID of the class instance.</p>
|
|
|
|
<div id= "#Functions##GetClassID" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassID of the class instance.</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="#(NAVAID).GetClassName" ><strong>NAVAID:GetClassName()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassName of the class instance.</p>
|
|
|
|
<div id= "#Functions##GetClassName" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassName of the class instance.</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="#(NAVAID).GetClassNameAndID" ><strong>NAVAID:GetClassNameAndID()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassName + ClassID of the class instance.</p>
|
|
|
|
|
|
<p>The ClassName + ClassID is formatted as '%s#%09d'.</p>
|
|
|
|
<div id= "#Functions##GetClassNameAndID" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassName + ClassID of the class instance.</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="#(NAVAID).GetEventPriority" ><strong>NAVAID:GetEventPriority()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##GetEventPriority" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</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="#(NAVAID).GetParent" ><strong>NAVAID:GetParent(Child, FromClass)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
|
|
|
|
<p>Note that the Parent class must be passed to call the parent class method.</p>
|
|
|
|
<pre><code>self:GetParent(self):ParentMethod()
|
|
</code></pre>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetParent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="##(BASE)">#BASE</a>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>This is the Child class from which the Parent class needs to be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>FromClass</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The class from which to get the parent.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).GetProperties" ><strong>NAVAID:GetProperties()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
|
|
<div id= "#Functions##GetProperties" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of values, indexed by keys.</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="#(NAVAID).GetProperty" ><strong>NAVAID:GetProperty(Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get one property of an object by the key.</p>
|
|
|
|
<div id= "#Functions##GetProperty" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found. </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="#(NAVAID).GetState" ><strong>NAVAID:GetState(Object, Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##GetState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.</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="#(NAVAID).HandleEvent" ><strong>NAVAID:HandleEvent(EventID, EventFunction)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Subscribe to a DCS Event.</p>
|
|
|
|
<div id= "#Functions##HandleEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>EventFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) The function to be called when the event occurs for the unit.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).I" ><strong>NAVAID:I(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Log an information which will be traced always.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##I" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).Inherit" ><strong>NAVAID:Inherit(Child, Parent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to inherit from a parent class.</p>
|
|
|
|
<div id= "#Functions##Inherit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Child class that inherits.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>Parent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Parent class that the Child inherits from.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Child</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="#(NAVAID).IsInstanceOf" ><strong>NAVAID:IsInstanceOf(ClassName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
|
|
|
|
|
|
|
|
<h3>Examples:</h3>
|
|
|
|
<ul>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false</p></li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##IsInstanceOf" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>ClassName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the name of the class or the class itself to run the check against</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">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).IsTrace" ><strong>NAVAID:IsTrace()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Enquires if tracing is on (for the class).</p>
|
|
|
|
<div id= "#Functions##IsTrace" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).New" ><strong>NAVAID:New()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BASE constructor.</p>
|
|
|
|
|
|
|
|
<p>This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.</p>
|
|
|
|
<pre><code>function EVENT:New()
|
|
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
|
|
return self
|
|
end
|
|
</code></pre>
|
|
|
|
|
|
<div id= "#Functions##New" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).OnEvent" ><strong>NAVAID:OnEvent(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that triggered the event. </p>
|
|
|
|
<div id= "#Functions##OnEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventBDA" ><strong>NAVAID:OnEventBDA(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BDA.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventBDA" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventBaseCaptured" ><strong>NAVAID:OnEventBaseCaptured(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that captured the base
|
|
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
|
|
|
|
<div id= "#Functions##OnEventBaseCaptured" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventBirth" ><strong>NAVAID:OnEventBirth(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was spawned </p>
|
|
|
|
<div id= "#Functions##OnEventBirth" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventCrash" ><strong>NAVAID:OnEventCrash(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that has crashed </p>
|
|
|
|
<div id= "#Functions##OnEventCrash" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDead" ><strong>NAVAID:OnEventDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an object is dead.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is dead. </p>
|
|
|
|
<div id= "#Functions##OnEventDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDetailedFailure" ><strong>NAVAID:OnEventDetailedFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
|
|
|
|
<p>Will update this page when new information become available.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that had the failure.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventDetailedFailure" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDiscardChairAfterEjection" ><strong>NAVAID:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Discard chair after ejection.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventDiscardChairAfterEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDynamicCargoLoaded" ><strong>NAVAID:OnEventDynamicCargoLoaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoLoaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDynamicCargoRemoved" ><strong>NAVAID:OnEventDynamicCargoRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventDynamicCargoUnloaded" ><strong>NAVAID:OnEventDynamicCargoUnloaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoUnloaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventEjection" ><strong>NAVAID:OnEventEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has ejected </p>
|
|
|
|
<div id= "#Functions##OnEventEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventEngineShutdown" ><strong>NAVAID:OnEventEngineShutdown(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is stopping its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineShutdown" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventEngineStartup" ><strong>NAVAID:OnEventEngineStartup(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is starting its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineStartup" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventHit" ><strong>NAVAID:OnEventHit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit object the fired the weapon
|
|
weapon: Weapon object that hit the target
|
|
target: The Object that was hit. </p>
|
|
|
|
<div id= "#Functions##OnEventHit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventHumanFailure" ><strong>NAVAID:OnEventHumanFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that had the failure </p>
|
|
|
|
<div id= "#Functions##OnEventHumanFailure" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventKill" ><strong>NAVAID:OnEventKill(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs on the death of a unit.</p>
|
|
|
|
|
|
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that killed the target</li>
|
|
<li>target: Target Object</li>
|
|
<li>weapon: Weapon Object</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventKill" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventLand" ><strong>NAVAID:OnEventLand(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has landed
|
|
place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventLand" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventLandingAfterEjection" ><strong>NAVAID:OnEventLandingAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
|
|
|
|
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.</li>
|
|
<li>place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.</li>
|
|
<li>subplace: is always 0 for unknown reasons.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventLandingAfterEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventLandingQualityMark" ><strong>NAVAID:OnEventLandingQualityMark(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Landing quality mark.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventLandingQualityMark" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventMarkAdded" ><strong>NAVAID:OnEventMarkAdded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a new mark was added.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkAdded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventMarkChange" ><strong>NAVAID:OnEventMarkChange(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark text was changed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkChange" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventMarkRemoved" ><strong>NAVAID:OnEventMarkRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark was removed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventMissionEnd" ><strong>NAVAID:OnEventMissionEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventMissionEnd" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventMissionStart" ><strong>NAVAID:OnEventMissionStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
|
|
<div id= "#Functions##OnEventMissionStart" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventNewDynamicCargo" ><strong>NAVAID:OnEventNewDynamicCargo(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventNewDynamicCargo" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventParatrooperLanding" ><strong>NAVAID:OnEventParatrooperLanding(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Weapon add.</p>
|
|
|
|
|
|
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventParatrooperLanding" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventPilotDead" ><strong>NAVAID:OnEventPilotDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
|
|
|
|
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the pilot has died in. </p>
|
|
|
|
<div id= "#Functions##OnEventPilotDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventPlayerEnterAircraft" ><strong>NAVAID:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
<strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventPlayerEnterUnit" ><strong>NAVAID:OnEventPlayerEnterUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
|
|
|
|
<p>Note - not Mulitplayer safe. Use PlayerEnterAircraft.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventPlayerLeaveUnit" ><strong>NAVAID:OnEventPlayerLeaveUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the player left. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerLeaveUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventRefueling" ><strong>NAVAID:OnEventRefueling(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefueling" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventRefuelingStop" ><strong>NAVAID:OnEventRefuelingStop(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefuelingStop" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventScore" ><strong>NAVAID:OnEventScore(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
|
|
|
|
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventScore" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventShootingEnd" ><strong>NAVAID:OnEventShootingEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
|
|
|
|
<p>Event will always correspond with a shooting start event.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was doing the shooting. </p>
|
|
|
|
<div id= "#Functions##OnEventShootingEnd" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventShootingStart" ><strong>NAVAID:OnEventShootingStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
|
|
|
|
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is doing the shooting.
|
|
target: The unit that is being targeted.</p>
|
|
|
|
<div id= "#Functions##OnEventShootingStart" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventShot" ><strong>NAVAID:OnEventShot(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
|
|
|
|
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventShot" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventTakeoff" ><strong>NAVAID:OnEventTakeoff(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that tookoff
|
|
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventTakeoff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventTriggerZone" ><strong>NAVAID:OnEventTriggerZone(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger zone.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventTriggerZone" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).OnEventUnitLost" ><strong>NAVAID:OnEventUnitLost(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that is was destroyed.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventUnitLost" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVAID).ScheduleOnce" ><strong>NAVAID:ScheduleOnce(Start, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleOnce" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</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>The Schedule ID of the planned schedule.</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="#(NAVAID).ScheduleRepeat" ><strong>NAVAID:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleRepeat" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the interval in seconds when the scheduler will call the event function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>RandomizeFactor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies a randomization factor between 0 and 1 to randomize the Repeat.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Stop</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds when the scheduler will be stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</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>The Schedule ID of the planned schedule.</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="#(NAVAID).ScheduleStop" ><strong>NAVAID:ScheduleStop(SchedulerID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Stops the Schedule.</p>
|
|
|
|
<div id= "#Functions##ScheduleStop" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>SchedulerID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.</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="#(NAVAID).SetEventPriority" ><strong>NAVAID:SetEventPriority(EventPriority)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##SetEventPriority" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>EventPriority</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVAID).SetProperty" ><strong>NAVAID:SetProperty(Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set one property of an object.</p>
|
|
|
|
<div id= "#Functions##SetProperty" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</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>The value that is stored. Note that the value can be a #string, but it can also be any other type!</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="#(NAVAID).SetState" ><strong>NAVAID:SetState(Object, Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##SetState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that will hold the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</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>The value to is stored in the object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value set. </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="#(NAVAID).T" ><strong>NAVAID:T(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 1.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).T2" ><strong>NAVAID:T2(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 2.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T2" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).T3" ><strong>NAVAID:T3(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 3.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T3" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVAID).TraceAll" ><strong>NAVAID:TraceAll(TraceAll)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace all methods in MOOSE</p>
|
|
|
|
<div id= "#Functions##TraceAll" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#boolean
|
|
<strong><strong>TraceAll</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>true = trace all methods in MOOSE.</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="#(NAVAID).TraceClass" ><strong>NAVAID:TraceClass(Class)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a class</p>
|
|
|
|
<div id= "#Functions##TraceClass" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</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="#(NAVAID).TraceClassMethod" ><strong>NAVAID:TraceClassMethod(Class, Method)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a specific method of class</p>
|
|
|
|
<div id= "#Functions##TraceClassMethod" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Method</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Method.</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="#(NAVAID).TraceLevel" ><strong>NAVAID:TraceLevel(Level)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace level</p>
|
|
|
|
<div id= "#Functions##TraceLevel" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Level</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="#(NAVAID).TraceOff" ><strong>NAVAID:TraceOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace off.</p>
|
|
|
|
<div id= "#Functions##TraceOff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing Off
|
|
BASE:TraceOff()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).TraceOn" ><strong>NAVAID:TraceOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on.</p>
|
|
|
|
<div id= "#Functions##TraceOn" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing On
|
|
BASE:TraceOn()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).TraceOnOff" ><strong>NAVAID:TraceOnOff(TraceOnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on or off
|
|
Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
|
|
When Moose is loaded statically, (as one file), tracing is switched off by default.</p>
|
|
|
|
|
|
<p>So tracing must be switched on manually in your mission if you are using Moose statically.
|
|
When moose is loading dynamically (for moose class development), tracing is switched on by default.</p>
|
|
|
|
<div id= "#Functions##TraceOnOff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#boolean
|
|
<strong><strong>TraceOnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Switch the tracing on or off.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>
|
|
-- Switch the tracing On
|
|
BASE:TraceOnOff( true )
|
|
|
|
-- Switch the tracing Off
|
|
BASE:TraceOnOff( false )
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID).UnHandleEvent" ><strong>NAVAID:UnHandleEvent(EventID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
|
|
<div id= "#Functions##UnHandleEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVAID)._F" ><strong>NAVAID:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call.</p>
|
|
|
|
|
|
<p>This function is private.</p>
|
|
|
|
<div id= "#Functions##_F" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoCurrentParam</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoFromParam</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="#(NAVAID)._Serialize" ><strong>NAVAID:_Serialize(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>(Internal) Serialize arguments</p>
|
|
|
|
<div id= "#Functions##_Serialize" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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</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="#(NAVAID)._T" ><strong>NAVAID:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic.</p>
|
|
|
|
<div id= "#Functions##_T" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoCurrentParam</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoFromParam</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="#(NAVAID).onEvent" ><strong>NAVAID:onEvent(event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>The main event handling function...</p>
|
|
|
|
|
|
<p>This function captures all events generated for the class.</p>
|
|
|
|
<div id= "#Functions##onEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="DCS.html##(Event)">DCS#Event</a>
|
|
<strong><strong>event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##NAVFIX')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(NAVFIX)">Type <strong>NAVFIX</strong></a></h2></div>
|
|
<div id= "#Types##NAVFIX" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>NAVFIX class.</p>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).ClassName" ><strong>NAVFIX.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(NAVFIX.Type)">#NAVFIX.Type</a>
|
|
<a id="#(NAVFIX).Type" ><strong>NAVFIX.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).altMax" ><strong>NAVFIX.altMax</strong></a>
|
|
|
|
<p>Maximum altitude in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).altMin" ><strong>NAVFIX.altMin</strong></a>
|
|
|
|
<p>Minimum altitude in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isCompulsory" ><strong>NAVFIX.isCompulsory</strong></a>
|
|
|
|
<p>Is this a compulsory fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isFAF" ><strong>NAVFIX.isFAF</strong></a>
|
|
|
|
<p>Is this a final approach fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isFlyover" ><strong>NAVFIX.isFlyover</strong></a>
|
|
|
|
<p>Is this a flyover fix (<code>true</code>) or turning point otherwise.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isIAF" ><strong>NAVFIX.isIAF</strong></a>
|
|
|
|
<p>Is this an initial approach fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isIF" ><strong>NAVFIX.isIF</strong></a>
|
|
|
|
<p>Is this an initial fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isMAF" ><strong>NAVFIX.isMAF</strong></a>
|
|
|
|
<p>Is this an initial fix.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVFIX).lid" ><strong>NAVFIX.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Log ID string.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a>
|
|
<a id="#(NAVFIX).marker" ><strong>NAVFIX.marker</strong></a>
|
|
|
|
<p>Marker on F10 map.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).name" ><strong>NAVFIX.name</strong></a>
|
|
|
|
<p>Name of the point.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).speedMax" ><strong>NAVFIX.speedMax</strong></a>
|
|
|
|
<p>Maximum speed in knots.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).speedMin" ><strong>NAVFIX.speedMin</strong></a>
|
|
|
|
<p>Minimum speed in knots.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).typePoint" ><strong>NAVFIX.typePoint</strong></a>
|
|
|
|
<p>Type of the point, *e.g. "Intersection", "VOR", "Airport".</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Vector.html##(VECTOR)">Core.Vector#VECTOR</a>
|
|
<a id="#(NAVFIX).vector" ><strong>NAVFIX.vector</strong></a>
|
|
|
|
<p>Position vector of the fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).verbose" ><strong>NAVFIX.verbose</strong></a>
|
|
|
|
<p>Verbosity of output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).version" ><strong>NAVFIX.version</strong></a>
|
|
|
|
<p>NAVFIX class version.</p>
|
|
|
|
</div>
|
|
|
|
</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="#(NAVFIX).GetAltitude" ><strong>NAVFIX:GetAltitude()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the altitude in feet MSL.</p>
|
|
|
|
|
|
<p>If min and max altitudes are set, it will return a random altitude between min and max.</p>
|
|
|
|
<div id= "#Functions##GetAltitude" 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>NAVFIX</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Altitude in feet MSL. Can be <code>nil</code>, if neither min nor max altitudes have beeen set. </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="#(NAVFIX).GetSpeed" ><strong>NAVFIX:GetSpeed()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the speed.</p>
|
|
|
|
|
|
<p>If min and max speeds are set, it will return a random speed between min and max.</p>
|
|
|
|
<div id= "#Functions##GetSpeed" 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>NAVFIX</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Speed in knots. Can be <code>nil</code>, if neither min nor max speeds have beeen set. </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="#(NAVFIX).MarkerRemove" ><strong>NAVFIX:MarkerRemove()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove marker of the NAVFIX from the F10 map.</p>
|
|
|
|
<div id= "#Functions##MarkerRemove" 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>NAVFIX</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).MarkerShow" ><strong>NAVFIX:MarkerShow()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add marker the NAVFIX on the F10 map.</p>
|
|
|
|
<div id= "#Functions##MarkerShow" 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>NAVFIX</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromBeacon" ><strong>NAVFIX:NewFromBeacon(Beacon)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from BEACONS.Beacon data.</p>
|
|
|
|
<div id= "#Functions##NewFromBeacon" 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>NAVFIX</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>
|
|
<a href="Navigation.Beacons.html##(BEACONS.Beacon)">Navigation.Beacons#BEACONS.Beacon</a>
|
|
<strong><strong>Beacon</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The beacon data.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromCoordinate" ><strong>NAVFIX:NewFromCoordinate(Name, Type, Coordinate)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from a given COORDINATE.</p>
|
|
|
|
<div id= "#Functions##NewFromCoordinate" 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>NAVFIX</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>Coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coordinate of the point.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromLLDD" ><strong>NAVFIX:NewFromLLDD(Name, Type, Latitude, Longitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in decimal degrees (DD).</p>
|
|
|
|
<div id= "#Functions##NewFromLLDD" 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>NAVFIX</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Latitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Latitude in DD.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Longitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Longitude in DD.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromLLDMS" ><strong>NAVFIX:NewFromLLDMS(Name, Type, Latitude, Longitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX instance from given latitude and longitude in degrees, minutes and seconds (DMS).</p>
|
|
|
|
<div id= "#Functions##NewFromLLDMS" 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>NAVFIX</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Latitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Latitude in DMS as string.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Longitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Longitude in DMS as string.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromNavFix" ><strong>NAVFIX:NewFromNavFix(Name, Type, NavFix, Distance, Bearing, Reciprocal)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance relative to a given other NAVFIX.</p>
|
|
|
|
|
|
<p>You have to specify the distance and bearing from the new point to the given point. <em>E.g.</em>, for a distance of 5 NM and a bearing of 090° (West), the
|
|
new nav point is created 5 NM East of the given nav point. The reason is that this corresponts to convention used in most maps.
|
|
You can, however, use the <code>Reciprocal</code> switch to create the new point in the direction you specify.</p>
|
|
|
|
<div id= "#Functions##NewFromNavFix" 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>NAVFIX</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the fix. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of navfix.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(NAVFIX)">#NAVFIX</a>
|
|
<strong><strong>NavFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The given/existing navigation fix relative to which the new fix is created.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Distance</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Distance from the given to the new point in nautical miles.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Bearing</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Bearing [Deg] from the new point to the given one.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Reciprocal</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code> the reciprocal <code>Bearing</code> is taken so it specifies the direction from the given point to the new one. </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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).NewFromVector" ><strong>NAVFIX:NewFromVector(Name, Type, Vector)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new NAVFIX class instance from a given VECTOR.</p>
|
|
|
|
<div id= "#Functions##NewFromVector" 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>NAVFIX</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>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name/ident of the point. Should be unique!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Type of the point. Default <code>NAVFIX.Type.POINT</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Vector.html##(VECTOR)">Core.Vector#VECTOR</a>
|
|
<strong><strong>Vector</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Position vector of the navpoint.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetAltMandatory" ><strong>NAVFIX:SetAltMandatory(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set mandatory altitude (min alt = max alt).</p>
|
|
|
|
<div id= "#Functions##SetAltMandatory" 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>NAVFIX</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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetAltMax" ><strong>NAVFIX:SetAltMax(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set maximum altitude.</p>
|
|
|
|
<div id= "#Functions##SetAltMax" 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>NAVFIX</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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Max altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetAltMin" ><strong>NAVFIX:SetAltMin(Altitude)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set minimum altitude.</p>
|
|
|
|
<div id= "#Functions##SetAltMin" 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>NAVFIX</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>Altitude</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Min altitude in feet.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetCompulsory" ><strong>NAVFIX:SetCompulsory(Compulsory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this fix is compulsory.</p>
|
|
|
|
<div id= "#Functions##SetCompulsory" 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>NAVFIX</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>
|
|
#boolean
|
|
<strong><strong>Compulsory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a compulsory fix. If <code>false</code> or nil, it is non-compulsory.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetFinalApproachFix" ><strong>NAVFIX:SetFinalApproachFix(FinalApproachFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
|
|
<div id= "#Functions##SetFinalApproachFix" 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>NAVFIX</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>
|
|
#boolean
|
|
<strong><strong>FinalApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a final approach fix.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetFlyOver" ><strong>NAVFIX:SetFlyOver(FlyOver)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is a fly-over fix fix.</p>
|
|
|
|
<div id= "#Functions##SetFlyOver" 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>NAVFIX</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>
|
|
#boolean
|
|
<strong><strong>FlyOver</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a fly over fix. If <code>false</code> or nil, it is not.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetInitialApproachFix" ><strong>NAVFIX:SetInitialApproachFix(IntermediateFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is an initial approach fix (IAF).</p>
|
|
|
|
|
|
<p>The IAF is the point where the initial approach segment of an instrument approach begins.
|
|
It is usually a designated intersection, VHF omidirectional range (VOR) non-directional beacon (NDB)
|
|
or distance measuring equipment (DME) fix.
|
|
The IAF may be collocated with the intermediate fix (IF) of the instrument apprach an in such case they designate the
|
|
beginning of the intermediate segment of the approach. When the IAF and the IF are combined, there is no inital approach segment.</p>
|
|
|
|
<div id= "#Functions##SetInitialApproachFix" 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>NAVFIX</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>
|
|
#boolean
|
|
<strong><strong>IntermediateFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is an intermediate fix.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetIntermediateFix" ><strong>NAVFIX:SetIntermediateFix(IntermediateFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the intermediate fix (IF).</p>
|
|
|
|
<div id= "#Functions##SetIntermediateFix" 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>NAVFIX</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>
|
|
<strong><strong>IntermediateFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetMissedApproachFix" ><strong>NAVFIX:SetMissedApproachFix(FinalApproachFix, MissedApproachFix)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set whether this is the final approach fix (FAF).</p>
|
|
|
|
<div id= "#Functions##SetMissedApproachFix" 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>NAVFIX</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>
|
|
#boolean
|
|
<strong><strong>FinalApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, this is a final approach fix.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>MissedApproachFix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetSpeedMandatory" ><strong>NAVFIX:SetSpeedMandatory(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set mandatory speed (min speed = max speed) at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMandatory" 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>NAVFIX</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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Mandatory speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetSpeedMax" ><strong>NAVFIX:SetSpeedMax(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set maximum allowed speed at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMax" 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>NAVFIX</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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Max speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetSpeedMin" ><strong>NAVFIX:SetSpeedMin(Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set minimum allowed speed at this fix.</p>
|
|
|
|
<div id= "#Functions##SetSpeedMin" 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>NAVFIX</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>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Min speed in knots.</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="##(NAVFIX)">#NAVFIX</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX)._GetMarkerText" ><strong>NAVFIX:_GetMarkerText()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get text displayed in the F10 marker.</p>
|
|
|
|
<div id= "#Functions##_GetMarkerText" 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>NAVFIX</p>
|
|
</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>Marker text.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).ClassName" ><strong>NAVFIX.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(NAVFIX.Type)">#NAVFIX.Type</a>
|
|
<a id="#(NAVFIX).Type" ><strong>NAVFIX.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).altMax" ><strong>NAVFIX.altMax</strong></a>
|
|
|
|
<p>Maximum altitude in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).altMin" ><strong>NAVFIX.altMin</strong></a>
|
|
|
|
<p>Minimum altitude in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isCompulsory" ><strong>NAVFIX.isCompulsory</strong></a>
|
|
|
|
<p>Is this a compulsory fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isFAF" ><strong>NAVFIX.isFAF</strong></a>
|
|
|
|
<p>Is this a final approach fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isFlyover" ><strong>NAVFIX.isFlyover</strong></a>
|
|
|
|
<p>Is this a flyover fix (<code>true</code>) or turning point otherwise.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isIAF" ><strong>NAVFIX.isIAF</strong></a>
|
|
|
|
<p>Is this an initial approach fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isIF" ><strong>NAVFIX.isIF</strong></a>
|
|
|
|
<p>Is this an initial fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(NAVFIX).isMAF" ><strong>NAVFIX.isMAF</strong></a>
|
|
|
|
<p>Is this an initial fix.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(NAVFIX).lid" ><strong>NAVFIX.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Log ID string.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a>
|
|
<a id="#(NAVFIX).marker" ><strong>NAVFIX.marker</strong></a>
|
|
|
|
<p>Marker on F10 map.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).name" ><strong>NAVFIX.name</strong></a>
|
|
|
|
<p>Name of the point.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).speedMax" ><strong>NAVFIX.speedMax</strong></a>
|
|
|
|
<p>Maximum speed in knots.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).speedMin" ><strong>NAVFIX.speedMin</strong></a>
|
|
|
|
<p>Minimum speed in knots.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).typePoint" ><strong>NAVFIX.typePoint</strong></a>
|
|
|
|
<p>Type of the point, *e.g. "Intersection", "VOR", "Airport".</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Vector.html##(VECTOR)">Core.Vector#VECTOR</a>
|
|
<a id="#(NAVFIX).vector" ><strong>NAVFIX.vector</strong></a>
|
|
|
|
<p>Position vector of the fix.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(NAVFIX).verbose" ><strong>NAVFIX.verbose</strong></a>
|
|
|
|
<p>Verbosity of output.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX).version" ><strong>NAVFIX.version</strong></a>
|
|
|
|
<p>NAVFIX class version.</p>
|
|
|
|
</div>
|
|
|
|
</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="#(NAVFIX).ClearState" ><strong>NAVFIX:ClearState(Object, StateName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Clear the state of an object.</p>
|
|
|
|
<div id= "#Functions##ClearState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>StateName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is should be cleared.</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="#(NAVFIX).CreateEventBirth" ><strong>NAVFIX:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Birth Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventBirth" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>IniUnitName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating unit name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>place</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>subplace</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="#(NAVFIX).CreateEventCrash" ><strong>NAVFIX:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventCrash" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</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="#(NAVFIX).CreateEventDead" ><strong>NAVFIX:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Dead Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</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="#(NAVFIX).CreateEventDynamicCargoLoaded" ><strong>NAVFIX:CreateEventDynamicCargoLoaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoLoaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVFIX).CreateEventDynamicCargoRemoved" ><strong>NAVFIX:CreateEventDynamicCargoRemoved(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVFIX).CreateEventDynamicCargoUnloaded" ><strong>NAVFIX:CreateEventDynamicCargoUnloaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoUnloaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVFIX).CreateEventNewDynamicCargo" ><strong>NAVFIX:CreateEventNewDynamicCargo(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
|
|
<div id= "#Functions##CreateEventNewDynamicCargo" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</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="#(NAVFIX).CreateEventPlayerEnterAircraft" ><strong>NAVFIX:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
|
|
<div id= "#Functions##CreateEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
|
<strong><strong>PlayerUnit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The aircraft unit the player entered.</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="#(NAVFIX).CreateEventRemoveUnit" ><strong>NAVFIX:CreateEventRemoveUnit(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Remove Unit Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventRemoveUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVFIX).CreateEventTakeoff" ><strong>NAVFIX:CreateEventTakeoff(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Takeoff Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventTakeoff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVFIX).CreateEventUnitLost" ><strong>NAVFIX:CreateEventUnitLost(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventUnitLost" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</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="#(NAVFIX).E" ><strong>NAVFIX:E(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Log an exception which will be traced always.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##E" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).EventDispatcher" ><strong>NAVFIX:EventDispatcher()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the event dispatcher</p>
|
|
|
|
<div id= "#Functions##EventDispatcher" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).EventRemoveAll" ><strong>NAVFIX:EventRemoveAll()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove all subscribed events</p>
|
|
|
|
<div id= "#Functions##EventRemoveAll" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).F" ><strong>NAVFIX:F(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).F2" ><strong>NAVFIX:F2(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call level 2.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F2" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).F3" ><strong>NAVFIX:F3(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call level 3.</p>
|
|
|
|
|
|
<p>Must be at the beginning of the function logic.</p>
|
|
|
|
<div id= "#Functions##F3" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).GetClassID" ><strong>NAVFIX:GetClassID()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassID of the class instance.</p>
|
|
|
|
<div id= "#Functions##GetClassID" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassID of the class instance.</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="#(NAVFIX).GetClassName" ><strong>NAVFIX:GetClassName()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassName of the class instance.</p>
|
|
|
|
<div id= "#Functions##GetClassName" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassName of the class instance.</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="#(NAVFIX).GetClassNameAndID" ><strong>NAVFIX:GetClassNameAndID()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the ClassName + ClassID of the class instance.</p>
|
|
|
|
|
|
<p>The ClassName + ClassID is formatted as '%s#%09d'.</p>
|
|
|
|
<div id= "#Functions##GetClassNameAndID" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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>The ClassName + ClassID of the class instance.</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="#(NAVFIX).GetEventPriority" ><strong>NAVFIX:GetEventPriority()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##GetEventPriority" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</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="#(NAVFIX).GetParent" ><strong>NAVFIX:GetParent(Child, FromClass)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
|
|
|
|
<p>Note that the Parent class must be passed to call the parent class method.</p>
|
|
|
|
<pre><code>self:GetParent(self):ParentMethod()
|
|
</code></pre>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetParent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="##(BASE)">#BASE</a>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>This is the Child class from which the Parent class needs to be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>FromClass</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The class from which to get the parent.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).GetProperties" ><strong>NAVFIX:GetProperties()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
|
|
<div id= "#Functions##GetProperties" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of values, indexed by keys.</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="#(NAVFIX).GetProperty" ><strong>NAVFIX:GetProperty(Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get one property of an object by the key.</p>
|
|
|
|
<div id= "#Functions##GetProperty" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found. </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="#(NAVFIX).GetState" ><strong>NAVFIX:GetState(Object, Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##GetState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.</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="#(NAVFIX).HandleEvent" ><strong>NAVFIX:HandleEvent(EventID, EventFunction)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Subscribe to a DCS Event.</p>
|
|
|
|
<div id= "#Functions##HandleEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>EventFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) The function to be called when the event occurs for the unit.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).I" ><strong>NAVFIX:I(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Log an information which will be traced always.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##I" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).Inherit" ><strong>NAVFIX:Inherit(Child, Parent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to inherit from a parent class.</p>
|
|
|
|
<div id= "#Functions##Inherit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Child class that inherits.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>Parent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Parent class that the Child inherits from.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Child</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="#(NAVFIX).IsInstanceOf" ><strong>NAVFIX:IsInstanceOf(ClassName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to check if an object is an (sub)instance of a class.</p>
|
|
|
|
|
|
|
|
<h3>Examples:</h3>
|
|
|
|
<ul>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true</p></li>
|
|
<li><p>ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false</p></li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##IsInstanceOf" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>ClassName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the name of the class or the class itself to run the check against</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">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).IsTrace" ><strong>NAVFIX:IsTrace()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Enquires if tracing is on (for the class).</p>
|
|
|
|
<div id= "#Functions##IsTrace" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</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">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).New" ><strong>NAVFIX:New()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BASE constructor.</p>
|
|
|
|
|
|
|
|
<p>This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.</p>
|
|
|
|
<pre><code>function EVENT:New()
|
|
local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
|
|
return self
|
|
end
|
|
</code></pre>
|
|
|
|
|
|
<div id= "#Functions##New" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).OnEvent" ><strong>NAVFIX:OnEvent(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that triggered the event. </p>
|
|
|
|
<div id= "#Functions##OnEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventBDA" ><strong>NAVFIX:OnEventBDA(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BDA.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventBDA" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventBaseCaptured" ><strong>NAVFIX:OnEventBaseCaptured(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that captured the base
|
|
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
|
|
|
|
<div id= "#Functions##OnEventBaseCaptured" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventBirth" ><strong>NAVFIX:OnEventBirth(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was spawned </p>
|
|
|
|
<div id= "#Functions##OnEventBirth" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventCrash" ><strong>NAVFIX:OnEventCrash(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that has crashed </p>
|
|
|
|
<div id= "#Functions##OnEventCrash" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDead" ><strong>NAVFIX:OnEventDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an object is dead.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is dead. </p>
|
|
|
|
<div id= "#Functions##OnEventDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDetailedFailure" ><strong>NAVFIX:OnEventDetailedFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
|
|
|
|
<p>Will update this page when new information become available.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that had the failure.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventDetailedFailure" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDiscardChairAfterEjection" ><strong>NAVFIX:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Discard chair after ejection.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventDiscardChairAfterEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDynamicCargoLoaded" ><strong>NAVFIX:OnEventDynamicCargoLoaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoLoaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDynamicCargoRemoved" ><strong>NAVFIX:OnEventDynamicCargoRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventDynamicCargoUnloaded" ><strong>NAVFIX:OnEventDynamicCargoUnloaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoUnloaded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventEjection" ><strong>NAVFIX:OnEventEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has ejected </p>
|
|
|
|
<div id= "#Functions##OnEventEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventEngineShutdown" ><strong>NAVFIX:OnEventEngineShutdown(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is stopping its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineShutdown" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventEngineStartup" ><strong>NAVFIX:OnEventEngineStartup(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is starting its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineStartup" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventHit" ><strong>NAVFIX:OnEventHit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit object the fired the weapon
|
|
weapon: Weapon object that hit the target
|
|
target: The Object that was hit. </p>
|
|
|
|
<div id= "#Functions##OnEventHit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventHumanFailure" ><strong>NAVFIX:OnEventHumanFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that had the failure </p>
|
|
|
|
<div id= "#Functions##OnEventHumanFailure" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventKill" ><strong>NAVFIX:OnEventKill(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs on the death of a unit.</p>
|
|
|
|
|
|
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that killed the target</li>
|
|
<li>target: Target Object</li>
|
|
<li>weapon: Weapon Object</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventKill" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventLand" ><strong>NAVFIX:OnEventLand(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has landed
|
|
place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventLand" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventLandingAfterEjection" ><strong>NAVFIX:OnEventLandingAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
|
|
|
|
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.</li>
|
|
<li>place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.</li>
|
|
<li>subplace: is always 0 for unknown reasons.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventLandingAfterEjection" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventLandingQualityMark" ><strong>NAVFIX:OnEventLandingQualityMark(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Landing quality mark.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventLandingQualityMark" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventMarkAdded" ><strong>NAVFIX:OnEventMarkAdded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a new mark was added.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkAdded" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventMarkChange" ><strong>NAVFIX:OnEventMarkChange(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark text was changed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkChange" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventMarkRemoved" ><strong>NAVFIX:OnEventMarkRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark was removed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkRemoved" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventMissionEnd" ><strong>NAVFIX:OnEventMissionEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventMissionEnd" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventMissionStart" ><strong>NAVFIX:OnEventMissionStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
|
|
<div id= "#Functions##OnEventMissionStart" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventNewDynamicCargo" ><strong>NAVFIX:OnEventNewDynamicCargo(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventNewDynamicCargo" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventParatrooperLanding" ><strong>NAVFIX:OnEventParatrooperLanding(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Weapon add.</p>
|
|
|
|
|
|
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventParatrooperLanding" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventPilotDead" ><strong>NAVFIX:OnEventPilotDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
|
|
|
|
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the pilot has died in. </p>
|
|
|
|
<div id= "#Functions##OnEventPilotDead" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventPlayerEnterAircraft" ><strong>NAVFIX:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
<strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterAircraft" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventPlayerEnterUnit" ><strong>NAVFIX:OnEventPlayerEnterUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
|
|
|
|
<p>Note - not Mulitplayer safe. Use PlayerEnterAircraft.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventPlayerLeaveUnit" ><strong>NAVFIX:OnEventPlayerLeaveUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the player left. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerLeaveUnit" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventRefueling" ><strong>NAVFIX:OnEventRefueling(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefueling" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventRefuelingStop" ><strong>NAVFIX:OnEventRefuelingStop(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefuelingStop" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventScore" ><strong>NAVFIX:OnEventScore(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
|
|
|
|
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventScore" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventShootingEnd" ><strong>NAVFIX:OnEventShootingEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
|
|
|
|
<p>Event will always correspond with a shooting start event.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was doing the shooting. </p>
|
|
|
|
<div id= "#Functions##OnEventShootingEnd" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventShootingStart" ><strong>NAVFIX:OnEventShootingStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
|
|
|
|
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is doing the shooting.
|
|
target: The unit that is being targeted.</p>
|
|
|
|
<div id= "#Functions##OnEventShootingStart" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventShot" ><strong>NAVFIX:OnEventShot(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
|
|
|
|
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventShot" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventTakeoff" ><strong>NAVFIX:OnEventTakeoff(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that tookoff
|
|
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventTakeoff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventTriggerZone" ><strong>NAVFIX:OnEventTriggerZone(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger zone.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventTriggerZone" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).OnEventUnitLost" ><strong>NAVFIX:OnEventUnitLost(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that is was destroyed.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventUnitLost" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</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="#(NAVFIX).ScheduleOnce" ><strong>NAVFIX:ScheduleOnce(Start, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleOnce" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</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>The Schedule ID of the planned schedule.</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="#(NAVFIX).ScheduleRepeat" ><strong>NAVFIX:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleRepeat" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the interval in seconds when the scheduler will call the event function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>RandomizeFactor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies a randomization factor between 0 and 1 to randomize the Repeat.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Stop</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds when the scheduler will be stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</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>The Schedule ID of the planned schedule.</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="#(NAVFIX).ScheduleStop" ><strong>NAVFIX:ScheduleStop(SchedulerID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Stops the Schedule.</p>
|
|
|
|
<div id= "#Functions##ScheduleStop" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>SchedulerID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.</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="#(NAVFIX).SetEventPriority" ><strong>NAVFIX:SetEventPriority(EventPriority)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##SetEventPriority" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>EventPriority</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</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="#(NAVFIX).SetProperty" ><strong>NAVFIX:SetProperty(Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set one property of an object.</p>
|
|
|
|
<div id= "#Functions##SetProperty" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</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>The value that is stored. Note that the value can be a #string, but it can also be any other type!</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="#(NAVFIX).SetState" ><strong>NAVFIX:SetState(Object, Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##SetState" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that will hold the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</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>The value to is stored in the object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value set. </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="#(NAVFIX).T" ><strong>NAVFIX:T(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 1.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).T2" ><strong>NAVFIX:T2(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 2.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T2" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).T3" ><strong>NAVFIX:T3(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic level 3.</p>
|
|
|
|
|
|
<p>Can be anywhere within the function logic.</p>
|
|
|
|
<div id= "#Functions##T3" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</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="#(NAVFIX).TraceAll" ><strong>NAVFIX:TraceAll(TraceAll)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace all methods in MOOSE</p>
|
|
|
|
<div id= "#Functions##TraceAll" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#boolean
|
|
<strong><strong>TraceAll</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>true = trace all methods in MOOSE.</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="#(NAVFIX).TraceClass" ><strong>NAVFIX:TraceClass(Class)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a class</p>
|
|
|
|
<div id= "#Functions##TraceClass" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</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="#(NAVFIX).TraceClassMethod" ><strong>NAVFIX:TraceClassMethod(Class, Method)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a specific method of class</p>
|
|
|
|
<div id= "#Functions##TraceClassMethod" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Method</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Method.</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="#(NAVFIX).TraceLevel" ><strong>NAVFIX:TraceLevel(Level)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace level</p>
|
|
|
|
<div id= "#Functions##TraceLevel" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Level</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="#(NAVFIX).TraceOff" ><strong>NAVFIX:TraceOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace off.</p>
|
|
|
|
<div id= "#Functions##TraceOff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing Off
|
|
BASE:TraceOff()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).TraceOn" ><strong>NAVFIX:TraceOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on.</p>
|
|
|
|
<div id= "#Functions##TraceOn" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing On
|
|
BASE:TraceOn()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).TraceOnOff" ><strong>NAVFIX:TraceOnOff(TraceOnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on or off
|
|
Note that when trace is off, no BASE.Debug statement is performed, increasing performance!
|
|
When Moose is loaded statically, (as one file), tracing is switched off by default.</p>
|
|
|
|
|
|
<p>So tracing must be switched on manually in your mission if you are using Moose statically.
|
|
When moose is loading dynamically (for moose class development), tracing is switched on by default.</p>
|
|
|
|
<div id= "#Functions##TraceOnOff" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
#boolean
|
|
<strong><strong>TraceOnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Switch the tracing on or off.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>
|
|
-- Switch the tracing On
|
|
BASE:TraceOnOff( true )
|
|
|
|
-- Switch the tracing Off
|
|
BASE:TraceOnOff( false )
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX).UnHandleEvent" ><strong>NAVFIX:UnHandleEvent(EventID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
|
|
<div id= "#Functions##UnHandleEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</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="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(NAVFIX)._F" ><strong>NAVFIX:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function call.</p>
|
|
|
|
|
|
<p>This function is private.</p>
|
|
|
|
<div id= "#Functions##_F" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoCurrentParam</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoFromParam</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="#(NAVFIX)._Serialize" ><strong>NAVFIX:_Serialize(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>(Internal) Serialize arguments</p>
|
|
|
|
<div id= "#Functions##_Serialize" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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</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="#(NAVFIX)._T" ><strong>NAVFIX:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trace a function logic.</p>
|
|
|
|
<div id= "#Functions##_T" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A #table or any field.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoCurrentParam</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DebugInfoFromParam</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="#(NAVFIX).onEvent" ><strong>NAVFIX:onEvent(event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>The main event handling function...</p>
|
|
|
|
|
|
<p>This function captures all events generated for the class.</p>
|
|
|
|
<div id= "#Functions##onEvent" 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><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></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>
|
|
<a href="DCS.html##(Event)">DCS#Event</a>
|
|
<strong><strong>event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##NAVFIX.Type')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(NAVFIX.Type)">Type <strong>NAVFIX.Type</strong></a></h2></div>
|
|
<div id= "#Types##NAVFIX.Type" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Type of point.</p>
|
|
|
|
<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">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).AIRPORT" ><strong>NAVFIX.Type.AIRPORT</strong></a>
|
|
|
|
<p>Airport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).DME" ><strong>NAVFIX.Type.DME</strong></a>
|
|
|
|
<p>Distance Measuring Equipment.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).ILS" ><strong>NAVFIX.Type.ILS</strong></a>
|
|
|
|
<p>Instrument Landing System.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).INTERSECTION" ><strong>NAVFIX.Type.INTERSECTION</strong></a>
|
|
|
|
<p>Intersection of airway.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).LOC" ><strong>NAVFIX.Type.LOC</strong></a>
|
|
|
|
<p>Localizer.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).NDB" ><strong>NAVFIX.Type.NDB</strong></a>
|
|
|
|
<p>Non-Directional Beacon.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).POINT" ><strong>NAVFIX.Type.POINT</strong></a>
|
|
|
|
<p>Waypoint.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).TACAN" ><strong>NAVFIX.Type.TACAN</strong></a>
|
|
|
|
<p>TACtical Air Navigation System (TACAN).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).VOR" ><strong>NAVFIX.Type.VOR</strong></a>
|
|
|
|
<p>Very High Frequency Omnidirectional Range Station.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(NAVFIX.Type).VORDME" ><strong>NAVFIX.Type.VORDME</strong></a>
|
|
|
|
<p>Combined VHF omnidirectional range (VOR) with a distance-measuring equipment (DME).</p>
|
|
|
|
</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/MOOSE.JPG')";
|
|
}
|
|
</script>
|
|
|
|
</div>
|
|
<script>
|
|
function w3_open() {
|
|
document.getElementsByClassName("w3-sidenav")[0].style.width = "95vw";
|
|
document.getElementsByClassName("w3-sidenav")[0].style.maxWidth = "1400px";
|
|
document.getElementsByClassName("w3-sidenav")[0].style.display = "block";
|
|
}
|
|
function w3_close() {
|
|
document.getElementsByClassName("w3-sidenav")[0].style.display = "none";
|
|
}
|
|
function myFunction(id) {
|
|
var x = document.getElementById(id);
|
|
if (x.className.indexOf("w3-show") == -1) {
|
|
x.className += " w3-show";
|
|
} else {
|
|
x.className = x.className.replace(" w3-show", "");
|
|
}
|
|
}
|
|
</script>
|
|
|
|
</body>
|
|
</html>
|