mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2026-07-16 14:23:02 +00:00
MooseBotter
16967 lines
575 KiB
HTML
16967 lines
575 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\OPS_OpsTransport.png" alt="Banner Image"/>
|
|
<div id="content">
|
|
<div class="w3-container w3-theme-d5" id="module_title">
|
|
<h1>Module <strong>Ops.OpsTransport</strong></h1>
|
|
</div>
|
|
<div class="w3-container w3-white" id="module_description">
|
|
|
|
<p><strong>Ops</strong> - Transport assignment for OPS groups and storage.</p>
|
|
|
|
|
|
|
|
<h2>Main Features:</h2>
|
|
|
|
<ul>
|
|
<li>Transport troops from A to B</li>
|
|
<li>Transport of warehouse storage (fuel, weapons and equipment)</li>
|
|
<li>Supports ground, naval and airborne (airplanes and helicopters) units as carriers</li>
|
|
<li>Use combined forces (ground, naval, air) to transport the troops</li>
|
|
<li>Additional FSM events to hook into and customize your mission design</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/Ops/Transport">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##OPSTRANSPORT')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>OPSTRANSPORT</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p><em>Victory is the beautiful, bright-colored flower; Transport is the stem without which it could never have blossomed</em> -- Winston Churchill</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The OPSTRANSPORT Concept</h1>
|
|
|
|
<p>This class simulates troop transport using carriers such as APCs, ships, helicopters or airplanes.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##OPSTRANSPORT" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT)">#OPSTRANSPORT</a>
|
|
<a id="OPSTRANSPORT" ><strong>OPSTRANSPORT</strong></a>
|
|
|
|
<p><em>Victory is the beautiful, bright-colored flower; Transport is the stem without which it could never have blossomed</em> -- Winston Churchill</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The OPSTRANSPORT Concept</h1>
|
|
|
|
<p>This class simulates troop transport using carriers such as APCs, ships, helicopters or airplanes.</p>
|
|
|
|
|
|
<p>The carriers and transported groups need to be OPSGROUPS (see ARMYGROUP, NAVYGROUP and FLIGHTGROUP classes).</p>
|
|
|
|
<p><strong>IMPORTANT NOTES</strong></p>
|
|
|
|
<ul>
|
|
<li>Cargo groups are <strong>not</strong> split and distributed into different carrier <em>units</em>. That means that the whole cargo group <strong>must fit</strong> into one of the carrier units.</li>
|
|
<li>Cargo groups must be inside the pickup zones to be considered for loading. Groups not inside the pickup zone will not get the command to board. </li>
|
|
</ul>
|
|
|
|
<h1>Troop Transport</h1>
|
|
|
|
<p>A new cargo transport assignment is created with the <a href="##(OPSTRANSPORT).New">OPSTRANSPORT.New</a>() function</p>
|
|
|
|
<pre><code>local opstransport=OPSTRANSPORT:New(Cargo, PickupZone, DeployZone)
|
|
</code></pre>
|
|
|
|
<p>Here <code>Cargo</code> is an object of the troops to be transported. This can be a GROUP, OPSGROUP, SET_GROUP or SET_OPSGROUP object.</p>
|
|
|
|
<p><code>PickupZone</code> is the zone where the troops are picked up by the transport carriers. <strong>Note</strong> that troops <em>must</em> be inside this zone to be considered for loading!</p>
|
|
|
|
<p><code>DeployZone</code> is the zone where the troops are transported to.</p>
|
|
|
|
<h2>Assign to Carrier(s)</h2>
|
|
|
|
<p>A transport can be assigned to one or multiple carrier OPSGROUPS with this <a href="Ops.OpsGroup.html##(OPSGROUP).AddOpsTransport">Ops.OpsGroup#OPSGROUP.AddOpsTransport</a>() function</p>
|
|
|
|
<pre><code>myopsgroup:AddOpsTransport(opstransport)
|
|
</code></pre>
|
|
|
|
<p>There is no restriction to the type of the carrier. It can be a ground group (e.g. an APC), a helicopter, an airplane or even a ship.</p>
|
|
|
|
<p>You can also mix carrier types. For instance, you can assign the same transport to APCs and helicopters. Or to helicopters and airplanes.</p>
|
|
|
|
<h1>Storage Transport</h1>
|
|
|
|
<p>An instance of the OPSTRANSPORT class is created similarly to the troop transport case. However, the first parameter is <code>nil</code> as not troops
|
|
are transported.</p>
|
|
|
|
<pre><code>local storagetransport=OPSTRANSPORT:New(nil, PickupZone, DeployZone)
|
|
</code></pre>
|
|
|
|
<h2>Defining Storage</h2>
|
|
|
|
<p>The storage warehouses from which the cargo is taken and to which the cargo is delivered have to be specified</p>
|
|
|
|
<pre><code>storagetransport:AddCargoStorage(berlinStorage, batumiStorage, STORAGE.Liquid.JETFUEL, 1000)
|
|
</code></pre>
|
|
|
|
<p>Here <code>berlinStorage</code> and <code>batumiStorage</code> are <a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a> objects of DCS warehouses. </p>
|
|
|
|
<p>Furthermore, that type of cargo (liquids or weapons/equipment) and the amount has to be specified. If weapons/equipment is the cargo,
|
|
we also need to specify the weight per storage item as this cannot be retrieved from the DCS API and is not stored in any MOOSE database.</p>
|
|
|
|
<pre><code>storagetransport:AddCargoStorage(berlinStorage, batumiStorage, ENUMS.Storage.weapons.bombs.Mk_82, 9, 230)
|
|
</code></pre>
|
|
|
|
<p>Finally, the transport is assigned to one or multiple groups, which carry out the transport</p>
|
|
|
|
<pre><code>myopsgroup:AddOpsTransport(storagetransport)
|
|
</code></pre>
|
|
|
|
<h1>Examples</h1>
|
|
|
|
<p>A carrier group is assigned to transport infantry troops from zone "Zone Kobuleti X" to zone "Zone Alpha".</p>
|
|
|
|
<pre><code>-- Carrier group.
|
|
local carrier=ARMYGROUP:New("TPz Fuchs Group")
|
|
|
|
-- Set of groups to transport.
|
|
local infantryset=SET_GROUP:New():FilterPrefixes("Infantry Platoon Alpha"):FilterOnce()
|
|
|
|
-- Cargo transport assignment.
|
|
local opstransport=OPSTRANSPORT:New(infantryset, ZONE:New("Zone Kobuleti X"), ZONE:New("Zone Alpha"))
|
|
|
|
-- Assign transport to carrier.
|
|
carrier:AddOpsTransport(opstransport)
|
|
</code></pre>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-theme-d2 w3-margin-top ">
|
|
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##_OPSTRANSPORTID')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>_OPSTRANSPORTID</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p>Transport ID.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##_OPSTRANSPORTID" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="_OPSTRANSPORTID" ><strong>_OPSTRANSPORTID</strong></a>
|
|
|
|
<p>Transport ID.</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="#(OPSTRANSPORT)">Type <strong>OPSTRANSPORT</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT)">OPSTRANSPORT</a></strong>
|
|
, extends <strong><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</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 OPSTRANSPORT</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="##(OPSTRANSPORT).AddAsset">OPSTRANSPORT:AddAsset(Asset, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add carrier asset to transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddAssetCargo">OPSTRANSPORT:AddAssetCargo(Asset, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add cargo asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddCargoGroups">OPSTRANSPORT:AddCargoGroups(GroupSet, TransportZoneCombo, DisembarkActivation, DisembarkZone, DisembarkCarriers)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add cargo groups to be transported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddCargoStorage">OPSTRANSPORT:AddCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add cargo warehouse storage to be transported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddConditionStart">OPSTRANSPORT:AddConditionStart(ConditionFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add start condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddLegion">OPSTRANSPORT:AddLegion(Legion)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add LEGION to the transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddPathTransport">OPSTRANSPORT:AddPathTransport(PathGroup, Radius, TransportZoneCombo, Reversed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add path used for transportation from the pickup to the deploy zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddTransportZoneCombo">OPSTRANSPORT:AddTransportZoneCombo(CargoGroups, PickupZone, DeployZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add pickup and deploy zone combination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Cancel">OPSTRANSPORT:Cancel()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Cancel".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).CargoType">OPSTRANSPORT.CargoType</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="##(OPSTRANSPORT).ClassName">OPSTRANSPORT.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="##(OPSTRANSPORT).DelAsset">OPSTRANSPORT:DelAsset(Asset)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delete carrier asset from transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Delivered">OPSTRANSPORT:Delivered()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Delivered".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).EvalConditionsAll">OPSTRANSPORT:EvalConditionsAll(Conditions)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if all given condition are true.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Executing">OPSTRANSPORT:Executing()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Executing".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).FindTransferCarrierForCargo">OPSTRANSPORT:FindTransferCarrierForCargo(CargoGroup, Zone, DisembarkCarriers, DeployAirbase)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Find transfer carrier element for cargo group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCargoOpsGroups">OPSTRANSPORT:GetCargoOpsGroups(Delivered, Carrier, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get (all) cargo <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>s.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCargoStorages">OPSTRANSPORT:GetCargoStorages(Delivered, Carrier, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get (all) cargo <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>s.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCargoTotalWeight">OPSTRANSPORT:GetCargoTotalWeight(Cargo, IncludeReserved)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get total weight.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCargos">OPSTRANSPORT:GetCargos(TransportZoneCombo, Carrier, Delivered)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get cargos.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCarrierTransportStatus">OPSTRANSPORT:GetCarrierTransportStatus(CarrierGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get carrier transport status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetCarriers">OPSTRANSPORT:GetCarriers()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get carriers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetDeployZone">OPSTRANSPORT:GetDeployZone(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get deploy zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetDisembarkActivation">OPSTRANSPORT:GetDisembarkActivation(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get disembark activation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetDisembarkCarriers">OPSTRANSPORT:GetDisembarkCarriers(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get transfer carrier(s).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetDisembarkInUtero">OPSTRANSPORT:GetDisembarkInUtero(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get disembark in utero.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetDisembarkZone">OPSTRANSPORT:GetDisembarkZone(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get disembark zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetEmbarkZone">OPSTRANSPORT:GetEmbarkZone(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get embark zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetLegionStatus">OPSTRANSPORT:GetLegionStatus(Legion)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get LEGION transport status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetNcargoDelivered">OPSTRANSPORT:GetNcargoDelivered()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get number of delivered cargo groups.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetNcargoTotal">OPSTRANSPORT:GetNcargoTotal()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get number of cargo groups.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetNcarrier">OPSTRANSPORT:GetNcarrier()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get number of carrier groups assigned for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetPickupZone">OPSTRANSPORT:GetPickupZone(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get pickup zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetRequiredCargos">OPSTRANSPORT:GetRequiredCargos(TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get required cargos.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetRequiredCarriers">OPSTRANSPORT:GetRequiredCarriers()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the number of required carrier groups for an OPSTRANSPORT assignment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetTZCofCargo">OPSTRANSPORT:GetTZCofCargo(GroupName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get transport zone combo of cargo group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetUID">OPSTRANSPORT:GetUID()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get unique ID of the transport assignment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsCargoDelivered">OPSTRANSPORT:IsCargoDelivered(GroupName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if a cargo group was delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsCarrier">OPSTRANSPORT:IsCarrier(CarrierGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if an OPS group is assigned as carrier for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsDelivered">OPSTRANSPORT:IsDelivered(Nmin)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if all cargo was delivered (or is dead).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsExecuting">OPSTRANSPORT:IsExecuting()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if state is EXECUTING.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsPlanned">OPSTRANSPORT:IsPlanned()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if state is PLANNED.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsQueued">OPSTRANSPORT:IsQueued(Legion)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if state is QUEUED.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsReadyToGo">OPSTRANSPORT:IsReadyToGo()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if transport is ready to be started.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsRequested">OPSTRANSPORT:IsRequested(Legion)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if state is REQUESTED.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).IsScheduled">OPSTRANSPORT:IsScheduled()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if state is SCHEDULED.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Loaded">OPSTRANSPORT:Loaded(OpsGroupCargo, OpsGroupCarrier, CarrierElement)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Loaded".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Ncargo">OPSTRANSPORT.Ncargo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Total number of cargo groups.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).NcargoDead">OPSTRANSPORT.NcargoDead</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Totalnumber of dead cargo groups.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Ncarrier">OPSTRANSPORT.Ncarrier</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Total number of assigned carriers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).NcarrierDead">OPSTRANSPORT.NcarrierDead</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Total number of dead carrier groups</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Ndelivered">OPSTRANSPORT.Ndelivered</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Total number of cargo groups delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).New">OPSTRANSPORT:New(CargoGroups, PickupZone, DeployZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new OPSTRANSPORT class object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterCancel">OPSTRANSPORT:OnAfterCancel(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Cancel" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterDelivered">OPSTRANSPORT:OnAfterDelivered(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Delivered" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterExecuting">OPSTRANSPORT:OnAfterExecuting(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Executing" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterLoaded">OPSTRANSPORT:OnAfterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Loaded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterPlanned">OPSTRANSPORT:OnAfterPlanned(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Planned" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterQueued">OPSTRANSPORT:OnAfterQueued(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Queued" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterRequested">OPSTRANSPORT:OnAfterRequested(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Requested" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterScheduled">OPSTRANSPORT:OnAfterScheduled(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Scheduled" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).OnAfterUnloaded">OPSTRANSPORT:OnAfterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Unloaded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Planned">OPSTRANSPORT:Planned()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Planned".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Queued">OPSTRANSPORT:Queued()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Queued".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).RemoveLegion">OPSTRANSPORT:RemoveLegion(Legion)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove LEGION from transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Requested">OPSTRANSPORT:Requested()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Requested".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Scheduled">OPSTRANSPORT:Scheduled()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Scheduled".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetCarrierTransportStatus">OPSTRANSPORT:SetCarrierTransportStatus(CarrierGroup, Status)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a carrier assigned for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetDeployZone">OPSTRANSPORT:SetDeployZone(DeployZone, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set deploy zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetDisembarkActivation">OPSTRANSPORT:SetDisembarkActivation(Active, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set activation status of group when disembarked from transport carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetDisembarkCarriers">OPSTRANSPORT:SetDisembarkCarriers(Carriers, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set/add transfer carrier(s).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetDisembarkInUtero">OPSTRANSPORT:SetDisembarkInUtero(InUtero, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set if group remains <em>in utero</em> after disembarkment from carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetDisembarkZone">OPSTRANSPORT:SetDisembarkZone(DisembarkZone, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set disembark zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetEmbarkZone">OPSTRANSPORT:SetEmbarkZone(EmbarkZone, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set embark zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetFormationPickup">OPSTRANSPORT:SetFormationPickup(Formation, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set pickup formation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetFormationTransport">OPSTRANSPORT:SetFormationTransport(Formation, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set transport formation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetLegionStatus">OPSTRANSPORT:SetLegionStatus(Legion, Status)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set LEGION transport status.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetPickupZone">OPSTRANSPORT:SetPickupZone(PickupZone, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set pickup zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetPriority">OPSTRANSPORT:SetPriority(Prio, Importance, Urgent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set mission priority and (optional) urgency.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetRequiredCargos">OPSTRANSPORT:SetRequiredCargos(Cargos, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set required cargo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetRequiredCarriers">OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set number of required carrier groups for an OPSTRANSPORT assignment.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetTime">OPSTRANSPORT:SetTime(ClockStart, ClockStop)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set transport start and stop time.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetVerbosity">OPSTRANSPORT:SetVerbosity(Verbosity)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set verbosity. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Status">OPSTRANSPORT.Status</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="##(OPSTRANSPORT).StatusUpdate">OPSTRANSPORT:StatusUpdate()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "StatusUpdate".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Tover">OPSTRANSPORT.Tover</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="##(OPSTRANSPORT).Tstart">OPSTRANSPORT.Tstart</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Start time in <em>abs.</em> seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Tstop">OPSTRANSPORT.Tstop</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Stop time in <em>abs.</em> seconds. Default <code>#nil</code> (never stops).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Unloaded">OPSTRANSPORT:Unloaded(OpsGroupCargo, OpsGroupCarrier)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Unloaded".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._AddCarrier">OPSTRANSPORT:_AddCarrier(CarrierGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a carrier assigned for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._AddDisembarkCarriers">OPSTRANSPORT:_AddDisembarkCarriers(Carriers, Table)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set/add transfer carrier(s).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._CheckDelivered">OPSTRANSPORT:_CheckDelivered()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if all cargo of this transport assignment was delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._CheckRequiredCargos">OPSTRANSPORT:_CheckRequiredCargos(TransportZoneCombo, CarrierGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if all required cargos are loaded.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._CountCargosInZone">OPSTRANSPORT:_CountCargosInZone(Zone, Delivered, Carrier, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Count how many cargo groups are inside a zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._CreateCargoGroupData">OPSTRANSPORT:_CreateCargoGroupData(group, TransportZoneCombo, DisembarkActivation, DisembarkZone, DisembarkCarriers)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a cargo group data structure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._CreateCargoStorage">OPSTRANSPORT:_CreateCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a cargo group data structure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._DelCarrier">OPSTRANSPORT:_DelCarrier(CarrierGroup, Delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Remove group from the current carrier list/table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetCarrierNames">OPSTRANSPORT:_GetCarrierNames()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a list of alive carriers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetFormationDefault">OPSTRANSPORT:_GetFormationDefault(OpsGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get pickup formation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetFormationPickup">OPSTRANSPORT:_GetFormationPickup(TransportZoneCombo, OpsGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get pickup formation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetFormationTransport">OPSTRANSPORT:_GetFormationTransport(TransportZoneCombo, OpsGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get transport formation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetOpsGroupFromObject">OPSTRANSPORT:_GetOpsGroupFromObject(Object)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get an OPSGROUP from a given OPSGROUP or GROUP object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetPathTransport">OPSTRANSPORT:_GetPathTransport(Category, TransportZoneCombo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a path for transportation.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._GetTransportZoneCombo">OPSTRANSPORT:_GetTransportZoneCombo(Carrier)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a transport zone combination (TZC) for a carrier group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Cancel">OPSTRANSPORT:__Cancel(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Cancel" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Delivered">OPSTRANSPORT:__Delivered(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Delivered" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Executing">OPSTRANSPORT:__Executing(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Executing" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Loaded">OPSTRANSPORT:__Loaded(delay, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Loaded" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Planned">OPSTRANSPORT:__Planned(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Planned" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Queued">OPSTRANSPORT:__Queued(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Queued" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Requested">OPSTRANSPORT:__Requested(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Requested" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Scheduled">OPSTRANSPORT:__Scheduled(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Scheduled" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__StatusUpdate">OPSTRANSPORT:__StatusUpdate(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Status" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).__Unloaded">OPSTRANSPORT:__Unloaded(delay, OpsGroupCargo, OpsGroupCarrier)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Unloaded" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).assets">OPSTRANSPORT.assets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse assets assigned for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).assetsCargo">OPSTRANSPORT.assetsCargo</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="##(OPSTRANSPORT).cargocounter">OPSTRANSPORT.cargocounter</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Running number to generate cargo UIDs.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).carrierTransportStatus">OPSTRANSPORT.carrierTransportStatus</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Status of each carrier.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).carriers">OPSTRANSPORT.carriers</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Carriers assigned for this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).chief">OPSTRANSPORT.chief</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Chief of the transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).commander">OPSTRANSPORT.commander</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Commander of the transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).conditionStart">OPSTRANSPORT.conditionStart</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Start conditions.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).duration">OPSTRANSPORT.duration</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Duration (<code>Tstop-Tstart</code>) of the transport in seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).formationArmy">OPSTRANSPORT.formationArmy</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Default formation for ground vehicles.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).formationHelo">OPSTRANSPORT.formationHelo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Default formation for helicopters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).formationPlane">OPSTRANSPORT.formationPlane</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Default formation for airplanes.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).importance">OPSTRANSPORT.importance</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Importance of this transport. Smaller=higher.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).legions">OPSTRANSPORT.legions</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Assigned legions.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).lid">OPSTRANSPORT.lid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Log ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).mission">OPSTRANSPORT.mission</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The mission attached to this transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).nCarriersMax">OPSTRANSPORT.nCarriersMax</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="##(OPSTRANSPORT).nCarriersMin">OPSTRANSPORT.nCarriersMin</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="##(OPSTRANSPORT).onafterCancel">OPSTRANSPORT:onafterCancel(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Cancel" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterDeadCarrierAll">OPSTRANSPORT:onafterDeadCarrierAll(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "DeadCarrierAll" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterDeadCarrierGroup">OPSTRANSPORT:onafterDeadCarrierGroup(From, Event, To, OpsGroup)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "DeadCarrierGroup" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterDelivered">OPSTRANSPORT:onafterDelivered(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Delivered" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterExecuting">OPSTRANSPORT:onafterExecuting(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Executing" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterLoaded">OPSTRANSPORT:onafterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Loaded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterPlanned">OPSTRANSPORT:onafterPlanned(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Planned" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterScheduled">OPSTRANSPORT:onafterScheduled(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Scheduled" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterStatusUpdate">OPSTRANSPORT:onafterStatusUpdate(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "StatusUpdate" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onafterUnloaded">OPSTRANSPORT:onafterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Unloaded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).onbeforeDelivered">OPSTRANSPORT:onbeforeDelivered(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Delivered" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).opszone">OPSTRANSPORT.opszone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>OPS zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).prio">OPSTRANSPORT.prio</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).requestID">OPSTRANSPORT.requestID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).statusCommander">OPSTRANSPORT.statusCommander</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Staus of the COMMANDER.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).statusLegion">OPSTRANSPORT.statusLegion</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport status of all assigned LEGIONs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).tzCombos">OPSTRANSPORT.tzCombos</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table of transport zone combos. Each element of the table is of type <code>#OPSTRANSPORT.TransportZoneCombo</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).tzcCounter">OPSTRANSPORT.tzcCounter</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Running number of added transport zone combos.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).tzcDefault">OPSTRANSPORT.tzcDefault</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Default transport zone combo.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).uid">OPSTRANSPORT.uid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique ID of the transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).urgent">OPSTRANSPORT.urgent</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, transport is urgent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).verbose">OPSTRANSPORT.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Verbosity level.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).version">OPSTRANSPORT.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Army Group 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 FSM</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="##(OPSTRANSPORT).AddEndState">OPSTRANSPORT:AddEndState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds an End state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddProcess">OPSTRANSPORT:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddScore">OPSTRANSPORT:AddScore(State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddScoreProcess">OPSTRANSPORT:AddScoreProcess(From, Event, State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).AddTransition">OPSTRANSPORT:AddTransition(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).CallScheduler">OPSTRANSPORT.CallScheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call scheduler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).ClassName">OPSTRANSPORT.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="##(OPSTRANSPORT).Events">OPSTRANSPORT.Events</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="##(OPSTRANSPORT).GetCurrentState">OPSTRANSPORT:GetCurrentState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetEndStates">OPSTRANSPORT:GetEndStates()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the End states.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetProcess">OPSTRANSPORT:GetProcess(From, Event)</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="##(OPSTRANSPORT).GetProcesses">OPSTRANSPORT:GetProcesses()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetScores">OPSTRANSPORT:GetScores()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the scores defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetStartState">OPSTRANSPORT:GetStartState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetState">OPSTRANSPORT:GetState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetSubs">OPSTRANSPORT:GetSubs()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the Subs defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).GetTransitions">OPSTRANSPORT:GetTransitions()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Is">OPSTRANSPORT:Is(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).LoadCallBacks">OPSTRANSPORT:LoadCallBacks(CallBackTable)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Load call backs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).New">OPSTRANSPORT:New()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creates a new FSM object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).Scores">OPSTRANSPORT.Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Scores.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).SetProcess">OPSTRANSPORT:SetProcess(From, Event, Fsm)</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="##(OPSTRANSPORT).SetStartState">OPSTRANSPORT:SetStartState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sets the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._ClearFSMEvent">OPSTRANSPORT:_ClearFSMEvent(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Clear scheduled FSM event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._EndStates">OPSTRANSPORT._EndStates</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="##(OPSTRANSPORT)._EventSchedules">OPSTRANSPORT._EventSchedules</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="##(OPSTRANSPORT)._Processes">OPSTRANSPORT._Processes</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="##(OPSTRANSPORT)._Scores">OPSTRANSPORT._Scores</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="##(OPSTRANSPORT)._StartState">OPSTRANSPORT._StartState</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="##(OPSTRANSPORT)._Transitions">OPSTRANSPORT._Transitions</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="##(OPSTRANSPORT)._add_to_map">OPSTRANSPORT:_add_to_map(Map, Event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add to map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._call_handler">OPSTRANSPORT:_call_handler(step, trigger, params, EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._create_transition">OPSTRANSPORT:_create_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._delayed_transition">OPSTRANSPORT:_delayed_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delayed transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._eventmap">OPSTRANSPORT:_eventmap(Events, EventStructure)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Event map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._gosub">OPSTRANSPORT:_gosub(ParentFrom, ParentEvent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Go sub.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._handler">OPSTRANSPORT:_handler(EventName, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._isendstate">OPSTRANSPORT:_isendstate(Current)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is end state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT)._submap">OPSTRANSPORT:_submap(subs, sub, name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sub maps.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).can">OPSTRANSPORT:can(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if can do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).cannot">OPSTRANSPORT:cannot(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if cannot do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).current">OPSTRANSPORT.current</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Current state name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).endstates">OPSTRANSPORT.endstates</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="##(OPSTRANSPORT).is">OPSTRANSPORT:is(State, state)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).options">OPSTRANSPORT.options</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Options.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT).subs">OPSTRANSPORT.subs</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subs.</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="##(OPSTRANSPORT).ClassID">OPSTRANSPORT.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="##(OPSTRANSPORT).ClassName">OPSTRANSPORT.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="##(OPSTRANSPORT).ClassNameAndID">OPSTRANSPORT.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="##(OPSTRANSPORT).ClearState">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventBirth">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventCrash">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventDead">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventDynamicCargoLoaded">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventDynamicCargoRemoved">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventDynamicCargoUnloaded">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventNewDynamicCargo">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventPlayerEnterAircraft">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventRemoveUnit">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventTakeoff">OPSTRANSPORT: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="##(OPSTRANSPORT).CreateEventUnitLost">OPSTRANSPORT: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="##(OPSTRANSPORT).E">OPSTRANSPORT: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="##(OPSTRANSPORT).EventDispatcher">OPSTRANSPORT: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="##(OPSTRANSPORT).EventRemoveAll">OPSTRANSPORT: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="##(OPSTRANSPORT).F">OPSTRANSPORT: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="##(OPSTRANSPORT).F2">OPSTRANSPORT: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="##(OPSTRANSPORT).F3">OPSTRANSPORT: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="##(OPSTRANSPORT).GetClassID">OPSTRANSPORT: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="##(OPSTRANSPORT).GetClassName">OPSTRANSPORT: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="##(OPSTRANSPORT).GetClassNameAndID">OPSTRANSPORT: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="##(OPSTRANSPORT).GetEventPriority">OPSTRANSPORT: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="##(OPSTRANSPORT).GetParent">OPSTRANSPORT: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="##(OPSTRANSPORT).GetProperties">OPSTRANSPORT: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="##(OPSTRANSPORT).GetProperty">OPSTRANSPORT: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="##(OPSTRANSPORT).GetState">OPSTRANSPORT: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="##(OPSTRANSPORT).HandleEvent">OPSTRANSPORT: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="##(OPSTRANSPORT).I">OPSTRANSPORT: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="##(OPSTRANSPORT).Inherit">OPSTRANSPORT: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="##(OPSTRANSPORT).IsInstanceOf">OPSTRANSPORT: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="##(OPSTRANSPORT).IsTrace">OPSTRANSPORT: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="##(OPSTRANSPORT).New">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEvent">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventBDA">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventBaseCaptured">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventBirth">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventCrash">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDead">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDetailedFailure">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDiscardChairAfterEjection">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDynamicCargoLoaded">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDynamicCargoRemoved">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventDynamicCargoUnloaded">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventEjection">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventEngineShutdown">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventEngineStartup">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventHit">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventHumanFailure">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventKill">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventLand">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventLandingAfterEjection">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventLandingQualityMark">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventMarkAdded">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventMarkChange">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventMarkRemoved">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventMissionEnd">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventMissionStart">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventNewDynamicCargo">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventParatrooperLanding">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventPilotDead">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventPlayerEnterAircraft">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventPlayerEnterUnit">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventPlayerLeaveUnit">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventRefueling">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventRefuelingStop">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventScore">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventShootingEnd">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventShootingStart">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventShot">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventTakeoff">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventTriggerZone">OPSTRANSPORT: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="##(OPSTRANSPORT).OnEventUnitLost">OPSTRANSPORT: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="##(OPSTRANSPORT).Properties">OPSTRANSPORT.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="##(OPSTRANSPORT).ScheduleOnce">OPSTRANSPORT: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="##(OPSTRANSPORT).ScheduleRepeat">OPSTRANSPORT: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="##(OPSTRANSPORT).ScheduleStop">OPSTRANSPORT: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="##(OPSTRANSPORT).Scheduler">OPSTRANSPORT.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="##(OPSTRANSPORT).SetEventPriority">OPSTRANSPORT: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="##(OPSTRANSPORT).SetProperty">OPSTRANSPORT: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="##(OPSTRANSPORT).SetState">OPSTRANSPORT: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="##(OPSTRANSPORT).T">OPSTRANSPORT: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="##(OPSTRANSPORT).T2">OPSTRANSPORT: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="##(OPSTRANSPORT).T3">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceAll">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceClass">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceClassMethod">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceLevel">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceOff">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceOn">OPSTRANSPORT: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="##(OPSTRANSPORT).TraceOnOff">OPSTRANSPORT: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="##(OPSTRANSPORT).UnHandleEvent">OPSTRANSPORT: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="##(OPSTRANSPORT)._">OPSTRANSPORT._</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="##(OPSTRANSPORT)._F">OPSTRANSPORT:_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="##(OPSTRANSPORT)._Serialize">OPSTRANSPORT:_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="##(OPSTRANSPORT)._T">OPSTRANSPORT:_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="##(OPSTRANSPORT).__">OPSTRANSPORT.__</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="##(OPSTRANSPORT).onEvent">OPSTRANSPORT: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="#(OPSTRANSPORT.CargoType)">Type <strong>OPSTRANSPORT.CargoType</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.CargoType)">OPSTRANSPORT.CargoType</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 OPSTRANSPORT.CargoType</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="##(OPSTRANSPORT.CargoType).OPSGROUP">OPSTRANSPORT.CargoType.OPSGROUP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Cargo is an OPSGROUP.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.CargoType).STORAGE">OPSTRANSPORT.CargoType.STORAGE</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Cargo is storage of DCS warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Condition)">Type <strong>OPSTRANSPORT.Condition</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.Condition)">OPSTRANSPORT.Condition</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 OPSTRANSPORT.Condition</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="##(OPSTRANSPORT.Condition).arg">OPSTRANSPORT.Condition.arg</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Optional arguments passed to the condition callback function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Condition).func">OPSTRANSPORT.Condition.func</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Callback function to check for a condition. Should return a #boolean.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Path)">Type <strong>OPSTRANSPORT.Path</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.Path)">OPSTRANSPORT.Path</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 OPSTRANSPORT.Path</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="##(OPSTRANSPORT.Path).category">OPSTRANSPORT.Path.category</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Category for which carriers this path is used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Path).radius">OPSTRANSPORT.Path.radius</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Radomization radius for waypoints in meters. Default 0 m.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Path).reverse">OPSTRANSPORT.Path.reverse</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, path is used in reversed order.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Path).waypoints">OPSTRANSPORT.Path.waypoints</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table of waypoints.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Status)">Type <strong>OPSTRANSPORT.Status</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.Status)">OPSTRANSPORT.Status</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 OPSTRANSPORT.Status</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="##(OPSTRANSPORT.Status).CANCELLED">OPSTRANSPORT.Status.CANCELLED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport was cancelled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).DELIVERED">OPSTRANSPORT.Status.DELIVERED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport was delivered. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).EXECUTING">OPSTRANSPORT.Status.EXECUTING</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport is being executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).FAILED">OPSTRANSPORT.Status.FAILED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport failed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).PLANNED">OPSTRANSPORT.Status.PLANNED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Planning state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).QUEUED">OPSTRANSPORT.Status.QUEUED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Queued state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).REQUESTED">OPSTRANSPORT.Status.REQUESTED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Requested state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).SCHEDULED">OPSTRANSPORT.Status.SCHEDULED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport is scheduled in the cargo queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Status).SUCCESS">OPSTRANSPORT.Status.SUCCESS</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport was a success.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Storage)">Type <strong>OPSTRANSPORT.Storage</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.Storage)">OPSTRANSPORT.Storage</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 OPSTRANSPORT.Storage</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="##(OPSTRANSPORT.Storage).cargoAmount">OPSTRANSPORT.Storage.cargoAmount</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Amount of cargo that should be transported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoDelivered">OPSTRANSPORT.Storage.cargoDelivered</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Amount of cargo that has been delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoLoaded">OPSTRANSPORT.Storage.cargoLoaded</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Amount of cargo that is loading.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoLost">OPSTRANSPORT.Storage.cargoLost</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Amount of cargo that was lost.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoReserved">OPSTRANSPORT.Storage.cargoReserved</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Amount of cargo that is reserved for a carrier group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoType">OPSTRANSPORT.Storage.cargoType</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Type of cargo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).cargoWeight">OPSTRANSPORT.Storage.cargoWeight</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Weight of one single cargo item in kg. Default 1 kg.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).storageFrom">OPSTRANSPORT.Storage.storageFrom</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Storage from.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.Storage).storageTo">OPSTRANSPORT.Storage.storageTo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Storage To.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.TransportZoneCombo)">Type <strong>OPSTRANSPORT.TransportZoneCombo</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(OPSTRANSPORT.TransportZoneCombo)">OPSTRANSPORT.TransportZoneCombo</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 OPSTRANSPORT.TransportZoneCombo</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="##(OPSTRANSPORT.TransportZoneCombo).Cargos">OPSTRANSPORT.TransportZoneCombo.Cargos</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Cargo groups of the TZ combo. Each element is of type <code>Ops.OpsGroup#OPSGROUP.CargoGroup</code>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).DeployAirbase">OPSTRANSPORT.TransportZoneCombo.DeployAirbase</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airbase for deploy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).DeployZone">OPSTRANSPORT.TransportZoneCombo.DeployZone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Deploy zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).DisembarkCarriers">OPSTRANSPORT.TransportZoneCombo.DisembarkCarriers</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Carriers where the cargo is directly disembarked to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).DisembarkZone">OPSTRANSPORT.TransportZoneCombo.DisembarkZone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Zone where the troops are disembared to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).EmbarkZone">OPSTRANSPORT.TransportZoneCombo.EmbarkZone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Embark zone if different from pickup zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).Ncargo">OPSTRANSPORT.TransportZoneCombo.Ncargo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of cargos assigned. This is a running number and <em>not</em> decreased if cargo is delivered or dead.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).Ncarriers">OPSTRANSPORT.TransportZoneCombo.Ncarriers</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of carrier groups using this transport zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).PickupAirbase">OPSTRANSPORT.TransportZoneCombo.PickupAirbase</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airbase for pickup.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).PickupFormation">OPSTRANSPORT.TransportZoneCombo.PickupFormation</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Formation used to pickup.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).PickupPaths">OPSTRANSPORT.TransportZoneCombo.PickupPaths</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Paths for pickup. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).PickupZone">OPSTRANSPORT.TransportZoneCombo.PickupZone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Pickup zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).RequiredCargos">OPSTRANSPORT.TransportZoneCombo.RequiredCargos</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Required cargos.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).TransportFormation">OPSTRANSPORT.TransportZoneCombo.TransportFormation</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Formation used to transport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).TransportPaths">OPSTRANSPORT.TransportZoneCombo.TransportPaths</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Path for Transport. Each elment of the table is of type <code>#OPSTRANSPORT.Path</code>. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).assets">OPSTRANSPORT.TransportZoneCombo.assets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Cargo assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).assetsCargo">OPSTRANSPORT.TransportZoneCombo.assetsCargo</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="##(OPSTRANSPORT.TransportZoneCombo).disembarkActivation">OPSTRANSPORT.TransportZoneCombo.disembarkActivation</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, troops are spawned in late activated state when disembarked from carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).disembarkInUtero">OPSTRANSPORT.TransportZoneCombo.disembarkInUtero</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, troops are disembarked "in utero".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).disembarkToCarriers">OPSTRANSPORT.TransportZoneCombo.disembarkToCarriers</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, cargo is supposed to embark to another carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(OPSTRANSPORT.TransportZoneCombo).uid">OPSTRANSPORT.TransportZoneCombo.uid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique ID of the TZ combo.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Ops.OpsTransport)" >Type <strong>Ops.OpsTransport</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##OPSTRANSPORT')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT)">Type <strong>OPSTRANSPORT</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>OPSTRANSPORT 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">
|
|
|
|
<a href="##(OPSTRANSPORT.CargoType)">#OPSTRANSPORT.CargoType</a>
|
|
<a id="#(OPSTRANSPORT).CargoType" ><strong>OPSTRANSPORT.CargoType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).ClassName" ><strong>OPSTRANSPORT.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncargo" ><strong>OPSTRANSPORT.Ncargo</strong></a>
|
|
|
|
<p>Total number of cargo groups.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcargoDead" ><strong>OPSTRANSPORT.NcargoDead</strong></a>
|
|
|
|
<p>Totalnumber of dead cargo groups.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncarrier" ><strong>OPSTRANSPORT.Ncarrier</strong></a>
|
|
|
|
<p>Total number of assigned carriers.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcarrierDead" ><strong>OPSTRANSPORT.NcarrierDead</strong></a>
|
|
|
|
<p>Total number of dead carrier groups</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ndelivered" ><strong>OPSTRANSPORT.Ndelivered</strong></a>
|
|
|
|
<p>Total number of cargo groups delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.Status)">#OPSTRANSPORT.Status</a>
|
|
<a id="#(OPSTRANSPORT).Status" ><strong>OPSTRANSPORT.Status</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(OPSTRANSPORT).Tover" ><strong>OPSTRANSPORT.Tover</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Time stamp.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstart" ><strong>OPSTRANSPORT.Tstart</strong></a>
|
|
|
|
<p>Start time in <em>abs.</em> seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstop" ><strong>OPSTRANSPORT.Tstop</strong></a>
|
|
|
|
<p>Stop time in <em>abs.</em> seconds. Default <code>#nil</code> (never stops).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).assets" ><strong>OPSTRANSPORT.assets</strong></a>
|
|
|
|
<p>Warehouse assets assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).cargocounter" ><strong>OPSTRANSPORT.cargocounter</strong></a>
|
|
|
|
<p>Running number to generate cargo UIDs.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carrierTransportStatus" ><strong>OPSTRANSPORT.carrierTransportStatus</strong></a>
|
|
|
|
<p>Status of each carrier.
|
|
</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carriers" ><strong>OPSTRANSPORT.carriers</strong></a>
|
|
|
|
<p>Carriers assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Chief.html##(CHIEF)">Ops.Chief#CHIEF</a>
|
|
<a id="#(OPSTRANSPORT).chief" ><strong>OPSTRANSPORT.chief</strong></a>
|
|
|
|
<p>Chief of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Commander.html##(COMMANDER)">Ops.Commander#COMMANDER</a>
|
|
<a id="#(OPSTRANSPORT).commander" ><strong>OPSTRANSPORT.commander</strong></a>
|
|
|
|
<p>Commander of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).conditionStart" ><strong>OPSTRANSPORT.conditionStart</strong></a>
|
|
|
|
<p>Start conditions.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).duration" ><strong>OPSTRANSPORT.duration</strong></a>
|
|
|
|
<p>Duration (<code>Tstop-Tstart</code>) of the transport in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationArmy" ><strong>OPSTRANSPORT.formationArmy</strong></a>
|
|
|
|
<p>Default formation for ground vehicles.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationHelo" ><strong>OPSTRANSPORT.formationHelo</strong></a>
|
|
|
|
<p>Default formation for helicopters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationPlane" ><strong>OPSTRANSPORT.formationPlane</strong></a>
|
|
|
|
<p>Default formation for airplanes.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).importance" ><strong>OPSTRANSPORT.importance</strong></a>
|
|
|
|
<p>Importance of this transport. Smaller=higher.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).legions" ><strong>OPSTRANSPORT.legions</strong></a>
|
|
|
|
<p>Assigned legions.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).lid" ><strong>OPSTRANSPORT.lid</strong></a>
|
|
|
|
<p>Log ID.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>
|
|
<a id="#(OPSTRANSPORT).mission" ><strong>OPSTRANSPORT.mission</strong></a>
|
|
|
|
<p>The mission attached to this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>
|
|
<a id="#(OPSTRANSPORT).opszone" ><strong>OPSTRANSPORT.opszone</strong></a>
|
|
|
|
<p>OPS zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).prio" ><strong>OPSTRANSPORT.prio</strong></a>
|
|
|
|
<p>Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).requestID" ><strong>OPSTRANSPORT.requestID</strong></a>
|
|
|
|
<p>The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).statusCommander" ><strong>OPSTRANSPORT.statusCommander</strong></a>
|
|
|
|
<p>Staus of the COMMANDER.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).statusLegion" ><strong>OPSTRANSPORT.statusLegion</strong></a>
|
|
|
|
<p>Transport status of all assigned LEGIONs.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).tzCombos" ><strong>OPSTRANSPORT.tzCombos</strong></a>
|
|
|
|
<p>Table of transport zone combos. Each element of the table is of type <code>#OPSTRANSPORT.TransportZoneCombo</code>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).tzcCounter" ><strong>OPSTRANSPORT.tzcCounter</strong></a>
|
|
|
|
<p>Running number of added transport zone combos.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<a id="#(OPSTRANSPORT).tzcDefault" ><strong>OPSTRANSPORT.tzcDefault</strong></a>
|
|
|
|
<p>Default transport zone combo.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).uid" ><strong>OPSTRANSPORT.uid</strong></a>
|
|
|
|
<p>Unique ID of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT).urgent" ><strong>OPSTRANSPORT.urgent</strong></a>
|
|
|
|
<p>If true, transport is urgent.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).verbose" ><strong>OPSTRANSPORT.verbose</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).version" ><strong>OPSTRANSPORT.version</strong></a>
|
|
|
|
<p>Army Group 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="#(OPSTRANSPORT).AddAsset" ><strong>OPSTRANSPORT:AddAsset(Asset, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add carrier asset to transport.</p>
|
|
|
|
<div id= "#Functions##AddAsset" 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>OPSTRANSPORT</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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>Asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset to be added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddAssetCargo" ><strong>OPSTRANSPORT:AddAssetCargo(Asset, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add cargo asset.</p>
|
|
|
|
<div id= "#Functions##AddAssetCargo" 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>OPSTRANSPORT</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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>Asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset to be added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddCargoGroups" ><strong>OPSTRANSPORT:AddCargoGroups(GroupSet, TransportZoneCombo, DisembarkActivation, DisembarkZone, DisembarkCarriers)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add cargo groups to be transported.</p>
|
|
|
|
<div id= "#Functions##AddCargoGroups" 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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>GroupSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set of groups to be transported. Can also be passed as a single GROUP or OPSGROUP object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>DisembarkActivation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If <code>true</code>, cargo group is activated when disembarked. If <code>false</code>, cargo groups are late activated when disembarked. Default <code>nil</code> (usually activated).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DisembarkZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the groups disembark to.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
|
|
<strong><strong>DisembarkCarriers</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier groups where the cargo directly disembarks to.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddCargoStorage" ><strong>OPSTRANSPORT:AddCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add cargo warehouse storage to be transported.</p>
|
|
|
|
|
|
<p>This adds items such as fuel, weapons and other equipment, which is to be transported
|
|
from one DCS warehouse to another.
|
|
For weapons and equipment, the weight per item has to be specified explicitly as these cannot be retrieved by the DCS API. For liquids the
|
|
default value of 1 kg per item should be used as the amount of liquid is already given in kg.</p>
|
|
|
|
<div id= "#Functions##AddCargoStorage" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<strong><strong>StorageFrom</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Storage warehouse from which the cargo is taken.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<strong><strong>StorageTo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Storage warehouse to which the cargo is delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>CargoType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of cargo, <em>e.g.</em> <code>"weapons.bombs.Mk_84"</code> or liquid type as #number.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>CargoAmount</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Amount of cargo. Liquids in kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>CargoWeight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Weight of a single cargo item in kg. Default 1 kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Transport zone combo if other than default.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddConditionStart" ><strong>OPSTRANSPORT:AddConditionStart(ConditionFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add start condition.</p>
|
|
|
|
<div id= "#Functions##AddConditionStart" 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>OPSTRANSPORT</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>
|
|
#function
|
|
<strong><strong>ConditionFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function that needs to be true before the transport can be started. Must return a #boolean.</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>Condition function arguments if any.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddLegion" ><strong>OPSTRANSPORT:AddLegion(Legion)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add LEGION to the transport.</p>
|
|
|
|
<div id= "#Functions##AddLegion" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The legion.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddPathTransport" ><strong>OPSTRANSPORT:AddPathTransport(PathGroup, Radius, TransportZoneCombo, Reversed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add path used for transportation from the pickup to the deploy zone.</p>
|
|
|
|
|
|
<p>If multiple paths are defined, a random one is chosen. The path is retrieved from the waypoints of a given group.
|
|
<strong>NOTE</strong> that the category group defines for which carriers this path is valid.
|
|
For example, if you specify a GROUND group to provide the waypoints, only assigned GROUND carriers will use the
|
|
path. </p>
|
|
|
|
<div id= "#Functions##AddPathTransport" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>PathGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A (late activated) GROUP defining a transport path by their waypoints.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Radius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Randomization radius in meters. Default 0 m.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Transport Zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Reversed</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).AddTransportZoneCombo" ><strong>OPSTRANSPORT:AddTransportZoneCombo(CargoGroups, PickupZone, DeployZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add pickup and deploy zone combination.</p>
|
|
|
|
<div id= "#Functions##AddTransportZoneCombo" 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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>CargoGroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Groups to be transported as cargo. Can also be a single <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> or <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>PickupZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are picked up.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DeployZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are picked up.</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone table.</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="#(OPSTRANSPORT).Cancel" ><strong>OPSTRANSPORT:Cancel()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Cancel".</p>
|
|
|
|
<div id= "#Functions##Cancel" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).DelAsset" ><strong>OPSTRANSPORT:DelAsset(Asset)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delete carrier asset from transport.</p>
|
|
|
|
<div id= "#Functions##DelAsset" 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>OPSTRANSPORT</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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>Asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset to be removed.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).Delivered" ><strong>OPSTRANSPORT:Delivered()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Delivered".</p>
|
|
|
|
<div id= "#Functions##Delivered" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).EvalConditionsAll" ><strong>OPSTRANSPORT:EvalConditionsAll(Conditions)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if all given condition are true.</p>
|
|
|
|
<div id= "#Functions##EvalConditionsAll" 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>OPSTRANSPORT</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>Conditions</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of conditions.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, all conditions were true. Returns false if at least one condition returned false.</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="#(OPSTRANSPORT).Executing" ><strong>OPSTRANSPORT:Executing()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Executing".</p>
|
|
|
|
<div id= "#Functions##Executing" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).FindTransferCarrierForCargo" ><strong>OPSTRANSPORT:FindTransferCarrierForCargo(CargoGroup, Zone, DisembarkCarriers, DeployAirbase)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Find transfer carrier element for cargo group.</p>
|
|
|
|
<div id= "#Functions##FindTransferCarrierForCargo" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CargoGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The cargo group that needs to be loaded into a carrier unit/element of the carrier group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>Zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Zone where the carrier must be in.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>DisembarkCarriers</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Disembark carriers.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<strong><strong>DeployAirbase</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Airbase where to deploy.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Ops.OpsGroup.html##(OPSGROUP.Element)">Ops.OpsGroup#OPSGROUP.Element</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>New carrier element for cargo or nil.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p><a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>New carrier group for cargo or nil.</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="#(OPSTRANSPORT).GetCargoOpsGroups" ><strong>OPSTRANSPORT:GetCargoOpsGroups(Delivered, Carrier, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get (all) cargo <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>s.</p>
|
|
|
|
|
|
<p>Optionally, only delivered or undelivered groups can be returned.</p>
|
|
|
|
<div id= "#Functions##GetCargoOpsGroups" 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>OPSTRANSPORT</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>Delivered</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, only delivered groups are returned. If <code>false</code> only undelivered groups are returned. If <code>nil</code>, all groups are returned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>Carrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</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>Cargo Ops groups. Can be and empty table <code>{}</code>.</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="#(OPSTRANSPORT).GetCargoStorages" ><strong>OPSTRANSPORT:GetCargoStorages(Delivered, Carrier, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get (all) cargo <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>s.</p>
|
|
|
|
|
|
<p>Optionally, only delivered or undelivered groups can be returned.</p>
|
|
|
|
<div id= "#Functions##GetCargoStorages" 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>OPSTRANSPORT</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>Delivered</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, only delivered groups are returned. If <code>false</code> only undelivered groups are returned. If <code>nil</code>, all groups are returned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>Carrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</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>Cargo Ops groups. Can be and empty table <code>{}</code>.</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="#(OPSTRANSPORT).GetCargoTotalWeight" ><strong>OPSTRANSPORT:GetCargoTotalWeight(Cargo, IncludeReserved)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get total weight.</p>
|
|
|
|
<div id= "#Functions##GetCargoTotalWeight" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP.CargoGroup)">Ops.OpsGroup#OPSGROUP.CargoGroup</a>
|
|
<strong><strong>Cargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>IncludeReserved</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Include reserved cargo.</p>
|
|
|
|
</div>
|
|
</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>Weight in kg.</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="#(OPSTRANSPORT).GetCargos" ><strong>OPSTRANSPORT:GetCargos(TransportZoneCombo, Carrier, Delivered)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get cargos.</p>
|
|
|
|
<div id= "#Functions##GetCargos" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>Carrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specific carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Delivered</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delivered status.</p>
|
|
|
|
</div>
|
|
</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>Cargos.</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="#(OPSTRANSPORT).GetCarrierTransportStatus" ><strong>OPSTRANSPORT:GetCarrierTransportStatus(CarrierGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get carrier transport status.</p>
|
|
|
|
<div id= "#Functions##GetCarrierTransportStatus" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP.</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>Carrier status.</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="#(OPSTRANSPORT).GetCarriers" ><strong>OPSTRANSPORT:GetCarriers()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get carriers.</p>
|
|
|
|
<div id= "#Functions##GetCarriers" 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>OPSTRANSPORT</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>Carrier Ops groups.</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="#(OPSTRANSPORT).GetDeployZone" ><strong>OPSTRANSPORT:GetDeployZone(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get deploy zone.</p>
|
|
|
|
<div id= "#Functions##GetDeployZone" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are deployed.</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="#(OPSTRANSPORT).GetDisembarkActivation" ><strong>OPSTRANSPORT:GetDisembarkActivation(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get disembark activation.</p>
|
|
|
|
<div id= "#Functions##GetDisembarkActivation" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, groups are spawned in late activated state.</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="#(OPSTRANSPORT).GetDisembarkCarriers" ><strong>OPSTRANSPORT:GetDisembarkCarriers(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get transfer carrier(s).</p>
|
|
|
|
|
|
<p>These are carrier groups, where the cargo is directly loaded into when disembarked.</p>
|
|
|
|
<div id= "#Functions##GetDisembarkCarriers" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</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>Table of carrier OPS groups.</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="#(OPSTRANSPORT).GetDisembarkInUtero" ><strong>OPSTRANSPORT:GetDisembarkInUtero(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get disembark in utero.</p>
|
|
|
|
<div id= "#Functions##GetDisembarkInUtero" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, groups stay in utero after disembarkment.</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="#(OPSTRANSPORT).GetDisembarkZone" ><strong>OPSTRANSPORT:GetDisembarkZone(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get disembark zone.</p>
|
|
|
|
<div id= "#Functions##GetDisembarkZone" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are disembarked to.</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="#(OPSTRANSPORT).GetEmbarkZone" ><strong>OPSTRANSPORT:GetEmbarkZone(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get embark zone.</p>
|
|
|
|
<div id= "#Functions##GetEmbarkZone" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are embarked from.</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="#(OPSTRANSPORT).GetLegionStatus" ><strong>OPSTRANSPORT:GetLegionStatus(Legion)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get LEGION transport status.</p>
|
|
|
|
<div id= "#Functions##GetLegionStatus" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The legion.</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>status Current status.</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="#(OPSTRANSPORT).GetNcargoDelivered" ><strong>OPSTRANSPORT:GetNcargoDelivered()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get number of delivered cargo groups.</p>
|
|
|
|
<div id= "#Functions##GetNcargoDelivered" 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>OPSTRANSPORT</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>Total number of delivered cargo groups.</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="#(OPSTRANSPORT).GetNcargoTotal" ><strong>OPSTRANSPORT:GetNcargoTotal()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get number of cargo groups.</p>
|
|
|
|
<div id= "#Functions##GetNcargoTotal" 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>OPSTRANSPORT</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>Total number of cargo groups.</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="#(OPSTRANSPORT).GetNcarrier" ><strong>OPSTRANSPORT:GetNcarrier()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get number of carrier groups assigned for this transport.</p>
|
|
|
|
<div id= "#Functions##GetNcarrier" 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>OPSTRANSPORT</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>Total number of carrier groups.</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="#(OPSTRANSPORT).GetPickupZone" ><strong>OPSTRANSPORT:GetPickupZone(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get pickup zone.</p>
|
|
|
|
<div id= "#Functions##GetPickupZone" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are picked up.</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="#(OPSTRANSPORT).GetRequiredCargos" ><strong>OPSTRANSPORT:GetRequiredCargos(TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get required cargos.</p>
|
|
|
|
|
|
<p>This is a list of cargo groups that need to be loaded before the <strong>first</strong> transport will start.</p>
|
|
|
|
<div id= "#Functions##GetRequiredCargos" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</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>Table of required cargo ops groups.</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="#(OPSTRANSPORT).GetRequiredCarriers" ><strong>OPSTRANSPORT:GetRequiredCarriers()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the number of required carrier groups for an OPSTRANSPORT assignment.</p>
|
|
|
|
|
|
<p>Only used if transport is assigned at <strong>LEGION</strong> or higher level.</p>
|
|
|
|
<div id= "#Functions##GetRequiredCarriers" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
<h2><strong>Return values:</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>Number of carriers <em>at least</em> required.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of carriers <em>at most</em> used for transportation.</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="#(OPSTRANSPORT).GetTZCofCargo" ><strong>OPSTRANSPORT:GetTZCofCargo(GroupName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get transport zone combo of cargo group.</p>
|
|
|
|
<div id= "#Functions##GetTZCofCargo" 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>OPSTRANSPORT</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>GroupName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group name of cargo.</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>TransportZoneCombo Transport zone combo.</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="#(OPSTRANSPORT).GetUID" ><strong>OPSTRANSPORT:GetUID()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get unique ID of the transport assignment.</p>
|
|
|
|
<div id= "#Functions##GetUID" 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>OPSTRANSPORT</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>UID.</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="#(OPSTRANSPORT).IsCargoDelivered" ><strong>OPSTRANSPORT:IsCargoDelivered(GroupName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if a cargo group was delivered.</p>
|
|
|
|
<div id= "#Functions##IsCargoDelivered" 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>OPSTRANSPORT</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>GroupName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, cargo was delivered.</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="#(OPSTRANSPORT).IsCarrier" ><strong>OPSTRANSPORT:IsCarrier(CarrierGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if an OPS group is assigned as carrier for this transport.</p>
|
|
|
|
<div id= "#Functions##IsCarrier" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Potential carrier OPSGROUP.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, group is an assigned carrier. </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="#(OPSTRANSPORT).IsDelivered" ><strong>OPSTRANSPORT:IsDelivered(Nmin)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if all cargo was delivered (or is dead).</p>
|
|
|
|
<div id= "#Functions##IsDelivered" 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>OPSTRANSPORT</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>Nmin</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number of groups that must be actually delivered (and are not dead). Default 0.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, all possible cargo was delivered. </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="#(OPSTRANSPORT).IsExecuting" ><strong>OPSTRANSPORT:IsExecuting()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if state is EXECUTING.</p>
|
|
|
|
<div id= "#Functions##IsExecuting" 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>OPSTRANSPORT</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">
|
|
|
|
<p>If true, status is EXECUTING. </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="#(OPSTRANSPORT).IsPlanned" ><strong>OPSTRANSPORT:IsPlanned()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if state is PLANNED.</p>
|
|
|
|
<div id= "#Functions##IsPlanned" 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>OPSTRANSPORT</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">
|
|
|
|
<p>If true, status is PLANNED. </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="#(OPSTRANSPORT).IsQueued" ><strong>OPSTRANSPORT:IsQueued(Legion)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if state is QUEUED.</p>
|
|
|
|
<div id= "#Functions##IsQueued" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Check if transport is queued at this legion.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, status is QUEUED. </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="#(OPSTRANSPORT).IsReadyToGo" ><strong>OPSTRANSPORT:IsReadyToGo()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if transport is ready to be started.</p>
|
|
|
|
|
|
<ul>
|
|
<li>Start time passed.</li>
|
|
<li>Stop time did not pass already.</li>
|
|
<li>All start conditions are true.</li>
|
|
</ul>
|
|
|
|
<div id= "#Functions##IsReadyToGo" 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>OPSTRANSPORT</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">
|
|
|
|
<p>If true, mission can be started.</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="#(OPSTRANSPORT).IsRequested" ><strong>OPSTRANSPORT:IsRequested(Legion)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if state is REQUESTED.</p>
|
|
|
|
<div id= "#Functions##IsRequested" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Check if transport is queued at this legion.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, status is REQUESTED. </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="#(OPSTRANSPORT).IsScheduled" ><strong>OPSTRANSPORT:IsScheduled()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if state is SCHEDULED.</p>
|
|
|
|
<div id= "#Functions##IsScheduled" 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>OPSTRANSPORT</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">
|
|
|
|
<p>If true, status is SCHEDULED. </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="#(OPSTRANSPORT).Loaded" ><strong>OPSTRANSPORT:Loaded(OpsGroupCargo, OpsGroupCarrier, CarrierElement)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Loaded".</p>
|
|
|
|
<div id= "#Functions##Loaded" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP.Element)">Ops.OpsGroup#OPSGROUP.Element</a>
|
|
<strong><strong>CarrierElement</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier element.</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="#(OPSTRANSPORT).New" ><strong>OPSTRANSPORT:New(CargoGroups, PickupZone, DeployZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new OPSTRANSPORT class object.</p>
|
|
|
|
|
|
<p>Essential input are the troops that should be transported and the zones where the troops are picked up and deployed.</p>
|
|
|
|
<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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>CargoGroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Groups to be transported as cargo. Can also be a single <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> or <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>PickupZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pickup zone. This is the zone, where the carrier is going to pickup the cargo. <strong>Important</strong>: only cargo is considered, if it is in this zone when the carrier starts loading!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DeployZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Deploy zone. This is the zone, where the carrier is going to drop off the cargo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).OnAfterCancel" ><strong>OPSTRANSPORT:OnAfterCancel(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Cancel" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterCancel" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterDelivered" ><strong>OPSTRANSPORT:OnAfterDelivered(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Delivered" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterDelivered" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterExecuting" ><strong>OPSTRANSPORT:OnAfterExecuting(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Executing" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterExecuting" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterLoaded" ><strong>OPSTRANSPORT:OnAfterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Loaded" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterLoaded" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP.Element)">Ops.OpsGroup#OPSGROUP.Element</a>
|
|
<strong><strong>CarrierElement</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier element.</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="#(OPSTRANSPORT).OnAfterPlanned" ><strong>OPSTRANSPORT:OnAfterPlanned(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Planned" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterPlanned" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterQueued" ><strong>OPSTRANSPORT:OnAfterQueued(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Queued" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterQueued" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterRequested" ><strong>OPSTRANSPORT:OnAfterRequested(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Requested" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterRequested" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterScheduled" ><strong>OPSTRANSPORT:OnAfterScheduled(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Scheduled" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterScheduled" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).OnAfterUnloaded" ><strong>OPSTRANSPORT:OnAfterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Unloaded" event.</p>
|
|
|
|
<div id= "#Functions##OnAfterUnloaded" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo OPSGROUP that was unloaded from a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP that unloaded the cargo.</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="#(OPSTRANSPORT).Planned" ><strong>OPSTRANSPORT:Planned()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Planned".</p>
|
|
|
|
<div id= "#Functions##Planned" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).Queued" ><strong>OPSTRANSPORT:Queued()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Queued".</p>
|
|
|
|
<div id= "#Functions##Queued" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).RemoveLegion" ><strong>OPSTRANSPORT:RemoveLegion(Legion)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove LEGION from transport.</p>
|
|
|
|
<div id= "#Functions##RemoveLegion" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The legion.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).Requested" ><strong>OPSTRANSPORT:Requested()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Requested".</p>
|
|
|
|
<div id= "#Functions##Requested" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).Scheduled" ><strong>OPSTRANSPORT:Scheduled()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Scheduled".</p>
|
|
|
|
<div id= "#Functions##Scheduled" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).SetCarrierTransportStatus" ><strong>OPSTRANSPORT:SetCarrierTransportStatus(CarrierGroup, Status)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a carrier assigned for this transport.</p>
|
|
|
|
<div id= "#Functions##SetCarrierTransportStatus" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Status</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier Status.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetDeployZone" ><strong>OPSTRANSPORT:SetDeployZone(DeployZone, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set deploy zone.</p>
|
|
|
|
<div id= "#Functions##SetDeployZone" 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>OPSTRANSPORT</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DeployZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are deployed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetDisembarkActivation" ><strong>OPSTRANSPORT:SetDisembarkActivation(Active, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set activation status of group when disembarked from transport carrier.</p>
|
|
|
|
<div id= "#Functions##SetDisembarkActivation" 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>OPSTRANSPORT</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>Active</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code> or <code>nil</code>, group is activated when disembarked. If <code>false</code>, group is late activated and needs to be activated manually.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetDisembarkCarriers" ><strong>OPSTRANSPORT:SetDisembarkCarriers(Carriers, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set/add transfer carrier(s).</p>
|
|
|
|
|
|
<p>These are carrier groups, where the cargo is directly loaded into when disembarked.</p>
|
|
|
|
<div id= "#Functions##SetDisembarkCarriers" 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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>Carriers</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetDisembarkInUtero" ><strong>OPSTRANSPORT:SetDisembarkInUtero(InUtero, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set if group remains <em>in utero</em> after disembarkment from carrier.</p>
|
|
|
|
|
|
<p>Can be used to directly load the group into another carrier. Similar to disembark in late activated state.</p>
|
|
|
|
<div id= "#Functions##SetDisembarkInUtero" 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>OPSTRANSPORT</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>InUtero</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code> or <code>nil</code>, group remains <em>in utero</em> after disembarkment.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetDisembarkZone" ><strong>OPSTRANSPORT:SetDisembarkZone(DisembarkZone, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set disembark zone.</p>
|
|
|
|
<div id= "#Functions##SetDisembarkZone" 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>OPSTRANSPORT</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DisembarkZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are disembarked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetEmbarkZone" ><strong>OPSTRANSPORT:SetEmbarkZone(EmbarkZone, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set embark zone.</p>
|
|
|
|
<div id= "#Functions##SetEmbarkZone" 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>OPSTRANSPORT</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>EmbarkZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are embarked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetFormationPickup" ><strong>OPSTRANSPORT:SetFormationPickup(Formation, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set pickup formation.</p>
|
|
|
|
<div id= "#Functions##SetFormationPickup" 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>OPSTRANSPORT</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>Formation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pickup formation.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetFormationTransport" ><strong>OPSTRANSPORT:SetFormationTransport(Formation, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set transport formation.</p>
|
|
|
|
<div id= "#Functions##SetFormationTransport" 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>OPSTRANSPORT</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>Formation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pickup formation.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetLegionStatus" ><strong>OPSTRANSPORT:SetLegionStatus(Legion, Status)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set LEGION transport status.</p>
|
|
|
|
<div id= "#Functions##SetLegionStatus" 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>OPSTRANSPORT</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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<strong><strong>Legion</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The legion.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Status</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>New status.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetPickupZone" ><strong>OPSTRANSPORT:SetPickupZone(PickupZone, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set pickup zone.</p>
|
|
|
|
<div id= "#Functions##SetPickupZone" 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>OPSTRANSPORT</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>PickupZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the troops are picked up.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetPriority" ><strong>OPSTRANSPORT:SetPriority(Prio, Importance, Urgent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set mission priority and (optional) urgency.</p>
|
|
|
|
|
|
<p>Urgent missions can cancel other running missions. </p>
|
|
|
|
<div id= "#Functions##SetPriority" 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>OPSTRANSPORT</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>Prio</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Priority 1=high, 100=low. Default 50.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Importance</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number 1-10. If missions with lower value are in the queue, these have to be finished first. Default is <code>nil</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Urgent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If <em>true</em>, another running mission might be cancelled if it has a lower 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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetRequiredCargos" ><strong>OPSTRANSPORT:SetRequiredCargos(Cargos, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set required cargo.</p>
|
|
|
|
|
|
<p>This is a list of cargo groups that need to be loaded before the <strong>first</strong> transport will start.</p>
|
|
|
|
<div id= "#Functions##SetRequiredCargos" 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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>Cargos</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Required cargo set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetRequiredCarriers" ><strong>OPSTRANSPORT:SetRequiredCarriers(NcarriersMin, NcarriersMax)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set number of required carrier groups for an OPSTRANSPORT assignment.</p>
|
|
|
|
|
|
<p>Only used if transport is assigned at <strong>LEGION</strong> or higher level.</p>
|
|
|
|
<div id= "#Functions##SetRequiredCarriers" 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>OPSTRANSPORT</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>NcarriersMin</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number of carriers <em>at least</em> required. Default 1.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>NcarriersMax</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number of carriers <em>at most</em> used for transportation. Default is same as <code>NcarriersMin</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetTime" ><strong>OPSTRANSPORT:SetTime(ClockStart, ClockStop)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set transport start and stop time.</p>
|
|
|
|
<div id= "#Functions##SetTime" 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>OPSTRANSPORT</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>ClockStart</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Time the transport is started, e.g. "05:00" for 5 am. If specified as a #number, it will be relative (in seconds) to the current mission time. Default is 5 seconds after mission was added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ClockStop</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Time the transport is stopped, e.g. "13:00" for 1 pm. If mission could not be started at that time, it will be removed from the queue. If specified as a #number it will be relative (in seconds) to the current mission time.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).SetVerbosity" ><strong>OPSTRANSPORT:SetVerbosity(Verbosity)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set verbosity. </p>
|
|
|
|
<div id= "#Functions##SetVerbosity" 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>OPSTRANSPORT</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>Verbosity</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Be more verbose. Default 0</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT).StatusUpdate" ><strong>OPSTRANSPORT:StatusUpdate()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "StatusUpdate".</p>
|
|
|
|
<div id= "#Functions##StatusUpdate" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT).Unloaded" ><strong>OPSTRANSPORT:Unloaded(OpsGroupCargo, OpsGroupCarrier)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Unloaded".</p>
|
|
|
|
<div id= "#Functions##Unloaded" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo OPSGROUP that was unloaded from a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP that unloaded the cargo.</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="#(OPSTRANSPORT)._AddCarrier" ><strong>OPSTRANSPORT:_AddCarrier(CarrierGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a carrier assigned for this transport.</p>
|
|
|
|
<div id= "#Functions##_AddCarrier" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT)._AddDisembarkCarriers" ><strong>OPSTRANSPORT:_AddDisembarkCarriers(Carriers, Table)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set/add transfer carrier(s).</p>
|
|
|
|
|
|
<p>These are carrier groups, where the cargo is directly loaded into when disembarked.</p>
|
|
|
|
<div id= "#Functions##_AddDisembarkCarriers" 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>OPSTRANSPORT</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>Carriers</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier set. Can also be passed as a #GROUP, #OPSGROUP or #SET_OPSGROUP object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Table</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the table to add.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT)._CheckDelivered" ><strong>OPSTRANSPORT:_CheckDelivered()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if all cargo of this transport assignment was delivered.</p>
|
|
|
|
<div id= "#Functions##_CheckDelivered" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(OPSTRANSPORT)._CheckRequiredCargos" ><strong>OPSTRANSPORT:_CheckRequiredCargos(TransportZoneCombo, CarrierGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if all required cargos are loaded.</p>
|
|
|
|
<div id= "#Functions##_CheckRequiredCargos" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The carrier group asking.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, all required cargos are loaded or there is no required cargo or asking carrier is full.</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="#(OPSTRANSPORT)._CountCargosInZone" ><strong>OPSTRANSPORT:_CountCargosInZone(Zone, Delivered, Carrier, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Count how many cargo groups are inside a zone.</p>
|
|
|
|
<div id= "#Functions##_CountCargosInZone" 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>OPSTRANSPORT</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>Zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The zone object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Delivered</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, only delivered groups are returned. If <code>false</code> only undelivered groups are returned. If <code>nil</code>, all groups are returned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>Carrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Only count cargo groups that fit into the given carrier group. Current cargo is not a factor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</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>Number of cargo groups.</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="#(OPSTRANSPORT)._CreateCargoGroupData" ><strong>OPSTRANSPORT:_CreateCargoGroupData(group, TransportZoneCombo, DisembarkActivation, DisembarkZone, DisembarkCarriers)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a cargo group data structure.</p>
|
|
|
|
<div id= "#Functions##_CreateCargoGroupData" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The GROUP or OPSGROUP object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>DisembarkActivation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, cargo group is activated when disembarked. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>DisembarkZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Disembark zone, where the cargo is spawned when delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
|
|
<strong><strong>DisembarkCarriers</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Disembark carriers cargo is directly loaded into when delivered.</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="Ops.OpsGroup.html##(OPSGROUP.CargoGroup)">Ops.OpsGroup#OPSGROUP.CargoGroup</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo group data.</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="#(OPSTRANSPORT)._CreateCargoStorage" ><strong>OPSTRANSPORT:_CreateCargoStorage(StorageFrom, StorageTo, CargoType, CargoAmount, CargoWeight, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a cargo group data structure.</p>
|
|
|
|
<div id= "#Functions##_CreateCargoStorage" 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>OPSTRANSPORT</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<strong><strong>StorageFrom</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Storage from.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<strong><strong>StorageTo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Storage to.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>CargoType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of cargo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>CargoAmount</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Total amount of cargo that should be transported. Liquids in kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>CargoWeight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Weight of a single cargo item in kg. Default 1 kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</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="Ops.OpsGroup.html##(OPSGROUP.CargoGroup)">Ops.OpsGroup#OPSGROUP.CargoGroup</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo group data.</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="#(OPSTRANSPORT)._DelCarrier" ><strong>OPSTRANSPORT:_DelCarrier(CarrierGroup, Delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Remove group from the current carrier list/table.</p>
|
|
|
|
<div id= "#Functions##_DelCarrier" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>CarrierGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds before the carrier is removed.</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="##(OPSTRANSPORT)">#OPSTRANSPORT</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="#(OPSTRANSPORT)._GetCarrierNames" ><strong>OPSTRANSPORT:_GetCarrierNames()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a list of alive carriers.</p>
|
|
|
|
<div id= "#Functions##_GetCarrierNames" 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>OPSTRANSPORT</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>Names of all carriers</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="#(OPSTRANSPORT)._GetFormationDefault" ><strong>OPSTRANSPORT:_GetFormationDefault(OpsGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get pickup formation.</p>
|
|
|
|
<div id= "#Functions##_GetFormationDefault" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroup</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>Formation.</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="#(OPSTRANSPORT)._GetFormationPickup" ><strong>OPSTRANSPORT:_GetFormationPickup(TransportZoneCombo, OpsGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get pickup formation.</p>
|
|
|
|
<div id= "#Functions##_GetFormationPickup" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroup</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>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Formation.</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="#(OPSTRANSPORT)._GetFormationTransport" ><strong>OPSTRANSPORT:_GetFormationTransport(TransportZoneCombo, OpsGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get transport formation.</p>
|
|
|
|
<div id= "#Functions##_GetFormationTransport" 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>OPSTRANSPORT</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="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport zone combo.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroup</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>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Formation.</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="#(OPSTRANSPORT)._GetOpsGroupFromObject" ><strong>OPSTRANSPORT:_GetOpsGroupFromObject(Object)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get an OPSGROUP from a given OPSGROUP or GROUP object.</p>
|
|
|
|
|
|
<p>If the object is a GROUP, an OPSGROUP is created automatically. </p>
|
|
|
|
<div id= "#Functions##_GetOpsGroupFromObject" 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>OPSTRANSPORT</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.Base.html##(BASE)">Core.Base#BASE</a>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object, which can be a GROUP or OPSGROUP.</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ops Group.</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="#(OPSTRANSPORT)._GetPathTransport" ><strong>OPSTRANSPORT:_GetPathTransport(Category, TransportZoneCombo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a path for transportation.</p>
|
|
|
|
<div id= "#Functions##_GetPathTransport" 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>OPSTRANSPORT</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>Category</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group category.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<strong><strong>TransportZoneCombo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transport Zone combo.</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="##(OPSTRANSPORT.Path)">#OPSTRANSPORT.Path</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The path 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="#(OPSTRANSPORT)._GetTransportZoneCombo" ><strong>OPSTRANSPORT:_GetTransportZoneCombo(Carrier)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a transport zone combination (TZC) for a carrier group.</p>
|
|
|
|
|
|
<p>The pickup zone will be a zone, where the most cargo groups are located that fit into the carrier.</p>
|
|
|
|
<div id= "#Functions##_GetTransportZoneCombo" 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>OPSTRANSPORT</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="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>Carrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The carrier OPS group.</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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pickup zone or <code>#nil</code>.</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="#(OPSTRANSPORT).__Cancel" ><strong>OPSTRANSPORT:__Cancel(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Cancel" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Cancel" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Delivered" ><strong>OPSTRANSPORT:__Delivered(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Delivered" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Delivered" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Executing" ><strong>OPSTRANSPORT:__Executing(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Executing" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Executing" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Loaded" ><strong>OPSTRANSPORT:__Loaded(delay, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Loaded" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Loaded" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP.Element)">Ops.OpsGroup#OPSGROUP.Element</a>
|
|
<strong><strong>CarrierElement</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier element.</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="#(OPSTRANSPORT).__Planned" ><strong>OPSTRANSPORT:__Planned(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Planned" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Planned" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Queued" ><strong>OPSTRANSPORT:__Queued(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Queued" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Queued" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Requested" ><strong>OPSTRANSPORT:__Requested(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Requested" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Requested" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Scheduled" ><strong>OPSTRANSPORT:__Scheduled(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Scheduled" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Scheduled" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__StatusUpdate" ><strong>OPSTRANSPORT:__StatusUpdate(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Status" after a delay.</p>
|
|
|
|
<div id= "#Functions##__StatusUpdate" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</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="#(OPSTRANSPORT).__Unloaded" ><strong>OPSTRANSPORT:__Unloaded(delay, OpsGroupCargo, OpsGroupCarrier)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Unloaded" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Unloaded" 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>OPSTRANSPORT</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>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo OPSGROUP that was unloaded from a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP that unloaded the cargo.</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="#(OPSTRANSPORT).onafterCancel" ><strong>OPSTRANSPORT:onafterCancel(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Cancel" event.</p>
|
|
|
|
<div id= "#Functions##onafterCancel" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterDeadCarrierAll" ><strong>OPSTRANSPORT:onafterDeadCarrierAll(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "DeadCarrierAll" event.</p>
|
|
|
|
<div id= "#Functions##onafterDeadCarrierAll" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state. </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="#(OPSTRANSPORT).onafterDeadCarrierGroup" ><strong>OPSTRANSPORT:onafterDeadCarrierGroup(From, Event, To, OpsGroup)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "DeadCarrierGroup" event.</p>
|
|
|
|
<div id= "#Functions##onafterDeadCarrierGroup" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP that is dead. </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="#(OPSTRANSPORT).onafterDelivered" ><strong>OPSTRANSPORT:onafterDelivered(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Delivered" event.</p>
|
|
|
|
<div id= "#Functions##onafterDelivered" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterExecuting" ><strong>OPSTRANSPORT:onafterExecuting(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Executing" event.</p>
|
|
|
|
<div id= "#Functions##onafterExecuting" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterLoaded" ><strong>OPSTRANSPORT:onafterLoaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier, CarrierElement)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Loaded" event.</p>
|
|
|
|
<div id= "#Functions##onafterLoaded" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>OPSGROUP that was loaded into a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP.Element)">Ops.OpsGroup#OPSGROUP.Element</a>
|
|
<strong><strong>CarrierElement</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier element.</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="#(OPSTRANSPORT).onafterPlanned" ><strong>OPSTRANSPORT:onafterPlanned(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Planned" event.</p>
|
|
|
|
<div id= "#Functions##onafterPlanned" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterScheduled" ><strong>OPSTRANSPORT:onafterScheduled(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Scheduled" event.</p>
|
|
|
|
<div id= "#Functions##onafterScheduled" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterStatusUpdate" ><strong>OPSTRANSPORT:onafterStatusUpdate(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "StatusUpdate" event.</p>
|
|
|
|
<div id= "#Functions##onafterStatusUpdate" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).onafterUnloaded" ><strong>OPSTRANSPORT:onafterUnloaded(From, Event, To, OpsGroupCargo, OpsGroupCarrier)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Unloaded" event.</p>
|
|
|
|
<div id= "#Functions##onafterUnloaded" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo OPSGROUP that was unloaded from a carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<strong><strong>OpsGroupCarrier</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Carrier OPSGROUP that unloaded the cargo.</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="#(OPSTRANSPORT).onbeforeDelivered" ><strong>OPSTRANSPORT:onbeforeDelivered(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Delivered" event.</p>
|
|
|
|
<div id= "#Functions##onbeforeDelivered" 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>OPSTRANSPORT</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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">
|
|
|
|
<a href="##(OPSTRANSPORT.CargoType)">#OPSTRANSPORT.CargoType</a>
|
|
<a id="#(OPSTRANSPORT).CargoType" ><strong>OPSTRANSPORT.CargoType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).ClassName" ><strong>OPSTRANSPORT.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncargo" ><strong>OPSTRANSPORT.Ncargo</strong></a>
|
|
|
|
<p>Total number of cargo groups.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcargoDead" ><strong>OPSTRANSPORT.NcargoDead</strong></a>
|
|
|
|
<p>Totalnumber of dead cargo groups.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncarrier" ><strong>OPSTRANSPORT.Ncarrier</strong></a>
|
|
|
|
<p>Total number of assigned carriers.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcarrierDead" ><strong>OPSTRANSPORT.NcarrierDead</strong></a>
|
|
|
|
<p>Total number of dead carrier groups</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ndelivered" ><strong>OPSTRANSPORT.Ndelivered</strong></a>
|
|
|
|
<p>Total number of cargo groups delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.Status)">#OPSTRANSPORT.Status</a>
|
|
<a id="#(OPSTRANSPORT).Status" ><strong>OPSTRANSPORT.Status</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(OPSTRANSPORT).Tover" ><strong>OPSTRANSPORT.Tover</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Time stamp.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstart" ><strong>OPSTRANSPORT.Tstart</strong></a>
|
|
|
|
<p>Start time in <em>abs.</em> seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstop" ><strong>OPSTRANSPORT.Tstop</strong></a>
|
|
|
|
<p>Stop time in <em>abs.</em> seconds. Default <code>#nil</code> (never stops).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).assets" ><strong>OPSTRANSPORT.assets</strong></a>
|
|
|
|
<p>Warehouse assets assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).cargocounter" ><strong>OPSTRANSPORT.cargocounter</strong></a>
|
|
|
|
<p>Running number to generate cargo UIDs.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carrierTransportStatus" ><strong>OPSTRANSPORT.carrierTransportStatus</strong></a>
|
|
|
|
<p>Status of each carrier.
|
|
</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carriers" ><strong>OPSTRANSPORT.carriers</strong></a>
|
|
|
|
<p>Carriers assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Chief.html##(CHIEF)">Ops.Chief#CHIEF</a>
|
|
<a id="#(OPSTRANSPORT).chief" ><strong>OPSTRANSPORT.chief</strong></a>
|
|
|
|
<p>Chief of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Commander.html##(COMMANDER)">Ops.Commander#COMMANDER</a>
|
|
<a id="#(OPSTRANSPORT).commander" ><strong>OPSTRANSPORT.commander</strong></a>
|
|
|
|
<p>Commander of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).conditionStart" ><strong>OPSTRANSPORT.conditionStart</strong></a>
|
|
|
|
<p>Start conditions.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).duration" ><strong>OPSTRANSPORT.duration</strong></a>
|
|
|
|
<p>Duration (<code>Tstop-Tstart</code>) of the transport in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationArmy" ><strong>OPSTRANSPORT.formationArmy</strong></a>
|
|
|
|
<p>Default formation for ground vehicles.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationHelo" ><strong>OPSTRANSPORT.formationHelo</strong></a>
|
|
|
|
<p>Default formation for helicopters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationPlane" ><strong>OPSTRANSPORT.formationPlane</strong></a>
|
|
|
|
<p>Default formation for airplanes.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).importance" ><strong>OPSTRANSPORT.importance</strong></a>
|
|
|
|
<p>Importance of this transport. Smaller=higher.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).legions" ><strong>OPSTRANSPORT.legions</strong></a>
|
|
|
|
<p>Assigned legions.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).lid" ><strong>OPSTRANSPORT.lid</strong></a>
|
|
|
|
<p>Log ID.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>
|
|
<a id="#(OPSTRANSPORT).mission" ><strong>OPSTRANSPORT.mission</strong></a>
|
|
|
|
<p>The mission attached to this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>
|
|
<a id="#(OPSTRANSPORT).opszone" ><strong>OPSTRANSPORT.opszone</strong></a>
|
|
|
|
<p>OPS zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).prio" ><strong>OPSTRANSPORT.prio</strong></a>
|
|
|
|
<p>Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).requestID" ><strong>OPSTRANSPORT.requestID</strong></a>
|
|
|
|
<p>The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).statusCommander" ><strong>OPSTRANSPORT.statusCommander</strong></a>
|
|
|
|
<p>Staus of the COMMANDER.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).statusLegion" ><strong>OPSTRANSPORT.statusLegion</strong></a>
|
|
|
|
<p>Transport status of all assigned LEGIONs.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).tzCombos" ><strong>OPSTRANSPORT.tzCombos</strong></a>
|
|
|
|
<p>Table of transport zone combos. Each element of the table is of type <code>#OPSTRANSPORT.TransportZoneCombo</code>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).tzcCounter" ><strong>OPSTRANSPORT.tzcCounter</strong></a>
|
|
|
|
<p>Running number of added transport zone combos.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<a id="#(OPSTRANSPORT).tzcDefault" ><strong>OPSTRANSPORT.tzcDefault</strong></a>
|
|
|
|
<p>Default transport zone combo.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).uid" ><strong>OPSTRANSPORT.uid</strong></a>
|
|
|
|
<p>Unique ID of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT).urgent" ><strong>OPSTRANSPORT.urgent</strong></a>
|
|
|
|
<p>If true, transport is urgent.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).verbose" ><strong>OPSTRANSPORT.verbose</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).version" ><strong>OPSTRANSPORT.version</strong></a>
|
|
|
|
<p>Army Group 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="#(OPSTRANSPORT).AddEndState" ><strong>OPSTRANSPORT:AddEndState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds an End state.</p>
|
|
|
|
<div id= "#Functions##AddEndState" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The FSM state.</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="#(OPSTRANSPORT).AddProcess" ><strong>OPSTRANSPORT:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
|
|
<div id= "#Functions##AddProcess" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>
|
|
<strong><strong>Process</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>An sub-process FSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>ReturnEvents</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.</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="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The SubFSM.</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="#(OPSTRANSPORT).AddScore" ><strong>OPSTRANSPORT:AddScore(State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScore" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</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="##(FSM)">#FSM</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="#(OPSTRANSPORT).AddScoreProcess" ><strong>OPSTRANSPORT:AddScoreProcess(From, Event, State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScoreProcess" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the From State of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Event of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</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="##(FSM)">#FSM</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="#(OPSTRANSPORT).AddTransition" ><strong>OPSTRANSPORT:AddTransition(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
|
|
|
|
<p>A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.</p>
|
|
|
|
<div id= "#Functions##AddTransition" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event 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>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The To state.</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="#(OPSTRANSPORT).GetCurrentState" ><strong>OPSTRANSPORT:GetCurrentState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</p>
|
|
|
|
<div id= "#Functions##GetCurrentState" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Current FSM state.</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="#(OPSTRANSPORT).GetEndStates" ><strong>OPSTRANSPORT:GetEndStates()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the End states.</p>
|
|
|
|
<div id= "#Functions##GetEndStates" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>End states.</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="#(OPSTRANSPORT).GetProcess" ><strong>OPSTRANSPORT:GetProcess(From, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetProcess" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>From</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>Event</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="#(OPSTRANSPORT).GetProcesses" ><strong>OPSTRANSPORT:GetProcesses()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetProcesses" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Sub processes.</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="#(OPSTRANSPORT).GetScores" ><strong>OPSTRANSPORT:GetScores()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the scores defined.</p>
|
|
|
|
<div id= "#Functions##GetScores" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Scores.</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="#(OPSTRANSPORT).GetStartState" ><strong>OPSTRANSPORT:GetStartState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##GetStartState" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>A string containing the start state.</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="#(OPSTRANSPORT).GetState" ><strong>OPSTRANSPORT:GetState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Current FSM state.</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="#(OPSTRANSPORT).GetSubs" ><strong>OPSTRANSPORT:GetSubs()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the Subs defined.</p>
|
|
|
|
<div id= "#Functions##GetSubs" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Sub processes.</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="#(OPSTRANSPORT).GetTransitions" ><strong>OPSTRANSPORT:GetTransitions()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetTransitions" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Transitions.</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="#(OPSTRANSPORT).Is" ><strong>OPSTRANSPORT:Is(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##Is" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state.</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="#(OPSTRANSPORT).LoadCallBacks" ><strong>OPSTRANSPORT:LoadCallBacks(CallBackTable)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Load call backs.</p>
|
|
|
|
<div id= "#Functions##LoadCallBacks" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>CallBackTable</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of call backs.</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="#(OPSTRANSPORT).New" ><strong>OPSTRANSPORT:New()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creates a new FSM object.</p>
|
|
|
|
<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.Fsm.html##(FSM)">Core.Fsm#FSM</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="##(FSM)">#FSM</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="#(OPSTRANSPORT).SetProcess" ><strong>OPSTRANSPORT:SetProcess(From, Event, Fsm)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##SetProcess" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>From</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>Event</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>Fsm</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="#(OPSTRANSPORT).SetStartState" ><strong>OPSTRANSPORT:SetStartState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sets the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##SetStartState" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A string defining the start state.</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="#(OPSTRANSPORT)._ClearFSMEvent" ><strong>OPSTRANSPORT:_ClearFSMEvent(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Clear scheduled FSM event.</p>
|
|
|
|
<div id= "#Functions##_ClearFSMEvent" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event 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="#(OPSTRANSPORT)._add_to_map" ><strong>OPSTRANSPORT:_add_to_map(Map, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add to map.</p>
|
|
|
|
<div id= "#Functions##_add_to_map" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>
|
|
#table
|
|
<strong><strong>Map</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event table.</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="#(OPSTRANSPORT)._call_handler" ><strong>OPSTRANSPORT:_call_handler(step, trigger, params, EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Call handler.</p>
|
|
|
|
<div id= "#Functions##_call_handler" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>step</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Step "onafter", "onbefore", "onenter", "onleave".</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>trigger</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Trigger.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>params</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parameters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</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.</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="#(OPSTRANSPORT)._create_transition" ><strong>OPSTRANSPORT:_create_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create transition.</p>
|
|
|
|
<div id= "#Functions##_create_transition" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</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="#(OPSTRANSPORT)._delayed_transition" ><strong>OPSTRANSPORT:_delayed_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delayed transition.</p>
|
|
|
|
<div id= "#Functions##_delayed_transition" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</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="#(OPSTRANSPORT)._eventmap" ><strong>OPSTRANSPORT:_eventmap(Events, EventStructure)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Event map.</p>
|
|
|
|
<div id= "#Functions##_eventmap" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>
|
|
#table
|
|
<strong><strong>Events</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Events.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>EventStructure</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event 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="#(OPSTRANSPORT)._gosub" ><strong>OPSTRANSPORT:_gosub(ParentFrom, ParentEvent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Go sub.</p>
|
|
|
|
<div id= "#Functions##_gosub" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>ParentFrom</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent from state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ParentEvent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent event name.</p>
|
|
|
|
</div>
|
|
</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>Subs.</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="#(OPSTRANSPORT)._handler" ><strong>OPSTRANSPORT:_handler(EventName, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Handler.</p>
|
|
|
|
<div id= "#Functions##_handler" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</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>Arguments.</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="#(OPSTRANSPORT)._isendstate" ><strong>OPSTRANSPORT:_isendstate(Current)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Is end state.</p>
|
|
|
|
<div id= "#Functions##_isendstate" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>Current</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current state name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</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>FSM parent.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event 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="#(OPSTRANSPORT)._submap" ><strong>OPSTRANSPORT:_submap(subs, sub, name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sub maps.</p>
|
|
|
|
<div id= "#Functions##_submap" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>
|
|
#table
|
|
<strong><strong>subs</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Subs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>sub</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>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="#(OPSTRANSPORT).can" ><strong>OPSTRANSPORT:can(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if can do an event.</p>
|
|
|
|
<div id= "#Functions##can" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM can do the event.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</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="#(OPSTRANSPORT).cannot" ><strong>OPSTRANSPORT:cannot(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if cannot do an event.</p>
|
|
|
|
<div id= "#Functions##cannot" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM cannot do 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="#(OPSTRANSPORT).is" ><strong>OPSTRANSPORT:is(State, state)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##is" 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.Fsm.html##(FSM)">Core.Fsm#FSM</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>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>state</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>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state. </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">
|
|
|
|
<a href="##(OPSTRANSPORT.CargoType)">#OPSTRANSPORT.CargoType</a>
|
|
<a id="#(OPSTRANSPORT).CargoType" ><strong>OPSTRANSPORT.CargoType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).ClassName" ><strong>OPSTRANSPORT.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncargo" ><strong>OPSTRANSPORT.Ncargo</strong></a>
|
|
|
|
<p>Total number of cargo groups.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcargoDead" ><strong>OPSTRANSPORT.NcargoDead</strong></a>
|
|
|
|
<p>Totalnumber of dead cargo groups.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ncarrier" ><strong>OPSTRANSPORT.Ncarrier</strong></a>
|
|
|
|
<p>Total number of assigned carriers.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).NcarrierDead" ><strong>OPSTRANSPORT.NcarrierDead</strong></a>
|
|
|
|
<p>Total number of dead carrier groups</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Ndelivered" ><strong>OPSTRANSPORT.Ndelivered</strong></a>
|
|
|
|
<p>Total number of cargo groups delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.Status)">#OPSTRANSPORT.Status</a>
|
|
<a id="#(OPSTRANSPORT).Status" ><strong>OPSTRANSPORT.Status</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(OPSTRANSPORT).Tover" ><strong>OPSTRANSPORT.Tover</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Time stamp.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstart" ><strong>OPSTRANSPORT.Tstart</strong></a>
|
|
|
|
<p>Start time in <em>abs.</em> seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).Tstop" ><strong>OPSTRANSPORT.Tstop</strong></a>
|
|
|
|
<p>Stop time in <em>abs.</em> seconds. Default <code>#nil</code> (never stops).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).assets" ><strong>OPSTRANSPORT.assets</strong></a>
|
|
|
|
<p>Warehouse assets assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).cargocounter" ><strong>OPSTRANSPORT.cargocounter</strong></a>
|
|
|
|
<p>Running number to generate cargo UIDs.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carrierTransportStatus" ><strong>OPSTRANSPORT.carrierTransportStatus</strong></a>
|
|
|
|
<p>Status of each carrier.
|
|
</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).carriers" ><strong>OPSTRANSPORT.carriers</strong></a>
|
|
|
|
<p>Carriers assigned for this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Chief.html##(CHIEF)">Ops.Chief#CHIEF</a>
|
|
<a id="#(OPSTRANSPORT).chief" ><strong>OPSTRANSPORT.chief</strong></a>
|
|
|
|
<p>Chief of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Commander.html##(COMMANDER)">Ops.Commander#COMMANDER</a>
|
|
<a id="#(OPSTRANSPORT).commander" ><strong>OPSTRANSPORT.commander</strong></a>
|
|
|
|
<p>Commander of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).conditionStart" ><strong>OPSTRANSPORT.conditionStart</strong></a>
|
|
|
|
<p>Start conditions.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).duration" ><strong>OPSTRANSPORT.duration</strong></a>
|
|
|
|
<p>Duration (<code>Tstop-Tstart</code>) of the transport in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationArmy" ><strong>OPSTRANSPORT.formationArmy</strong></a>
|
|
|
|
<p>Default formation for ground vehicles.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationHelo" ><strong>OPSTRANSPORT.formationHelo</strong></a>
|
|
|
|
<p>Default formation for helicopters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).formationPlane" ><strong>OPSTRANSPORT.formationPlane</strong></a>
|
|
|
|
<p>Default formation for airplanes.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).importance" ><strong>OPSTRANSPORT.importance</strong></a>
|
|
|
|
<p>Importance of this transport. Smaller=higher.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).legions" ><strong>OPSTRANSPORT.legions</strong></a>
|
|
|
|
<p>Assigned legions.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).lid" ><strong>OPSTRANSPORT.lid</strong></a>
|
|
|
|
<p>Log ID.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>
|
|
<a id="#(OPSTRANSPORT).mission" ><strong>OPSTRANSPORT.mission</strong></a>
|
|
|
|
<p>The mission attached to this transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>
|
|
<a id="#(OPSTRANSPORT).opszone" ><strong>OPSTRANSPORT.opszone</strong></a>
|
|
|
|
<p>OPS zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).prio" ><strong>OPSTRANSPORT.prio</strong></a>
|
|
|
|
<p>Priority of this transport. Should be a number between 0 (high prio) and 100 (low prio).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).requestID" ><strong>OPSTRANSPORT.requestID</strong></a>
|
|
|
|
<p>The ID of the queued warehouse request. Necessary to cancel the request if the transport was cancelled before the request is processed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).statusCommander" ><strong>OPSTRANSPORT.statusCommander</strong></a>
|
|
|
|
<p>Staus of the COMMANDER.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).statusLegion" ><strong>OPSTRANSPORT.statusLegion</strong></a>
|
|
|
|
<p>Transport status of all assigned LEGIONs.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT).tzCombos" ><strong>OPSTRANSPORT.tzCombos</strong></a>
|
|
|
|
<p>Table of transport zone combos. Each element of the table is of type <code>#OPSTRANSPORT.TransportZoneCombo</code>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).tzcCounter" ><strong>OPSTRANSPORT.tzcCounter</strong></a>
|
|
|
|
<p>Running number of added transport zone combos.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(OPSTRANSPORT.TransportZoneCombo)">#OPSTRANSPORT.TransportZoneCombo</a>
|
|
<a id="#(OPSTRANSPORT).tzcDefault" ><strong>OPSTRANSPORT.tzcDefault</strong></a>
|
|
|
|
<p>Default transport zone combo.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).uid" ><strong>OPSTRANSPORT.uid</strong></a>
|
|
|
|
<p>Unique ID of the transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT).urgent" ><strong>OPSTRANSPORT.urgent</strong></a>
|
|
|
|
<p>If true, transport is urgent.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT).verbose" ><strong>OPSTRANSPORT.verbose</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT).version" ><strong>OPSTRANSPORT.version</strong></a>
|
|
|
|
<p>Army Group 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="#(OPSTRANSPORT).ClearState" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventBirth" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventCrash" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventDead" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventDynamicCargoLoaded" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventDynamicCargoRemoved" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventDynamicCargoUnloaded" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventNewDynamicCargo" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventPlayerEnterAircraft" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventRemoveUnit" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventTakeoff" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).CreateEventUnitLost" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).E" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).EventDispatcher" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).EventRemoveAll" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).F" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).F2" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).F3" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetClassID" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetClassName" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetClassNameAndID" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetEventPriority" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetParent" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetProperties" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetProperty" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).GetState" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).HandleEvent" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).I" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).Inherit" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).IsInstanceOf" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).IsTrace" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).New" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEvent" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventBDA" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventBaseCaptured" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventBirth" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventCrash" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDead" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDetailedFailure" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDiscardChairAfterEjection" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDynamicCargoLoaded" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDynamicCargoRemoved" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventDynamicCargoUnloaded" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventEjection" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventEngineShutdown" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventEngineStartup" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventHit" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventHumanFailure" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventKill" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventLand" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventLandingAfterEjection" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventLandingQualityMark" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventMarkAdded" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventMarkChange" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventMarkRemoved" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventMissionEnd" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventMissionStart" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventNewDynamicCargo" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventParatrooperLanding" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventPilotDead" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventPlayerEnterAircraft" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventPlayerEnterUnit" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventPlayerLeaveUnit" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventRefueling" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventRefuelingStop" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventScore" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventShootingEnd" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventShootingStart" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventShot" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventTakeoff" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventTriggerZone" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).OnEventUnitLost" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).ScheduleOnce" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).ScheduleRepeat" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).ScheduleStop" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).SetEventPriority" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).SetProperty" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).SetState" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).T" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).T2" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).T3" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceAll" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceClass" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceClassMethod" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceLevel" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceOff" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceOn" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).TraceOnOff" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT).UnHandleEvent" ><strong>OPSTRANSPORT: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="#(OPSTRANSPORT)._F" ><strong>OPSTRANSPORT:_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="#(OPSTRANSPORT)._Serialize" ><strong>OPSTRANSPORT:_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="#(OPSTRANSPORT)._T" ><strong>OPSTRANSPORT:_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="#(OPSTRANSPORT).onEvent" ><strong>OPSTRANSPORT: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##OPSTRANSPORT.CargoType')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.CargoType)">Type <strong>OPSTRANSPORT.CargoType</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.CargoType" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Storage data.</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="#(OPSTRANSPORT.CargoType).OPSGROUP" ><strong>OPSTRANSPORT.CargoType.OPSGROUP</strong></a>
|
|
|
|
<p>Cargo is an OPSGROUP.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.CargoType).STORAGE" ><strong>OPSTRANSPORT.CargoType.STORAGE</strong></a>
|
|
|
|
<p>Cargo is storage of DCS warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##OPSTRANSPORT.Condition')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Condition)">Type <strong>OPSTRANSPORT.Condition</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.Condition" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Generic transport condition.</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">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.Condition).arg" ><strong>OPSTRANSPORT.Condition.arg</strong></a>
|
|
|
|
<p>Optional arguments passed to the condition callback function.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#function
|
|
<a id="#(OPSTRANSPORT.Condition).func" ><strong>OPSTRANSPORT.Condition.func</strong></a>
|
|
|
|
<p>Callback function to check for a condition. Should return a #boolean.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##OPSTRANSPORT.Path')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Path)">Type <strong>OPSTRANSPORT.Path</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.Path" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Path used for pickup or transport.</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">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Path).category" ><strong>OPSTRANSPORT.Path.category</strong></a>
|
|
|
|
<p>Category for which carriers this path is used.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Path).radius" ><strong>OPSTRANSPORT.Path.radius</strong></a>
|
|
|
|
<p>Radomization radius for waypoints in meters. Default 0 m.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT.Path).reverse" ><strong>OPSTRANSPORT.Path.reverse</strong></a>
|
|
|
|
<p>If <code>true</code>, path is used in reversed order.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.Path).waypoints" ><strong>OPSTRANSPORT.Path.waypoints</strong></a>
|
|
|
|
<p>Table of waypoints.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##OPSTRANSPORT.Status')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Status)">Type <strong>OPSTRANSPORT.Status</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.Status" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Cargo transport status.</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="#(OPSTRANSPORT.Status).CANCELLED" ><strong>OPSTRANSPORT.Status.CANCELLED</strong></a>
|
|
|
|
<p>Transport was cancelled.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).DELIVERED" ><strong>OPSTRANSPORT.Status.DELIVERED</strong></a>
|
|
|
|
<p>Transport was delivered. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).EXECUTING" ><strong>OPSTRANSPORT.Status.EXECUTING</strong></a>
|
|
|
|
<p>Transport is being executed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).FAILED" ><strong>OPSTRANSPORT.Status.FAILED</strong></a>
|
|
|
|
<p>Transport failed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).PLANNED" ><strong>OPSTRANSPORT.Status.PLANNED</strong></a>
|
|
|
|
<p>Planning state.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).QUEUED" ><strong>OPSTRANSPORT.Status.QUEUED</strong></a>
|
|
|
|
<p>Queued state.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).REQUESTED" ><strong>OPSTRANSPORT.Status.REQUESTED</strong></a>
|
|
|
|
<p>Requested state.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).SCHEDULED" ><strong>OPSTRANSPORT.Status.SCHEDULED</strong></a>
|
|
|
|
<p>Transport is scheduled in the cargo queue.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Status).SUCCESS" ><strong>OPSTRANSPORT.Status.SUCCESS</strong></a>
|
|
|
|
<p>Transport was a success.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##OPSTRANSPORT.Storage')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.Storage)">Type <strong>OPSTRANSPORT.Storage</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.Storage" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Storage data.</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">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoAmount" ><strong>OPSTRANSPORT.Storage.cargoAmount</strong></a>
|
|
|
|
<p>Amount of cargo that should be transported.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoDelivered" ><strong>OPSTRANSPORT.Storage.cargoDelivered</strong></a>
|
|
|
|
<p>Amount of cargo that has been delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoLoaded" ><strong>OPSTRANSPORT.Storage.cargoLoaded</strong></a>
|
|
|
|
<p>Amount of cargo that is loading.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoLost" ><strong>OPSTRANSPORT.Storage.cargoLost</strong></a>
|
|
|
|
<p>Amount of cargo that was lost.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoReserved" ><strong>OPSTRANSPORT.Storage.cargoReserved</strong></a>
|
|
|
|
<p>Amount of cargo that is reserved for a carrier group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(OPSTRANSPORT.Storage).cargoType" ><strong>OPSTRANSPORT.Storage.cargoType</strong></a>
|
|
|
|
<p>Type of cargo.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.Storage).cargoWeight" ><strong>OPSTRANSPORT.Storage.cargoWeight</strong></a>
|
|
|
|
<p>Weight of one single cargo item in kg. Default 1 kg.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<a id="#(OPSTRANSPORT.Storage).storageFrom" ><strong>OPSTRANSPORT.Storage.storageFrom</strong></a>
|
|
|
|
<p>Storage from.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Storage.html##(STORAGE)">Wrapper.Storage#STORAGE</a>
|
|
<a id="#(OPSTRANSPORT.Storage).storageTo" ><strong>OPSTRANSPORT.Storage.storageTo</strong></a>
|
|
|
|
<p>Storage To.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##OPSTRANSPORT.TransportZoneCombo')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(OPSTRANSPORT.TransportZoneCombo)">Type <strong>OPSTRANSPORT.TransportZoneCombo</strong></a></h2></div>
|
|
<div id= "#Types##OPSTRANSPORT.TransportZoneCombo" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Transport zone combination.</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">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).Cargos" ><strong>OPSTRANSPORT.TransportZoneCombo.Cargos</strong></a>
|
|
|
|
<p>Cargo groups of the TZ combo. Each element is of type <code>Ops.OpsGroup#OPSGROUP.CargoGroup</code>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).DeployAirbase" ><strong>OPSTRANSPORT.TransportZoneCombo.DeployAirbase</strong></a>
|
|
|
|
<p>Airbase for deploy.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).DeployZone" ><strong>OPSTRANSPORT.TransportZoneCombo.DeployZone</strong></a>
|
|
|
|
<p>Deploy zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).DisembarkCarriers" ><strong>OPSTRANSPORT.TransportZoneCombo.DisembarkCarriers</strong></a>
|
|
|
|
<p>Carriers where the cargo is directly disembarked to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).DisembarkZone" ><strong>OPSTRANSPORT.TransportZoneCombo.DisembarkZone</strong></a>
|
|
|
|
<p>Zone where the troops are disembared to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).EmbarkZone" ><strong>OPSTRANSPORT.TransportZoneCombo.EmbarkZone</strong></a>
|
|
|
|
<p>Embark zone if different from pickup zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).Ncargo" ><strong>OPSTRANSPORT.TransportZoneCombo.Ncargo</strong></a>
|
|
|
|
<p>Number of cargos assigned. This is a running number and <em>not</em> decreased if cargo is delivered or dead.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).Ncarriers" ><strong>OPSTRANSPORT.TransportZoneCombo.Ncarriers</strong></a>
|
|
|
|
<p>Number of carrier groups using this transport zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).PickupAirbase" ><strong>OPSTRANSPORT.TransportZoneCombo.PickupAirbase</strong></a>
|
|
|
|
<p>Airbase for pickup.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).PickupFormation" ><strong>OPSTRANSPORT.TransportZoneCombo.PickupFormation</strong></a>
|
|
|
|
<p>Formation used to pickup.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).PickupPaths" ><strong>OPSTRANSPORT.TransportZoneCombo.PickupPaths</strong></a>
|
|
|
|
<p>Paths for pickup. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).PickupZone" ><strong>OPSTRANSPORT.TransportZoneCombo.PickupZone</strong></a>
|
|
|
|
<p>Pickup zone.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).RequiredCargos" ><strong>OPSTRANSPORT.TransportZoneCombo.RequiredCargos</strong></a>
|
|
|
|
<p>Required cargos.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).TransportFormation" ><strong>OPSTRANSPORT.TransportZoneCombo.TransportFormation</strong></a>
|
|
|
|
<p>Formation used to transport.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).TransportPaths" ><strong>OPSTRANSPORT.TransportZoneCombo.TransportPaths</strong></a>
|
|
|
|
<p>Path for Transport. Each elment of the table is of type <code>#OPSTRANSPORT.Path</code>. </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).assets" ><strong>OPSTRANSPORT.TransportZoneCombo.assets</strong></a>
|
|
|
|
<p>Cargo assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).disembarkActivation" ><strong>OPSTRANSPORT.TransportZoneCombo.disembarkActivation</strong></a>
|
|
|
|
<p>If true, troops are spawned in late activated state when disembarked from carrier.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).disembarkInUtero" ><strong>OPSTRANSPORT.TransportZoneCombo.disembarkInUtero</strong></a>
|
|
|
|
<p>If true, troops are disembarked "in utero".</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).disembarkToCarriers" ><strong>OPSTRANSPORT.TransportZoneCombo.disembarkToCarriers</strong></a>
|
|
|
|
<p>If <code>true</code>, cargo is supposed to embark to another carrier.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(OPSTRANSPORT.TransportZoneCombo).uid" ><strong>OPSTRANSPORT.TransportZoneCombo.uid</strong></a>
|
|
|
|
<p>Unique ID of the TZ combo.</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/OPS_OpsTransport.png')";
|
|
}
|
|
</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>
|