weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
MOOSE_DOCS/Documentation/Wrapper.Client.html
Applevangelist 49e537bc56 MOOSE generated documentation [skip ci]
2022-03-16 07:53:12 +00:00

24185 lines
811 KiB
HTML
Raw Blame History

<!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 &times;</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/AI_Combat_Air_Patrol.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Cap.html">AI.AI_A2A_Cap</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.2) - Models the process of Combat Air Patrol (CAP) for airplanes.</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_Air_Dispatching.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Dispatcher.html">AI.AI_A2A_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - (R2.2) - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.</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_Ground_Control_Intercept.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_GCI.html">AI.AI_A2A_GCI</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.2) - Models the process of Ground Controlled Interception (GCI) for airplanes.</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_Patrolling.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Patrol.html">AI.AI_A2A_Patrol</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.2) - Models the process of air patrol of airplanes.</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_Engage.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_BAI.html">AI.AI_A2G_BAI</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Models the process of air to ground BAI engagement for airplanes and helicopters.</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_Engage.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_CAS.html">AI.AI_A2G_CAS</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Models the process of air to ground engagement for airplanes and helicopters.</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="AI.AI_A2G_Dispatcher.html">AI.AI_A2G_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Create an automated A2G defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAS 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/AI_Air_To_Ground_Engage.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_SEAD.html">AI.AI_A2G_SEAD</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Models the process of air to ground SEAD engagement for airplanes and helicopters.</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="AI.AI_AIR_Dispatcher.html">AI.AI_AIR_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Create an automated AIR defense system based on a detection network of reconnaissance vehicles and air units, coordinating SEAD, BAI and CAP 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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air.html">AI.AI_Air</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the process of AI air 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/AI_Air_To_Ground_Engage.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Engage.html">AI.AI_Air_Engage</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Models the process of air to ground engagement for airplanes and helicopters.</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_Patrol.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Patrol.html">AI.AI_Air_Patrol</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.</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="AI.AI_Air_Squadron.html">AI.AI_Air_Squadron</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models squadrons for airplanes and helicopters.</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_Battlefield_Air_Interdiction.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Bai.html">AI.AI_Bai</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Peform Battlefield Area Interdiction (BAI) within an engagement 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/AI_Balancing.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Balancer.html">AI.AI_Balancer</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Balance player slots with AI to create an engaging simulation environment, independent of the amount of 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/AI_Combat_Air_Patrol.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cap.html">AI.AI_Cap</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Perform Combat Air Patrolling (CAP) for airplanes.</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/Cargo.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo.html">AI.AI_Cargo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</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_Cargo_Dispatching_For_APC.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_APC.html">AI.AI_Cargo_APC</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using 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/AI_Cargo_Dispatching_For_Airplanes.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Airplane.html">AI.AI_Cargo_Airplane</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using airplanes.</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_Cargo_Dispatcher.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher.html">AI.AI_Cargo_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</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_Cargo_Dispatching_For_APC.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_APC.html">AI.AI_Cargo_Dispatcher_APC</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using APCs.</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_Cargo_Dispatching_For_Airplanes.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Airplane.html">AI.AI_Cargo_Dispatcher_Airplane</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.4) - Models the intelligent transportation of infantry and other cargo using Planes.</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_Cargo_Dispatching_For_Helicopters.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Helicopter.html">AI.AI_Cargo_Dispatcher_Helicopter</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (2.4) - Models the intelligent transportation of infantry and other cargo using Helicopters.</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_Cargo_Dispatching_For_Ship.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Ship.html">AI.AI_Cargo_Dispatcher_Ship</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (2.5.1) - Models the intelligent transportation of infantry and other cargo using Ships</p>
<h2>Features:</h2>
<ul>
<li>Transport cargo to various deploy zones using naval vehicles.</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/AI_Cargo_Dispatching_For_Helicopters.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Helicopter.html">AI.AI_Cargo_Helicopter</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the intelligent transportation of cargo using helicopters.</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_Cargo_Dispatching_For_Ship.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Ship.html">AI.AI_Cargo_Ship</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- (R2.5.1) - Models the intelligent transportation of infantry and other cargo.</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_Close_Air_Support.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cas.html">AI.AI_Cas</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Perform Close Air Support (CAS) near friendlies.</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="AI.AI_ESCORT_DISPATCHER_REQUEST.html">AI.AI_ESCORT_DISPATCHER_REQUEST</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the assignment of AI escorts to player flights upon request using the radio 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/Escorting.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort.html">AI.AI_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 or of other AI, upon request using the 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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Dispatcher.html">AI.AI_Escort_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> - Models the automatic assignment of AI escorts to player flights.</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="AI.AI_Formation.html">AI.AI_Formation</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</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/AI_Air_Patrolling.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Patrol.html">AI.AI_Patrol</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>AI</strong> -- Perform Air Patrolling for airplanes.</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="Actions.Account.html">Actions.Account</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count &amp; report) various DCS events occuring on <a href="Wrapper.Unit.html">Wrapper.Unit</a>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.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Assign.html">Actions.Assign</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Accept or reject process for player (task) assignments.</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="Actions.Assist.html">Actions.Assist</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to 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="Actions.Route.html">Actions.Route</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to 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/Cargo.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.Cargo.html">Cargo.Cargo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of CARGO logistics, that can be transported from and to transportation carriers.</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/Cargo_Crates.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoCrate.html">Cargo.CargoCrate</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> -- Management of single cargo crates, which are based on a <a href="Static.html">Static</a> object.</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/Cargo_Groups.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoGroup.html">Cargo.CargoGroup</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of grouped cargo logistics, which are based on a <a href="Wrapper.Group.html">Wrapper.Group</a> object.</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/Cargo_Slingload.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoSlingload.html">Cargo.CargoSlingload</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> -- Management of single cargo crates, which are based on a <a href="Static.html">Static</a> object.</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/Cargo_Units.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoUnit.html">Cargo.CargoUnit</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Cargo</strong> - Management of single cargo logistics, which are based on a <a href="Wrapper.Unit.html">Wrapper.Unit</a> object.</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_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/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_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>
<p><strong>Core</strong> -- SCHEDULEDISPATCHER dispatches the different schedules.</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.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 running missions, consumed by moose classes and provides a menu system 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/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/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="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>See the <a href="https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation">Simulator Scripting Engine Documentation</a> on Hoggit for further explanation and examples.</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="ENUMS.html">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/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.Arty.html">Functional.Arty</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/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/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/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/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> - (R2.5) - 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>
<hr/>
<p><strong>MANTIS</strong> - Moose derived Modular, Automatic and Network capable Targeting and Interception System
Controls a network of SAM sites.</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/Missile_Trainer.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.MissileTrainer.html">Functional.MissileTrainer</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Functional</strong> -- Train missile defence and deflection.</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> - Rudimentary 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/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/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 airtraffic 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/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, and create a CSV file logging the scoring events for use at team or squadron 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 execute evasive and 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>
<hr/>
<p><strong>SHORAD</strong> - Short Range Air Defense System
Controls a network of short range air/missile defense 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/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/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 (WIP)</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.ZoneGoalCargo.html">Functional.ZoneGoalCargo</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 that models processes to achieve goals involving a Zone and Cargo.</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 that models processes to achieve goals involving a Zone for a Coalition.</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_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><strong>Ops</strong> - Automatic Terminal Information Service (ATIS).</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 &amp; 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_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/Sound_MSRS.png" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.MSRS.html">Sound.MSRS</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.</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_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/Task_Command_Center.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.CommandCenter.html">Tasking.CommandCenter</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- A command center governs multiple missions, and takes care of the reporting and communications.</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/Task_Detection_Manager.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.DetectionManager.html">Tasking.DetectionManager</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - This module contains the DETECTION_MANAGER class and derived 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/Task_Mission.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Mission.html">Tasking.Mission</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- A mission models a goal to be achieved through the execution and completion of tasks by 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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task.html">Tasking.Task</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- A task object governs the main engine to administer human taskings.</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="Tasking.TaskInfo.html">Tasking.TaskInfo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- Controls the information of a Task.</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="Tasking.TaskZoneCapture.html">Tasking.TaskZoneCapture</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - The TASK_Protect models tasks for players to protect or capture specific 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="Tasking.Task_A2A.html">Tasking.Task_A2A</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - The TASK_A2A models tasks for players in Air to Air engagements.</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/Task_A2A_Dispatcher.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2A_Dispatcher.html">Tasking.Task_A2A_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.</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="Tasking.Task_A2G.html">Tasking.Task_A2G</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - The TASK_A2G models tasks for players in Air to Ground engagements.</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/Task_A2G_Dispatcher.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2G_Dispatcher.html">Tasking.Task_A2G_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.</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="Tasking.Task_Cargo.html">Tasking.Task_Cargo</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- Base class to model tasks for players to transport cargo.</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/Task_Cargo_CSAR.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_CSAR.html">Tasking.Task_Cargo_CSAR</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- Orchestrates the task for players to execute CSAR for downed pilots.</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/Task_Cargo_Dispatcher.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_Dispatcher.html">Tasking.Task_Cargo_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - Creates and manages player TASK_CARGO tasks.</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/Task_Cargo_Transport.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_Transport.html">Tasking.Task_Cargo_Transport</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> -- Models tasks for players to transport cargo.</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="Tasking.Task_Manager.html">Tasking.Task_Manager</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>This module contains the TASK_MANAGER class and derived 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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Zone_Capture_Dispatcher.html">Tasking.Task_Zone_Capture_Dispatcher</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Tasking</strong> - Creates and manages player TASK_ZONE_CAPTURE tasks.</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.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.Templates.html">Utilities.Templates</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utils</strong> Templates</p>
<p>DCS unit templates</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="Utils.html">Utils</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>This module contains derived utilities taken from the MIST framework, as well as a lot of 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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utils.STTS.html">Utils.STTS</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Utilities</strong> DCS Simple Text-To-Speech (STTS).</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_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/Wrapper_Marker.png" 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/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_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/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="routines.html">routines</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p>Various routines</p>
</p></div>
</div>
</div>
</div>
</nav>
<img src="..\Images\Wrapper_Client.JPG" alt="Banner Image"/>
<div id="content">
<div class="w3-container w3-theme-d5" id="module_title">
<h1>Module <strong>Wrapper.Client</strong></h1>
</div>
<div class="w3-container w3-white" id="module_description">
<p><strong>Wrapper</strong> -- CLIENT wraps DCS Unit objects acting as a <strong>Client</strong> or <strong>Player</strong> within a mission.</p>
<hr/>
<h3>Author: <strong>FlightControl</strong></h3>
<h3>Contributions: <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##CLIENT')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>CLIENT</strong></h2></p></td>
<td class="style="width:60%;">
<p>Wrapper class of those <strong>Units</strong> defined within the Mission Editor that have the skillset defined as <strong>Client</strong> or <strong>Player</strong>.</p>
</td>
</tr>
</table>
</div>
<div id= "#Globals##CLIENT" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(CLIENT)">#CLIENT</a>
<a id="CLIENT" ><strong>CLIENT</strong></a>
<p>Wrapper class of those <strong>Units</strong> defined within the Mission Editor that have the skillset defined as <strong>Client</strong> or <strong>Player</strong>.</p>
<p>Note that clients are NOT the same as Units, they are NOT necessarily alive.
The CLIENT class is a wrapper class to handle the DCS Unit objects that have the skillset defined as <strong>Client</strong> or <strong>Player</strong>:</p>
<ul>
<li>Wraps the DCS Unit objects with skill level set to Player or Client.</li>
<li>Support all DCS Unit APIs.</li>
<li>Enhance with Unit specific APIs not in the DCS Group API set.</li>
<li>When player joins Unit, execute alive init logic.</li>
<li>Handles messages to players.</li>
<li>Manage the "state" of the DCS Unit.</li>
</ul>
<p>Clients are being used by the <a href="MISSION.html">MISSION</a> class to follow players and register their successes.</p>
<h2>CLIENT reference methods</h2>
<p>For each DCS Unit having skill level Player or Client, a CLIENT wrapper object (instance) will be created within the _<a href="DATABASE.html">DATABASE</a> object.
This is done at the beginning of the mission (when the mission starts).</p>
<p>The CLIENT class does not contain a :New() method, rather it provides :Find() methods to retrieve the object reference
using the DCS Unit or the DCS UnitName.</p>
<p>Another thing to know is that CLIENT objects do not "contain" the DCS Unit object.
The CLIENT methods will reference the DCS Unit object by name when it is needed during API execution.
If the DCS Unit object does not exist or is nil, the CLIENT methods will return nil and log an exception in the DCS.log file.</p>
<p>The CLIENT class provides the following functions to retrieve quickly the relevant CLIENT instance:</p>
<ul>
<li><a href="##(CLIENT).Find">CLIENT.Find</a>(): Find a CLIENT instance from the _DATABASE object using a DCS Unit object.</li>
<li><a href="##(CLIENT).FindByName">CLIENT.FindByName</a>(): Find a CLIENT instance from the _DATABASE object using a DCS Unit name.</li>
</ul>
<p><strong>IMPORTANT: ONE SHOULD NEVER SANATIZE these CLIENT OBJECT REFERENCES! (make the CLIENT object references nil).</strong></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="#(CLIENT)">Type <strong>CLIENT</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(CLIENT)">CLIENT</a></strong>
, extends <strong><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></strong>
, extends <strong><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></strong>
, extends <strong><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></strong>
, extends <strong><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></strong>
, extends <strong><a href="Wrapper.Object.html##(OBJECT)">Wrapper.Object#OBJECT</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 CLIENT</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="##(CLIENT).AddBriefing">CLIENT:AddBriefing(ClientBriefing)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a briefing to a CLIENT when a player joins a mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).AddPlayer">CLIENT:AddPlayer(PlayerName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add player name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Alive">CLIENT:Alive(CallBackFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checks for a client alive event and calls a function on a continuous basis.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).AliveCheckScheduler">CLIENT.AliveCheckScheduler</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="##(CLIENT).ClientAlive2">CLIENT.ClientAlive2</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="##(CLIENT).ClientBriefing">CLIENT.ClientBriefing</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="##(CLIENT).ClientBriefingShown">CLIENT.ClientBriefingShown</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="##(CLIENT).ClientCallBack">CLIENT.ClientCallBack</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="##(CLIENT).ClientGroupID">CLIENT.ClientGroupID</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="##(CLIENT).ClientGroupName">CLIENT.ClientGroupName</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="##(CLIENT).ClientName">CLIENT.ClientName</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="##(CLIENT).ClientParameters">CLIENT.ClientParameters</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="##(CLIENT).ClientTransport">CLIENT.ClientTransport</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="##(CLIENT).Find">CLIENT:Find(DCSUnit, Error)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a CLIENT from the _DATABASE using the relevant DCS Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FindByName">CLIENT:FindByName(ClientName, ClientBriefing, Error)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a CLIENT from the _DATABASE using the relevant Client Unit Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClientGroupDCSUnit">CLIENT:GetClientGroupDCSUnit()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the DCSUnit of the CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClientGroupID">CLIENT:GetClientGroupID()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the group ID of the client.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClientGroupName">CLIENT:GetClientGroupName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the name of the group of the client.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClientGroupUnit">CLIENT:GetClientGroupUnit()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the UNIT of the CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDCSGroup">CLIENT:GetDCSGroup()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the DCSGroup of a Client.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPlayer">CLIENT:GetPlayer()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get name of player.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPlayers">CLIENT:GetPlayers()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get player name(s).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsMultiSeated">CLIENT:IsMultiSeated()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checks if the CLIENT is a multi-seated UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsTransport">CLIENT:IsTransport()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Evaluates if the CLIENT is a transport.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Message">CLIENT:Message(Message, MessageDuration, MessageCategory, MessageInterval, MessageID)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The main message driver for the CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageSwitch">CLIENT.MessageSwitch</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="##(CLIENT).Players">CLIENT.Players</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="##(CLIENT).Register">CLIENT:Register(ClientName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Transport defines that the Client is a Transport.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RemovePlayer">CLIENT:RemovePlayer(PlayerName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove player.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RemovePlayers">CLIENT:RemovePlayers()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove all players.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Reset">CLIENT:Reset(ClientName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Resets a CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ShowBriefing">CLIENT:ShowBriefing()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Show the briefing of a CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ShowCargo">CLIENT:ShowCargo()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Shows the <a href="AI.AI_Cargo.html##(CARGO)">AI.AI_Cargo#CARGO</a> contained within the CLIENT to the player as a message.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ShowMissionBriefing">CLIENT:ShowMissionBriefing(MissionBriefing)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Show the mission briefing of a MISSION to the CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Transport">CLIENT:Transport()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Transport defines that the Client is a Transport.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT)._AliveCheckScheduler">CLIENT:_AliveCheckScheduler(SchedulerName)</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="##(CLIENT)._Menus">CLIENT._Menus</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
</div>
<div class="w3-card w3-margin">
<table class="w3-table w3-border-bottom w3-border-theme-l2">
<tr class="w3-theme-l1">
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from UNIT</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="##(CLIENT).ClassName">CLIENT.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="##(CLIENT).EnableEmission">CLIENT:EnableEmission(switch)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>GROUND - Switch on/off radar emissions 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="##(CLIENT).Explode">CLIENT:Explode(power, delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Triggers an explosion at the coordinates of the unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Find">CLIENT:Find(DCSUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a UNIT from the _DATABASE using a DCSUnit object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FindByName">CLIENT:FindByName(UnitName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find a UNIT in the _DATABASE using the name of an existing DCS Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetAmmo">CLIENT:GetAmmo()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Unit's ammunition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetAmmunition">CLIENT:GetAmmunition()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the number of ammunition and in particular the number of shells, rockets, bombs and missiles a unit currently has.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCallsign">CLIENT:GetCallsign()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Unit's callsign - the localized string.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCategoryName">CLIENT:GetCategoryName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the category name of the #UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClient">CLIENT:GetClient()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the CLIENT of the unit </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDCSObject">CLIENT:GetDCSObject()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the DCS unit object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDamageRelative">CLIENT:GetDamageRelative()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's relative damage, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetFuel">CLIENT:GetFuel()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns relative amount of fuel (from 0.0 to 1.0) the UNIT has in its internal tanks.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetGroup">CLIENT:GetGroup()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's group if it exist and nil otherwise.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLife">CLIENT:GetLife()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLife0">CLIENT:GetLife0()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Unit's initial health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLifeRelative">CLIENT:GetLifeRelative()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's relative health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetNumber">CLIENT:GetNumber()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's number in the group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPlayerName">CLIENT:GetPlayerName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns name of the player that control the unit or nil if the unit is controlled by A.I.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPrefix">CLIENT:GetPrefix()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the prefix name of the DCS Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRadar">CLIENT:GetRadar()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns two values:</p>
<ul>
<li>First value indicates if at least one of the unit's radar(s) is on.</li>
</ul>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRange">CLIENT:GetRange()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's max range in meters derived from the DCS descriptors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetSensors">CLIENT:GetSensors()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit sensors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetSkill">CLIENT:GetSkill()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get skill from Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetSpeedMax">CLIENT:GetSpeedMax()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's max speed in km/h derived from the DCS descriptors.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTemplate">CLIENT:GetTemplate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the unit table from a unit's template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTemplateFuel">CLIENT:GetTemplateFuel()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the fuel of the unit from its template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTemplatePayload">CLIENT:GetTemplatePayload()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the payload table from a unit's template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTemplatePylons">CLIENT:GetTemplatePylons()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the pylons table from a unit's template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetThreatLevel">CLIENT:GetThreatLevel()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Unit's A2G threat level on a scale from 1 to 10 ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetUnitCategory">CLIENT:GetUnitCategory()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the category of the #UNIT from descriptor.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetUnits">CLIENT:GetUnits()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a list of one <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).HandleEvent">CLIENT: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="##(CLIENT).HasSEAD">CLIENT:HasSEAD()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is SEADable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).HasSensors">CLIENT:HasSensors(...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit has sensors of a certain type.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).InAir">CLIENT:InAir(NoHeloCheck)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the UNIT is in the air.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsActive">CLIENT:IsActive()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is activated.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAlive">CLIENT:IsAlive()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Unit is alive.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsClient">CLIENT:IsClient()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checks is the unit is a <em>Player</em> or <em>Client</em> slot.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsDetected">CLIENT:IsDetected(TargetUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if a unit is detecting the TargetUnit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsFriendly">CLIENT:IsFriendly(FriendlyCoalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is a friendly unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsLOS">CLIENT:IsLOS(TargetUnit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if a unit has Line of Sight (LOS) with the TargetUnit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsPlayer">CLIENT:IsPlayer()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if an (air) unit is a client or player slot.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsRefuelable">CLIENT:IsRefuelable()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the unit is refuelable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsShip">CLIENT:IsShip()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is of a ship category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsTanker">CLIENT:IsTanker()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the unit is a tanker.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).KnowUnit">CLIENT:KnowUnit(TargetUnit, TypeKnown, DistanceKnown)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Forces the unit to become aware of the specified target, without the unit manually detecting the other unit itself.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Name">CLIENT:Name()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the name of the UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OtherUnitInRadius">CLIENT:OtherUnitInRadius(AwaitUnit, Radius)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if there is an <strong>other</strong> DCS Unit within a radius of the current 2D point of the DCS Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ReSpawnAt">CLIENT:ReSpawnAt(Coordinate, Heading)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Respawn the <a href="Wrapper.Unit.html">Wrapper.Unit</a> using a (tweaked) template of the parent Group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Register">CLIENT:Register(UnitName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new UNIT from DCSUnit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ResetEvents">CLIENT:ResetEvents()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Reset the subscriptions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetUnitInternalCargo">CLIENT:SetUnitInternalCargo(mass)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets the Unit's Internal Cargo Mass, in kg</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).UnHandleEvent">CLIENT: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="##(CLIENT).UnitName">CLIENT.UnitName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Name of the unit.</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 CONTROLLABLE</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="##(CLIENT).ClearTasks">CLIENT:ClearTasks()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Clear all tasks from the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandActivateBeacon">CLIENT:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, ModeChannel, AA, Callsign, Bearing, Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Give the CONTROLLABLE the command to activate a beacon.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandActivateICLS">CLIENT:CommandActivateICLS(Channel, UnitID, Callsign, Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Activate ICLS system of the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandDeactivateBeacon">CLIENT:CommandDeactivateBeacon(Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deactivate the active beacon of the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandDeactivateICLS">CLIENT:CommandDeactivateICLS(Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deactivate the ICLS of the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandDoScript">CLIENT:CommandDoScript(DoScript)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Do Script command</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandEPLRS">CLIENT:CommandEPLRS(SwitchOnOff, Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set EPLRS of the CONTROLLABLE on/off.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandSetCallsign">CLIENT:CommandSetCallsign(CallName, CallNumber, Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set callsign of the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandSetFrequency">CLIENT:CommandSetFrequency(Frequency, Modulation, Delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set radio frequency.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandStopRoute">CLIENT:CommandStopRoute(StopRoute)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a stop route command, which returns a string containing the command.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CommandSwitchWayPoint">CLIENT:CommandSwitchWayPoint(FromWayPoint, ToWayPoint)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Perform a switch waypoint command</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ControllableName">CLIENT.ControllableName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The name of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CopyRoute">CLIENT:CopyRoute(Begin, End, Randomize, Radius)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the route of a controllable by using the <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a> class.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).DCSControllable">CLIENT.DCSControllable</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The DCS controllable class.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskAWACS">CLIENT:EnRouteTaskAWACS()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Aircraft will act as an AWACS for friendly units (will provide them with information about contacts).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskEWR">CLIENT:EnRouteTaskEWR()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Ground unit (EW-radar) will act as an EWR for friendly units (will provide them with information about contacts).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskEngageGroup">CLIENT:EnRouteTaskEngageGroup(AttackGroup, Priority, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Engaging a controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskEngageTargets">CLIENT:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Engaging targets of defined types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskEngageTargetsInZone">CLIENT:EnRouteTaskEngageTargetsInZone(Vec2, Radius, TargetTypes, Priority)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Engaging a targets of defined types at circle-shaped zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskEngageUnit">CLIENT:EnRouteTaskEngageUnit(EngageUnit, Priority, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, ControllableAttack)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Search and attack the Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskFAC">CLIENT:EnRouteTaskFAC(Radius, Priority)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose a targets (enemy ground controllable) around as well as other assigned targets.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskFAC_EngageGroup">CLIENT:EnRouteTaskFAC_EngageGroup(AttackGroup, Priority, WeaponType, Designation, Datalink)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose the target (enemy ground controllable) as well as other assigned targets.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).EnRouteTaskTanker">CLIENT:EnRouteTaskTanker()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Aircraft will act as a tanker for friendly units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDetectedGroupSet">CLIENT:GetDetectedGroupSet(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the detected target groups of the controllable as a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDetectedTargets">CLIENT:GetDetectedTargets(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the detected targets of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDetectedUnitSet">CLIENT:GetDetectedUnitSet(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the detected targets of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetFuel">CLIENT:GetFuel()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetFuelAve">CLIENT:GetFuelAve()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns relative average amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetFuelMin">CLIENT:GetFuelMin()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns relative minimum amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLife">CLIENT:GetLife()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLife0">CLIENT:GetLife0()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the initial health.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTaskMission">CLIENT:GetTaskMission()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the mission template of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetTaskRoute">CLIENT:GetTaskRoute()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return the mission route of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetWayPoints">CLIENT:GetWayPoints()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the current WayPoints set with the WayPoint functions( Note that the WayPoints can be nil, although there ARE waypoints).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).HasTask">CLIENT:HasTask()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Checking the Task Queue of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAirPlane">CLIENT:IsAirPlane()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Controllable contains AirPlanes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsGroupDetected">CLIENT:IsGroupDetected(Group, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if a certain GROUP is detected by the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsHelicopter">CLIENT:IsHelicopter()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Controllable contains Helicopters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsTargetDetected">CLIENT:IsTargetDetected(DCSObject, self, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if a target is detected.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsUnitDetected">CLIENT:IsUnitDetected(Unit, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if a certain UNIT is detected by the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).New">CLIENT:New(ControllableName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new CONTROLLABLE from a DCSControllable</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionAAAttackRange">CLIENT:OptionAAAttackRange(range)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets Controllable Option for A2A attack range for AIR FIGHTER units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionAlarmStateAuto">CLIENT:OptionAlarmStateAuto()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Alarm state to Auto: AI will automatically switch alarm states based on the presence of threats.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionAlarmStateGreen">CLIENT:OptionAlarmStateGreen()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Alarm state to Green: Group is not combat ready.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionAlarmStateRed">CLIENT:OptionAlarmStateRed()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Alarm state to Red: Group is combat ready and actively searching for targets.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionAllowJettisonWeaponsOnThreat">CLIENT:OptionAllowJettisonWeaponsOnThreat()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Allow to Jettison of weapons upon threat.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionDisperseOnAttack">CLIENT:OptionDisperseOnAttack(Seconds)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines how long a GROUND unit/group will move to avoid an ongoing attack.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionECM_AlwaysOn">CLIENT:OptionECM_AlwaysOn()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionECM_DetectedLockByRadar">CLIENT:OptionECM_DetectedLockByRadar()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionECM_Never">CLIENT:OptionECM_Never()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionECM_OnlyLockByRadar">CLIENT:OptionECM_OnlyLockByRadar()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionEngageRange">CLIENT:OptionEngageRange(EngageRange)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Defines the range at which a GROUND unit/group is allowed to use its weapons automatically.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionKeepWeaponsOnThreat">CLIENT:OptionKeepWeaponsOnThreat()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Keep weapons upon threat.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionProhibitAfterburner">CLIENT:OptionProhibitAfterburner(Prohibit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Prohibit Afterburner.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROE">CLIENT:OptionROE(ROEvalue)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set option for Rules of Engagement (ROE).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEHoldFire">CLIENT:OptionROEHoldFire()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Weapons Hold: AI will hold fire under all circumstances.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEHoldFirePossible">CLIENT:OptionROEHoldFirePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE hold their weapons?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEOpenFire">CLIENT:OptionROEOpenFire()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Open Fire (Only Designated): AI will engage only targets specified in its taskings.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEOpenFirePossible">CLIENT:OptionROEOpenFirePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE attack designated targets?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEOpenFireWeaponFree">CLIENT:OptionROEOpenFireWeaponFree()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Open Fire, Weapons Free (Priority Designated): AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEOpenFireWeaponFreePossible">CLIENT:OptionROEOpenFireWeaponFreePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE attack priority designated targets?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEReturnFire">CLIENT:OptionROEReturnFire()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return Fire: AI will only engage threats that shoot first.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEReturnFirePossible">CLIENT:OptionROEReturnFirePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE attack returning on enemy fire?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEWeaponFree">CLIENT:OptionROEWeaponFree()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Weapon free.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROEWeaponFreePossible">CLIENT:OptionROEWeaponFreePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE attack targets of opportunity?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROT">CLIENT:OptionROT(ROTvalue)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set Reation On Threat behaviour.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTEvadeFire">CLIENT:OptionROTEvadeFire()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Evade on fire.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTEvadeFirePossible">CLIENT:OptionROTEvadeFirePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE evade on enemy fire?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTNoReaction">CLIENT:OptionROTNoReaction()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>No evasion on enemy threats.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTNoReactionPossible">CLIENT:OptionROTNoReactionPossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE ignore enemy fire?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTPassiveDefense">CLIENT:OptionROTPassiveDefense()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Evasion passive defense.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTPassiveDefensePossible">CLIENT:OptionROTPassiveDefensePossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE evade using passive defenses?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTVertical">CLIENT:OptionROTVertical()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Evade on fire using vertical manoeuvres.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionROTVerticalPossible">CLIENT:OptionROTVerticalPossible()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can the CONTROLLABLE evade on fire using vertical manoeuvres?</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionRTBAmmo">CLIENT:OptionRTBAmmo(WeaponsFlag)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set RTB on ammo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionRTBBingoFuel">CLIENT:OptionRTBBingoFuel(RTB)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set RTB on bingo fuel.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OptionRestrictBurner">CLIENT:OptionRestrictBurner(RestrictBurner)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Sets Controllable Option for Restriction of Afterburner.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PatrolRoute">CLIENT:PatrolRoute()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Patrol iteratively using the waypoints the for the (parent) group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PatrolRouteRandom">CLIENT:PatrolRouteRandom(Speed, Formation, ToWaypoint)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PatrolZones">CLIENT:PatrolZones(ZoneList, Speed, Formation, DelayMin, DelayMax)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PopCurrentTask">CLIENT:PopCurrentTask()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Popping current Task from the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PushTask">CLIENT:PushTask(DCSTask, WaitTime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Pushing Task on the queue from the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RelocateGroundRandomInRadius">CLIENT:RelocateGroundRandomInRadius(speed, radius, onroad, shortcut, formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Relocate controllable to a random point within a given radius; use e.g.for evasive actions; Note that not all ground controllables can actually drive, also the alarm state of the controllable might stop it from moving.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Route">CLIENT:Route(Route, DelaySeconds)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the controllable to follow a given route.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteAirTo">CLIENT:RouteAirTo(ToCoordinate, AltType, Type, Action, Speed, DelaySeconds)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the AIR Controllable fly towards a specific point.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteGroundOnRailRoads">CLIENT:RouteGroundOnRailRoads(ToCoordinate, Speed, DelaySeconds, WaypointFunction, WaypointFunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the TRAIN Controllable to drive towards a specific point using railroads.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteGroundOnRoad">CLIENT:RouteGroundOnRoad(ToCoordinate, Speed, DelaySeconds, OffRoadFormation, WaypointFunction, WaypointFunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the GROUND Controllable to drive towards a specific point using (mostly) roads.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteGroundTo">CLIENT:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds, WaypointFunction, WaypointFunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the GROUND Controllable to drive towards a specific point.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RoutePush">CLIENT:RoutePush(Route, DelaySeconds)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make the controllable to push follow a given route.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteResume">CLIENT:RouteResume()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Resumes the movement of the vehicle on the route.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteStop">CLIENT:RouteStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the movement of the vehicle on the route.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteToVec2">CLIENT:RouteToVec2(Point, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) Make the Controllable move to fly to a given point.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).RouteToVec3">CLIENT:RouteToVec3(Point, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) Make the Controllable move to a given point.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetCommand">CLIENT:SetCommand(DCSCommand)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Executes a command action for the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetOption">CLIENT:SetOption(OptionID, OptionValue)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set option.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetTask">CLIENT:SetTask(DCSTask, WaitTime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Clearing the Task Queue and Setting the Task on the queue from the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetTaskWaypoint">CLIENT:SetTaskWaypoint(Waypoint, Task)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set a Task at a Waypoint using a Route list.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).StartUncontrolled">CLIENT:StartUncontrolled(delay)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Give an uncontrolled air controllable the start command.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskAttackGroup">CLIENT:TaskAttackGroup(AttackGroup, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit, GroupAttack)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Attack a Controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskAttackMapObject">CLIENT:TaskAttackMapObject(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Attacking the map object (building, structure, etc).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskAttackUnit">CLIENT:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Attack the Unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskBombing">CLIENT:TaskBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, Divebomb)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Delivering weapon at the point on the ground.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskBombingRunway">CLIENT:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Delivering weapon on the runway.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskCarpetBombing">CLIENT:TaskCarpetBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, CarpetLength)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Delivering weapon via CarpetBombing (all bombers in formation release at same time) at the point on the ground.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskCombo">CLIENT:TaskCombo(DCSTasks)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a Combo Task taking an array of Tasks.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskCondition">CLIENT:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a condition section for a controlled task.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskControlled">CLIENT:TaskControlled(DCSTask, DCSStopCondition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a Controlled Task taking a Task and a TaskCondition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskDisembarking">CLIENT:TaskDisembarking(Coordinate, GroupSetToDisembark)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Specifies the location infantry groups that is being transported by helicopters will be unloaded at.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskEPLRS">CLIENT:TaskEPLRS(SwitchOnOff, idx)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set EPLRS data link on/off.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskEmbarkToTransport">CLIENT:TaskEmbarkToTransport(Coordinate, Radius, UnitType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Used in conjunction with the embarking task for a transport helicopter group.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskEmbarking">CLIENT:TaskEmbarking(Coordinate, GroupSetForEmbarking, Duration, Distribution)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR HELICOPTER) Move the controllable to a Vec2 Point, wait for a defined duration and embark infantry groups.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskEscort">CLIENT:TaskEscort(FollowControllable, Vec3, LastWaypointIndex, EngagementDistance, TargetTypes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Escort another airborne controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFAC_AttackGroup">CLIENT:TaskFAC_AttackGroup(AttackGroup, WeaponType, Designation, Datalink, Frequency, Modulation, CallsignName, CallsignNumber)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and orders the FAC to control the target (enemy ground controllable) destruction.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFireAtPoint">CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFollow">CLIENT:TaskFollow(FollowControllable, Vec3, LastWaypointIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Following another airborne controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFollowBigFormation">CLIENT:TaskFollowBigFormation(FollowControllable, Vec3, LastWaypointIndex)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Following another airborne controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskFunction">CLIENT:TaskFunction(FunctionString, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>This creates a Task element, with an action to call a function as part of a Wrapped Task.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskGroundOnRailRoads">CLIENT:TaskGroundOnRailRoads(ToCoordinate, Speed, WaypointFunction, WaypointFunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make a task for a TRAIN Controllable to drive towards a specific point using railroad.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskGroundOnRoad">CLIENT:TaskGroundOnRoad(ToCoordinate, Speed, OffRoadFormation, Shortcut, FromCoordinate, WaypointFunction, WaypointFunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Make a task for a GROUND Controllable to drive towards a specific point using (mostly) roads.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskHold">CLIENT:TaskHold()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Hold ground controllable from moving.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskHoldPosition">CLIENT:TaskHoldPosition(Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Hold position at the current position of the first unit of the controllable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskLandAtVec2">CLIENT:TaskLandAtVec2(Vec2, Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR HELICOPTER) Landing at the ground.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskLandAtZone">CLIENT:TaskLandAtZone(Zone, Duration, RandomPoint)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Land the controllable at a @{Core.Zone#ZONE_RADIUS).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskMission">CLIENT:TaskMission(TaskMission)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) Return a mission task from a mission template.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskOrbit">CLIENT:TaskOrbit(Coord, Altitude, Speed, CoordRaceTrack)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at a position with at a given altitude and speed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskOrbitCircle">CLIENT:TaskOrbitCircle(Altitude, Speed, Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified altitude.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskOrbitCircleAtVec2">CLIENT:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Orbit at a specified position at a specified altitude during a specified duration with a specified speed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskRefueling">CLIENT:TaskRefueling()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR) Refueling from the nearest tanker.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskRoute">CLIENT:TaskRoute(Points)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a Mission task to follow a given route defined by Points.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskRouteToVec2">CLIENT:TaskRouteToVec2(Vec2, Speed, Formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(GROUND) Route the controllable to a given Vec2.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskRouteToZone">CLIENT:TaskRouteToZone(Zone, Randomize, Speed, Formation)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(AIR + GROUND) Route the controllable to a given zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).TaskScheduler">CLIENT.TaskScheduler</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="##(CLIENT).TaskWrappedAction">CLIENT:TaskWrappedAction(DCSCommand, Index)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Return a WrappedAction Task taking a Command.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).WayPointExecute">CLIENT:WayPointExecute(WayPoint, WaitTime)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Executes the WayPoint plan.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).WayPointFunction">CLIENT:WayPointFunction(WayPoint, WayPointIndex, WayPointFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Registers a waypoint function that will be executed when the controllable moves over the WayPoint.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).WayPointInitialize">CLIENT:WayPointInitialize(WayPoints)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).WayPoints">CLIENT.WayPoints</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="##(CLIENT)._GetController">CLIENT:_GetController()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the controller for the CONTROLLABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).___PassingWaypoint">CLIENT.___PassingWaypoint(controllable, n, N, waypointfunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Task function when controllable passes a waypoint.</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 POSITIONABLE</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="##(CLIENT).AddCargo">CLIENT:AddCargo(Cargo)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).CargoItemCount">CLIENT:CargoItemCount()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get cargo item count.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ClearCargo">CLIENT:ClearCargo()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Clear all cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Destroy">CLIENT:Destroy(GenerateEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Destroys the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Flare">CLIENT:Flare(FlareColor)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Signal a flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FlareGreen">CLIENT:FlareGreen()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Signal a green flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FlareRed">CLIENT:FlareRed()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Signal a red flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FlareWhite">CLIENT:FlareWhite()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Signal a white flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).FlareYellow">CLIENT:FlareYellow()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Signal a yellow flare at the position of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetAltitude">CLIENT:GetAltitude()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the altitude of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetAoA">CLIENT:GetAoA()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the Angle of Attack of a POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetBeacon">CLIENT:GetBeacon()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a <a href="Core.Radio.html##(BEACON)">Core.Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetBoundingBox">CLIENT:GetBoundingBox()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetBoundingRadius">CLIENT:GetBoundingRadius(MinDist)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the bounding radius of the underlying POSITIONABLE DCS Object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCargo">CLIENT:GetCargo()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get all contained cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCargoBayFreeWeight">CLIENT:GetCargoBayFreeWeight()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get Cargo Bay Free Weight in kg.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetClimbAngle">CLIENT:GetClimbAngle()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the climb or descent angle of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCoord">CLIENT:GetCoord()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCoordinate">CLIENT:GetCoordinate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDCSObject">CLIENT:GetDCSObject()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the DCS object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetHeading">CLIENT:GetHeading()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE heading in degrees.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetHeight">CLIENT:GetHeight()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE height in meters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetLaserCode">CLIENT:GetLaserCode()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the last assigned laser code</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetMessage">CLIENT:GetMessage(Message, Duration, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a message with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetMessageText">CLIENT:GetMessageText(Message, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the message text with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetMessageType">CLIENT:GetMessageType(Message, MessageType, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetObjectSize">CLIENT:GetObjectSize()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the object size.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetOffsetCoordinate">CLIENT:GetOffsetCoordinate(x, y, z)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetOrientation">CLIENT:GetOrientation()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetOrientationX">CLIENT:GetOrientationX()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetOrientationY">CLIENT:GetOrientationY()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetOrientationZ">CLIENT:GetOrientationZ()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p> Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPitch">CLIENT:GetPitch()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the pitch angle of a POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPointVec2">CLIENT:GetPointVec2()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPointVec3">CLIENT:GetPointVec3()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPosition">CLIENT:GetPosition()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a pos3 table of the objects current position and orientation in 3D space.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetPositionVec3">CLIENT:GetPositionVec3()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the <a href="DCS.html##(Position3)">DCS#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRadio">CLIENT:GetRadio()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a <a href="Core.Radio.html##(RADIO)">Core.Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRandomVec3">CLIENT:GetRandomVec3(Radius)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a random <a href="DCS.html##(Vec3)">DCS#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRelativeVelocity">CLIENT:GetRelativeVelocity(Positionable)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get relative velocity with respect to another POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetRoll">CLIENT:GetRoll()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the roll angle 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="##(CLIENT).GetSize">CLIENT:GetSize()</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="##(CLIENT).GetSpot">CLIENT:GetSpot()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the Spot</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVec2">CLIENT:GetVec2()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the <a href="DCS.html##(Vec2)">DCS#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVec3">CLIENT:GetVec3()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the <a href="DCS.html##(Vec3)">DCS#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVelocity">CLIENT:GetVelocity()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVelocityKMH">CLIENT:GetVelocityKMH()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE velocity in km/h.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVelocityKNOTS">CLIENT:GetVelocityKNOTS()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE velocity in knots.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVelocityMPS">CLIENT:GetVelocityMPS()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE velocity in meters per second.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetVelocityVec3">CLIENT:GetVelocityVec3()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the POSITIONABLE velocity Vec3 vector.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetYaw">CLIENT:GetYaw()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the yaw angle of a POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).HasCargo">CLIENT:HasCargo(Cargo)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if carrier has given cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).InAir">CLIENT:InAir()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the POSITIONABLE is in the air.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAboveRunway">CLIENT:IsAboveRunway()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Positionable is located above a runway.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAir">CLIENT:IsAir()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is of an air category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsCargoEmpty">CLIENT:IsCargoEmpty()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Is cargo bay empty.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsGround">CLIENT:IsGround()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is of an ground category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsInZone">CLIENT:IsInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the unit is within a <a href="Zone.html">Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsLasing">CLIENT:IsLasing()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the POSITIONABLE is lasing a target</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsNotInZone">CLIENT:IsNotInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns true if the unit is not within a <a href="Zone.html">Zone</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsShip">CLIENT:IsShip()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is of ship category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsSubmarine">CLIENT:IsSubmarine()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the unit is a submarine.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).LaseCoordinate">CLIENT:LaseCoordinate(Coordinate, LaserCode, Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Start Lasing a COORDINATE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).LaseOff">CLIENT:LaseOff()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stop Lasing a POSITIONABLE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).LaseUnit">CLIENT:LaseUnit(Target, LaserCode, Duration)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Start Lasing a POSITIONABLE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).LaserCode">CLIENT.LaserCode</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="##(CLIENT).Message">CLIENT:Message(Message, Duration, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to the players in the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToAll">CLIENT:MessageToAll(Message, Duration, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to all coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToBlue">CLIENT:MessageToBlue(Message, Duration, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to the blue coalition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToClient">CLIENT:MessageToClient(Message, Duration, Client, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to a client.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToCoalition">CLIENT:MessageToCoalition(Message, Duration, MessageCoalition, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to a coalition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToGroup">CLIENT:MessageToGroup(Message, Duration, MessageGroup, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to a <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToRed">CLIENT:MessageToRed(Message, Duration, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to the red coalition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageToSetGroup">CLIENT:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageTypeToCoalition">CLIENT:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message to a coalition.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).MessageTypeToGroup">CLIENT:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Send a message of a message type to a <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).New">CLIENT:New(PositionableName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new POSITIONABLE from a DCSPositionable</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).PositionableName">CLIENT.PositionableName</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="##(CLIENT).RemoveCargo">CLIENT:RemoveCargo(Cargo)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove cargo.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SetCargoBayWeightLimit">CLIENT:SetCargoBayWeightLimit(WeightLimit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set Cargo Bay Weight Limit in kg.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Smoke">CLIENT:Smoke(SmokeColor, Range, AddHeight)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SmokeBlue">CLIENT:SmokeBlue()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE Blue.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SmokeGreen">CLIENT:SmokeGreen()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE Green.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SmokeOrange">CLIENT:SmokeOrange()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE Orange.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SmokeRed">CLIENT:SmokeRed()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE Red.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).SmokeWhite">CLIENT:SmokeWhite()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Smoke the POSITIONABLE White.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).Spot">CLIENT.Spot</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="##(CLIENT).__">CLIENT.__</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="##(CLIENT).coordinate">CLIENT.coordinate</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Coordinate object.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).pointvec3">CLIENT.pointvec3</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Point Vec3 object.</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 IDENTIFIABLE</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="##(CLIENT).GetCallsign">CLIENT:GetCallsign()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the CallSign of the IDENTIFIABLE, which is a blank by default.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCategory">CLIENT:GetCategory()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns object category of the DCS Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCategoryName">CLIENT:GetCategoryName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCoalition">CLIENT:GetCoalition()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns coalition of the Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCoalitionName">CLIENT:GetCoalitionName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the name of the coalition of the Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCountry">CLIENT:GetCountry()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns country of the Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetCountryName">CLIENT:GetCountryName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns country name of the Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetDesc">CLIENT:GetDesc()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns Identifiable descriptor.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetName">CLIENT:GetName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns DCS Identifiable object name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetThreatLevel">CLIENT:GetThreatLevel()</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="##(CLIENT).GetTypeName">CLIENT:GetTypeName()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the type name of the DCS Identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).HasAttribute">CLIENT:HasAttribute(AttributeName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if the Object has the attribute.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IdentifiableName">CLIENT.IdentifiableName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The name of the identifiable.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).IsAlive">CLIENT:IsAlive()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the Identifiable is alive.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).New">CLIENT:New(IdentifiableName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new IDENTIFIABLE from a DCSIdentifiable</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 OBJECT</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="##(CLIENT).Destroy">CLIENT:Destroy()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Destroys the OBJECT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).GetID">CLIENT:GetID()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns the unit's unique identifier.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).New">CLIENT:New(ObjectName, Test)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Create a new OBJECT from a DCSObject</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).ObjectName">CLIENT.ObjectName</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>The name of the Object.</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="##(CLIENT).ClassID">CLIENT.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="##(CLIENT).ClassName">CLIENT.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="##(CLIENT).ClassNameAndID">CLIENT.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="##(CLIENT).ClearState">CLIENT: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="##(CLIENT).CreateEventBirth">CLIENT: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="##(CLIENT).CreateEventCrash">CLIENT:CreateEventCrash(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="##(CLIENT).CreateEventDead">CLIENT:CreateEventDead(EventTime, Initiator)</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="##(CLIENT).CreateEventPlayerEnterAircraft">CLIENT: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="##(CLIENT).CreateEventRemoveUnit">CLIENT: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="##(CLIENT).CreateEventTakeoff">CLIENT: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="##(CLIENT).E">CLIENT: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="##(CLIENT).EventDispatcher">CLIENT: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="##(CLIENT).EventRemoveAll">CLIENT: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="##(CLIENT).F">CLIENT: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="##(CLIENT).F2">CLIENT: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="##(CLIENT).F3">CLIENT: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="##(CLIENT).GetClassID">CLIENT: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="##(CLIENT).GetClassName">CLIENT: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="##(CLIENT).GetClassNameAndID">CLIENT: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="##(CLIENT).GetEventPriority">CLIENT:GetEventPriority()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the Class <a href="Event.html">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="##(CLIENT).GetParent">CLIENT: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="##(CLIENT).GetState">CLIENT: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="##(CLIENT).HandleEvent">CLIENT: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="##(CLIENT).I">CLIENT: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="##(CLIENT).Inherit">CLIENT: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="##(CLIENT).IsInstanceOf">CLIENT: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="##(CLIENT).IsTrace">CLIENT: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="##(CLIENT).New">CLIENT: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="##(CLIENT).OnEvent">CLIENT:OnEvent(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when an object 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="##(CLIENT).OnEventBDA">CLIENT: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="##(CLIENT).OnEventBaseCaptured">CLIENT: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="##(CLIENT).OnEventBirth">CLIENT: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="##(CLIENT).OnEventCrash">CLIENT: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="##(CLIENT).OnEventDead">CLIENT: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="##(CLIENT).OnEventDetailedFailure">CLIENT: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="##(CLIENT).OnEventDiscardChairAfterEjection">CLIENT: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="##(CLIENT).OnEventEjection">CLIENT: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
initiator : The unit that has ejected</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OnEventEngineShutdown">CLIENT: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="##(CLIENT).OnEventEngineStartup">CLIENT: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="##(CLIENT).OnEventHit">CLIENT: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="##(CLIENT).OnEventHumanFailure">CLIENT: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="##(CLIENT).OnEventKill">CLIENT: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="##(CLIENT).OnEventLand">CLIENT: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
initiator : The unit that has landed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OnEventLandingAfterEjection">CLIENT: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="##(CLIENT).OnEventLandingQualityMark">CLIENT: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="##(CLIENT).OnEventMarkAdded">CLIENT: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="##(CLIENT).OnEventMarkChange">CLIENT: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="##(CLIENT).OnEventMarkRemoved">CLIENT: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="##(CLIENT).OnEventMissionEnd">CLIENT:OnEventMissionEnd(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission ends.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OnEventMissionStart">CLIENT:OnEventMissionStart(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Occurs when a mission starts.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CLIENT).OnEventParatrooperLanding">CLIENT: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="##(CLIENT).OnEventPilotDead">CLIENT: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="##(CLIENT).OnEventPlayerEnterAircraft">CLIENT: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="##(CLIENT).OnEventPlayerEnterUnit">CLIENT: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="##(CLIENT).OnEventPlayerLeaveUnit">CLIENT: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="##(CLIENT).OnEventRefueling">CLIENT: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="##(CLIENT).OnEventRefuelingStop">CLIENT: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="##(CLIENT).OnEventScore">CLIENT: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="##(CLIENT).OnEventShootingEnd">CLIENT: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="##(CLIENT).OnEventShootingStart">CLIENT: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="##(CLIENT).OnEventShot">CLIENT: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="##(CLIENT).OnEventTakeoff">CLIENT: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="##(CLIENT).OnEventTriggerZone">CLIENT: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="##(CLIENT).OnEventUnitLost">CLIENT: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="##(CLIENT).ScheduleOnce">CLIENT: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="##(CLIENT).ScheduleRepeat">CLIENT: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="##(CLIENT).ScheduleStop">CLIENT:ScheduleStop(SchedulerFunction)</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="##(CLIENT).Scheduler">CLIENT.Scheduler</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="##(CLIENT).SetEventPriority">CLIENT:SetEventPriority(EventPriority)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set the Class <a href="Event.html">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="##(CLIENT).SetState">CLIENT: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="##(CLIENT).T">CLIENT: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="##(CLIENT).T2">CLIENT: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="##(CLIENT).T3">CLIENT: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="##(CLIENT).TraceAll">CLIENT: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="##(CLIENT).TraceClass">CLIENT: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="##(CLIENT).TraceClassMethod">CLIENT: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="##(CLIENT).TraceLevel">CLIENT: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="##(CLIENT).TraceOff">CLIENT: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="##(CLIENT).TraceOn">CLIENT: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="##(CLIENT).TraceOnOff">CLIENT: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="##(CLIENT).UnHandleEvent">CLIENT: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="##(CLIENT)._">CLIENT._</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="##(CLIENT)._F">CLIENT:_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="##(CLIENT)._T">CLIENT:_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="##(CLIENT).__">CLIENT.__</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="##(CLIENT).onEvent">CLIENT:onEvent(event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
</table>
</div>
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Wrapper.Client)" >Type <strong>Wrapper.Client</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##CLIENT')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(CLIENT)">Type <strong>CLIENT</strong></a></h2></div>
<div id= "#Types##CLIENT" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<p>The CLIENT 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 id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).AddBriefing" ><strong>CLIENT:AddBriefing(ClientBriefing)</strong></a></h2>
</div>
<p>Adds a briefing to a CLIENT when a player joins a mission.</p>
<div id= "#Functions##AddBriefing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>ClientBriefing</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the text defining the Mission briefing.</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="##(CLIENT)">#CLIENT</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="#(CLIENT).AddPlayer" ><strong>CLIENT:AddPlayer(PlayerName)</strong></a></h2>
</div>
<p>Add player name.</p>
<div id= "#Functions##AddPlayer" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>PlayerName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the player.</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="##(CLIENT)">#CLIENT</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="#(CLIENT).Alive" ><strong>CLIENT:Alive(CallBackFunction, ...)</strong></a></h2>
</div>
<p>Checks for a client alive event and calls a function on a continuous basis.</p>
<div id= "#Functions##Alive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>CallBackFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Create a function that will be called when a player joins the slot.</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 for callback function as comma separated list.</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="##(CLIENT)">#CLIENT</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="#(CLIENT).Find" ><strong>CLIENT:Find(DCSUnit, Error)</strong></a></h2>
</div>
<p>Finds a CLIENT from the _DATABASE using the relevant DCS Unit.</p>
<div id= "#Functions##Find" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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##(Unit)">DCS#Unit</a>
<strong><strong>DCSUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The DCS unit of the client.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Error</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Throw an error message.</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="##(CLIENT)">#CLIENT</a>:</p>
</div>
<div class="w3-half">
<p>The CLIENT found in the _DATABASE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).FindByName" ><strong>CLIENT:FindByName(ClientName, ClientBriefing, Error)</strong></a></h2>
</div>
<p>Finds a CLIENT from the _DATABASE using the relevant Client Unit Name.</p>
<p>As an optional parameter, a briefing text can be given also.</p>
<div id= "#Functions##FindByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>ClientName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the DCS <strong>Unit</strong> as defined within the Mission Editor.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ClientBriefing</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Text that describes the briefing of the mission when a Player logs into the Client.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Error</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A flag that indicates whether an error should be raised if the CLIENT cannot be found. By default an error will be raised.</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="##(CLIENT)">#CLIENT</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Create new Clients.
local Mission = MISSIONSCHEDULER.AddMission( 'Russia Transport Troops SA-6', 'Operational', 'Transport troops from the control center to one of the SA-6 SAM sites to activate their operation.', 'Russia' )
Mission:AddGoal( DeploySA6TroopsGoal )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 1' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 3' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*HOT-Deploy Troops 2' ):Transport() )
Mission:AddClient( CLIENT:FindByName( 'RU MI-8MTV2*RAMP-Deploy Troops 4' ):Transport() )</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetClientGroupDCSUnit" ><strong>CLIENT:GetClientGroupDCSUnit()</strong></a></h2>
</div>
<p>Returns the DCSUnit of the CLIENT.</p>
<div id= "#Functions##GetClientGroupDCSUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="DCS.html##(Unit)">DCS#Unit</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="#(CLIENT).GetClientGroupID" ><strong>CLIENT:GetClientGroupID()</strong></a></h2>
</div>
<p>Get the group ID of the client.</p>
<div id= "#Functions##GetClientGroupID" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>DCS#Group ID.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetClientGroupName" ><strong>CLIENT:GetClientGroupName()</strong></a></h2>
</div>
<p>Get the name of the group of the client.</p>
<div id= "#Functions##GetClientGroupName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetClientGroupUnit" ><strong>CLIENT:GetClientGroupUnit()</strong></a></h2>
</div>
<p>Returns the UNIT of the CLIENT.</p>
<div id= "#Functions##GetClientGroupUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>The client UNIT 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="#(CLIENT).GetDCSGroup" ><strong>CLIENT:GetDCSGroup()</strong></a></h2>
</div>
<p>Return the DCSGroup of a Client.</p>
<p>This function is modified to deal with a couple of bugs in DCS 1.5.3</p>
<div id= "#Functions##GetDCSGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="DCS.html##(Group)">DCS#Group</a>:</p>
</div>
<div class="w3-half">
<p>The group of the Client.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPlayer" ><strong>CLIENT:GetPlayer()</strong></a></h2>
</div>
<p>Get name of player.</p>
<div id= "#Functions##GetPlayer" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>Player name 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="#(CLIENT).GetPlayers" ><strong>CLIENT:GetPlayers()</strong></a></h2>
</div>
<p>Get player name(s).</p>
<div id= "#Functions##GetPlayers" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>List of player names or an 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="#(CLIENT).IsMultiSeated" ><strong>CLIENT:IsMultiSeated()</strong></a></h2>
</div>
<p>Checks if the CLIENT is a multi-seated UNIT.</p>
<div id= "#Functions##IsMultiSeated" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>true if multi-seated.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsTransport" ><strong>CLIENT:IsTransport()</strong></a></h2>
</div>
<p>Evaluates if the CLIENT is a transport.</p>
<div id= "#Functions##IsTransport" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>true is a transport.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Message" ><strong>CLIENT:Message(Message, MessageDuration, MessageCategory, MessageInterval, MessageID)</strong></a></h2>
</div>
<p>The main message driver for the CLIENT.</p>
<p>This function displays various messages to the Player logged into the CLIENT through the DCS World Messaging system.</p>
<div id= "#Functions##Message" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the text describing the message.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>MessageDuration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the duration in seconds that the Message should be displayed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>MessageCategory</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the category of the message (the title).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>MessageInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the interval in seconds between the display of the <a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> when the CLIENT is in the air.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>MessageID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>is the identifier of the message when displayed with intervals.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Register" ><strong>CLIENT:Register(ClientName)</strong></a></h2>
</div>
<p>Transport defines that the Client is a Transport.</p>
<p>Transports show cargo.</p>
<div id= "#Functions##Register" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>ClientName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the client 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="##(CLIENT)">#CLIENT</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="#(CLIENT).RemovePlayer" ><strong>CLIENT:RemovePlayer(PlayerName)</strong></a></h2>
</div>
<p>Remove player.</p>
<div id= "#Functions##RemovePlayer" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>PlayerName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the player.</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="##(CLIENT)">#CLIENT</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="#(CLIENT).RemovePlayers" ><strong>CLIENT:RemovePlayers()</strong></a></h2>
</div>
<p>Remove all players.</p>
<div id= "#Functions##RemovePlayers" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="##(CLIENT)">#CLIENT</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="#(CLIENT).Reset" ><strong>CLIENT:Reset(ClientName)</strong></a></h2>
</div>
<p>Resets a CLIENT.</p>
<div id= "#Functions##Reset" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>ClientName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the Group as defined within the Mission Editor. The Group must have a Unit with the type Client.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).ShowBriefing" ><strong>CLIENT:ShowBriefing()</strong></a></h2>
</div>
<p>Show the briefing of a CLIENT.</p>
<div id= "#Functions##ShowBriefing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="##(CLIENT)">#CLIENT</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="#(CLIENT).ShowCargo" ><strong>CLIENT:ShowCargo()</strong></a></h2>
</div>
<p>Shows the <a href="AI.AI_Cargo.html##(CARGO)">AI.AI_Cargo#CARGO</a> contained within the CLIENT to the player as a message.</p>
<p>The <a href="AI.AI_Cargo.html##(CARGO)">AI.AI_Cargo#CARGO</a> is shown using the <a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a> distribution system.</p>
<div id= "#Functions##ShowCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).ShowMissionBriefing" ><strong>CLIENT:ShowMissionBriefing(MissionBriefing)</strong></a></h2>
</div>
<p>Show the mission briefing of a MISSION to the CLIENT.</p>
<div id= "#Functions##ShowMissionBriefing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>MissionBriefing</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="##(CLIENT)">#CLIENT</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="#(CLIENT).Transport" ><strong>CLIENT:Transport()</strong></a></h2>
</div>
<p>Transport defines that the Client is a Transport.</p>
<p>Transports show cargo.</p>
<div id= "#Functions##Transport" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</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="##(CLIENT)">#CLIENT</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="#(CLIENT)._AliveCheckScheduler" ><strong>CLIENT:_AliveCheckScheduler(SchedulerName)</strong></a></h2>
</div>
<div id= "#Functions##_AliveCheckScheduler" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>CLIENT</p>
</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>SchedulerName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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 id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).EnableEmission" ><strong>CLIENT:EnableEmission(switch)</strong></a></h2>
</div>
<p>GROUND - Switch on/off radar emissions of a unit.</p>
<div id= "#Functions##EnableEmission" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>switch</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, emission is enabled. If false, emission is disabled. </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="##(UNIT)">#UNIT</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="#(CLIENT).Explode" ><strong>CLIENT:Explode(power, delay)</strong></a></h2>
</div>
<p>Triggers an explosion at the coordinates of the unit.</p>
<div id= "#Functions##Explode" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>power</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Power of the explosion in kg TNT. Default 100 kg TNT.</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>(Optional) Delay of explosion in seconds.</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="##(UNIT)">#UNIT</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="#(CLIENT).Find" ><strong>CLIENT:Find(DCSUnit)</strong></a></h2>
</div>
<p>Finds a UNIT from the _DATABASE using a DCSUnit object.</p>
<div id= "#Functions##Find" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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##(Unit)">DCS#Unit</a>
<strong><strong>DCSUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>An existing DCS Unit object reference.</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="##(UNIT)">#UNIT</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="#(CLIENT).FindByName" ><strong>CLIENT:FindByName(UnitName)</strong></a></h2>
</div>
<p>Find a UNIT in the _DATABASE using the name of an existing DCS Unit.</p>
<div id= "#Functions##FindByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>UnitName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Unit 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><a href="##(UNIT)">#UNIT</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="#(CLIENT).GetAmmo" ><strong>CLIENT:GetAmmo()</strong></a></h2>
</div>
<p>Returns the Unit's ammunition.</p>
<div id= "#Functions##GetAmmo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="DCS.html##(Unit.Ammo)">DCS#Unit.Ammo</a>:</p>
</div>
<div class="w3-half">
<p>Table with ammuntion of the unit (or nil). This can be a complex 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="#(CLIENT).GetAmmunition" ><strong>CLIENT:GetAmmunition()</strong></a></h2>
</div>
<p>Get the number of ammunition and in particular the number of shells, rockets, bombs and missiles a unit currently has.</p>
<div id= "#Functions##GetAmmunition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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>Total amount of ammo the unit has left. This is the sum of shells, rockets, bombs and missiles.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Number of shells left.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Number of rockets left.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Number of bombs left.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Number of missiles left.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCallsign" ><strong>CLIENT:GetCallsign()</strong></a></h2>
</div>
<p>Returns the Unit's callsign - the localized string.</p>
<div id= "#Functions##GetCallsign" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 Callsign of the Unit.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCategoryName" ><strong>CLIENT:GetCategoryName()</strong></a></h2>
</div>
<p>Returns the category name of the #UNIT.</p>
<div id= "#Functions##GetCategoryName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Category name = Helicopter, Airplane, Ground Unit, Ship</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetClient" ><strong>CLIENT:GetClient()</strong></a></h2>
</div>
<p>Get the CLIENT of the unit </p>
<div id= "#Functions##GetClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>:</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="#(CLIENT).GetDCSObject" ><strong>CLIENT:GetDCSObject()</strong></a></h2>
</div>
<p>Get the DCS unit object.</p>
<div id= "#Functions##GetDCSObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="DCS.html##(Unit)">DCS#Unit</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="#(CLIENT).GetDamageRelative" ><strong>CLIENT:GetDamageRelative()</strong></a></h2>
</div>
<p>Returns the unit's relative damage, i.e.</p>
<p>1-life.</p>
<div id= "#Functions##GetDamageRelative" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 Unit's relative health value, i.e. a number in [0,1] or 1 if unit does not exist any more.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetFuel" ><strong>CLIENT:GetFuel()</strong></a></h2>
</div>
<p>Returns relative amount of fuel (from 0.0 to 1.0) the UNIT has in its internal tanks.</p>
<p>If there are additional fuel tanks the value may be greater than 1.0.</p>
<div id= "#Functions##GetFuel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 relative amount of fuel (from 0.0 to 1.0) or <em>nil</em> if the DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetGroup" ><strong>CLIENT:GetGroup()</strong></a></h2>
</div>
<p>Returns the unit's group if it exist and nil otherwise.</p>
<div id= "#Functions##GetGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
</div>
<div class="w3-half">
<p>The Group of the Unit or <code>nil</code> if the unit does not exist. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLife" ><strong>CLIENT:GetLife()</strong></a></h2>
</div>
<p>Returns the unit's health.</p>
<p>Dead units has health &lt;= 1.0.</p>
<div id= "#Functions##GetLife" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 Unit's health value or -1 if unit does not exist any more.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLife0" ><strong>CLIENT:GetLife0()</strong></a></h2>
</div>
<p>Returns the Unit's initial health.</p>
<div id= "#Functions##GetLife0" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 Unit's initial health value or 0 if unit does not exist any more. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLifeRelative" ><strong>CLIENT:GetLifeRelative()</strong></a></h2>
</div>
<p>Returns the unit's relative health.</p>
<div id= "#Functions##GetLifeRelative" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 Unit's relative health value, i.e. a number in [0,1] or -1 if unit does not exist any more.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetNumber" ><strong>CLIENT:GetNumber()</strong></a></h2>
</div>
<p>Returns the unit's number in the group.</p>
<p>The number is the same number the unit has in ME.
It may not be changed during the mission.
If any unit in the group is destroyed, the numbers of another units will not be changed.</p>
<div id= "#Functions##GetNumber" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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>The Unit number. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPlayerName" ><strong>CLIENT:GetPlayerName()</strong></a></h2>
</div>
<p>Returns name of the player that control the unit or nil if the unit is controlled by A.I.</p>
<div id= "#Functions##GetPlayerName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return values:</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>Player Name</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPrefix" ><strong>CLIENT:GetPrefix()</strong></a></h2>
</div>
<p>Returns the prefix name of the DCS Unit.</p>
<p>A prefix name is a part of the name before a '#'-sign.
DCS Units spawned with the <a href="SPAWN.html">SPAWN</a> class contain a '#'-sign to indicate the end of the (base) DCS Unit name.
The spawn sequence number and unit number are contained within the name after the '#' sign. </p>
<div id= "#Functions##GetPrefix" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return values:</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 name of the DCS Unit.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRadar" ><strong>CLIENT:GetRadar()</strong></a></h2>
</div>
<p>Returns two values:</p>
<ul>
<li>First value indicates if at least one of the unit's radar(s) is on.</li>
</ul>
<ul>
<li>Second value is the object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.</li>
</ul>
<div id= "#Functions##GetRadar" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</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> Indicates if at least one of the unit's radar(s) is on.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Object)">DCS#Object</a>:</p>
</div>
<div class="w3-half">
<p>The object of the radar's interest. Not nil only if at least one radar of the unit is tracking a target.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRange" ><strong>CLIENT:GetRange()</strong></a></h2>
</div>
<p>Returns the unit's max range in meters derived from the DCS descriptors.</p>
<p>For ground units it will return a range of 10,000 km as they have no real range.</p>
<div id= "#Functions##GetRange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Range in meters.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetSensors" ><strong>CLIENT:GetSensors()</strong></a></h2>
</div>
<p>Returns the unit sensors.</p>
<div id= "#Functions##GetSensors" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="DCS.html##(Unit.Sensors)">DCS#Unit.Sensors</a>:</p>
</div>
<div class="w3-half">
<p>Table of sensors. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetSkill" ><strong>CLIENT:GetSkill()</strong></a></h2>
</div>
<p>Get skill from Unit.</p>
<div id= "#Functions##GetSkill" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Skill String of skill 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="#(CLIENT).GetSpeedMax" ><strong>CLIENT:GetSpeedMax()</strong></a></h2>
</div>
<p>Returns the unit's max speed in km/h derived from the DCS descriptors.</p>
<div id= "#Functions##GetSpeedMax" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Speed in km/h. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetTemplate" ><strong>CLIENT:GetTemplate()</strong></a></h2>
</div>
<p>Get the unit table from a unit's template.</p>
<div id= "#Functions##GetTemplate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Table of the unit template (deep copy) 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="#(CLIENT).GetTemplateFuel" ><strong>CLIENT:GetTemplateFuel()</strong></a></h2>
</div>
<p>Get the fuel of the unit from its template.</p>
<div id= "#Functions##GetTemplateFuel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Fuel of unit 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="#(CLIENT).GetTemplatePayload" ><strong>CLIENT:GetTemplatePayload()</strong></a></h2>
</div>
<p>Get the payload table from a unit's template.</p>
<p>The payload table has elements:</p>
<ul>
<li>pylons</li>
<li>fuel</li>
<li>chaff</li>
<li>gun
</li>
</ul>
<div id= "#Functions##GetTemplatePayload" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Payload table (deep copy) 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="#(CLIENT).GetTemplatePylons" ><strong>CLIENT:GetTemplatePylons()</strong></a></h2>
</div>
<p>Get the pylons table from a unit's template.</p>
<p>This can be a complex table depending on the weapons the unit is carrying.</p>
<div id= "#Functions##GetTemplatePylons" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Table of pylons (deepcopy) 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="#(CLIENT).GetThreatLevel" ><strong>CLIENT:GetThreatLevel()</strong></a></h2>
</div>
<p>Returns the Unit's A2G threat level on a scale from 1 to 10 ...</p>
<p>Depending on the era and the type of unit, the following threat levels are foreseen:</p>
<p><strong>Modern</strong>:</p>
<ul>
<li>Threat level 0: Unit is unarmed.</li>
<li>Threat level 1: Unit is infantry.</li>
<li>Threat level 2: Unit is an infantry vehicle.</li>
<li>Threat level 3: Unit is ground artillery.</li>
<li>Threat level 4: Unit is a tank.</li>
<li>Threat level 5: Unit is a modern tank or ifv with ATGM.</li>
<li>Threat level 6: Unit is a AAA.</li>
<li>Threat level 7: Unit is a SAM or manpad, IR guided.</li>
<li>Threat level 8: Unit is a Short Range SAM, radar guided.</li>
<li>Threat level 9: Unit is a Medium Range SAM, radar guided.</li>
<li>Threat level 10: Unit is a Long Range SAM, radar guided.</li>
</ul>
<p><strong>Cold</strong>:</p>
<ul>
<li>Threat level 0: Unit is unarmed.</li>
<li>Threat level 1: Unit is infantry.</li>
<li>Threat level 2: Unit is an infantry vehicle.</li>
<li>Threat level 3: Unit is ground artillery.</li>
<li>Threat level 4: Unit is a tank.</li>
<li>Threat level 5: Unit is a modern tank or ifv with ATGM.</li>
<li>Threat level 6: Unit is a AAA.</li>
<li>Threat level 7: Unit is a SAM or manpad, IR guided.</li>
<li>Threat level 8: Unit is a Short Range SAM, radar guided.</li>
<li>Threat level 10: Unit is a Medium Range SAM, radar guided.</li>
</ul>
<p><strong>Korea</strong>:</p>
<ul>
<li>Threat level 0: Unit is unarmed.</li>
<li>Threat level 1: Unit is infantry.</li>
<li>Threat level 2: Unit is an infantry vehicle.</li>
<li>Threat level 3: Unit is ground artillery.</li>
<li>Threat level 5: Unit is a tank.</li>
<li>Threat level 6: Unit is a AAA.</li>
<li>Threat level 7: Unit is a SAM or manpad, IR guided.</li>
<li>Threat level 10: Unit is a Short Range SAM, radar guided.</li>
</ul>
<p><strong>WWII</strong>:</p>
<ul>
<li>Threat level 0: Unit is unarmed.</li>
<li>Threat level 1: Unit is infantry.</li>
<li>Threat level 2: Unit is an infantry vehicle.</li>
<li>Threat level 3: Unit is ground artillery.</li>
<li>Threat level 5: Unit is a tank.</li>
<li>Threat level 7: Unit is FLAK.</li>
<li>Threat level 10: Unit is AAA.</li>
</ul>
<div id= "#Functions##GetThreatLevel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></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 between 0 (low threat level) and 10 (high threat level).</p>
</div>
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>Some 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="#(CLIENT).GetUnitCategory" ><strong>CLIENT:GetUnitCategory()</strong></a></h2>
</div>
<p>Returns the category of the #UNIT from descriptor.</p>
<p>Returns one of</p>
<ul>
<li>Unit.Category.AIRPLANE</li>
<li>Unit.Category.HELICOPTER</li>
<li>Unit.Category.GROUND_UNIT</li>
<li>Unit.Category.SHIP</li>
<li>Unit.Category.STRUCTURE</li>
</ul>
<div id= "#Functions##GetUnitCategory" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>Unit category from <code>getDesc().category</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="#(CLIENT).GetUnits" ><strong>CLIENT:GetUnits()</strong></a></h2>
</div>
<p>Returns a list of one <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
<div id= "#Functions##GetUnits" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#list&lt;Wrapper.Unit#UNIT&gt;:</p>
</div>
<div class="w3-half">
<p>A list of one <a href="Wrapper.Unit.html">Wrapper.Unit</a>.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).HandleEvent" ><strong>CLIENT: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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</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="#(CLIENT).HasSEAD" ><strong>CLIENT:HasSEAD()</strong></a></h2>
</div>
<p>Returns if the unit is SEADable.</p>
<div id= "#Functions##HasSEAD" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p>returns true if the unit is SEADable. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).HasSensors" ><strong>CLIENT:HasSensors(...)</strong></a></h2>
</div>
<p>Returns if the unit has sensors of a certain type.</p>
<div id= "#Functions##HasSensors" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>...</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>returns true if the unit has specified types of sensors. This function is more preferable than Unit.getSensors() if you don't want to get information about all the unit's sensors, and just want to check if the unit has specified types of sensors. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).InAir" ><strong>CLIENT:InAir(NoHeloCheck)</strong></a></h2>
</div>
<p>Returns true if the UNIT is in the air.</p>
<div id= "#Functions##InAir" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>NoHeloCheck</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, no additonal checks for helos are performed.</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>Return true if in the air or #nil if the UNIT is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsActive" ><strong>CLIENT:IsActive()</strong></a></h2>
</div>
<p>Returns if the unit is activated.</p>
<div id= "#Functions##IsActive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p><code>true</code> if Unit is activated. <code>nil</code> The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsAlive" ><strong>CLIENT:IsAlive()</strong></a></h2>
</div>
<p>Returns if the Unit is alive.</p>
<p>If the Unit is not alive, nil is returned. <br/>
If the Unit is alive and active, true is returned. <br/>
If the Unit is alive but not active, false is returned. </p>
<div id= "#Functions##IsAlive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p><code>true</code> if Unit is alive and active. <code>false</code> if Unit is alive but not active. <code>nil</code> if the Unit is not existing or is not alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsClient" ><strong>CLIENT:IsClient()</strong></a></h2>
</div>
<p>Checks is the unit is a <em>Player</em> or <em>Client</em> slot.</p>
<p> </p>
<div id= "#Functions##IsClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p>If true, unit is a player or client aircraft </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsDetected" ><strong>CLIENT:IsDetected(TargetUnit)</strong></a></h2>
</div>
<p>Returns if a unit is detecting the TargetUnit.</p>
<div id= "#Functions##IsDetected" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</a>
<strong><strong>TargetUnit</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>true If the TargetUnit is detected by the unit, otherwise 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="#(CLIENT).IsFriendly" ><strong>CLIENT:IsFriendly(FriendlyCoalition)</strong></a></h2>
</div>
<p>Returns if the unit is a friendly unit.</p>
<div id= "#Functions##IsFriendly" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>FriendlyCoalition</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>IsFriendly evaluation result.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsLOS" ><strong>CLIENT:IsLOS(TargetUnit)</strong></a></h2>
</div>
<p>Returns if a unit has Line of Sight (LOS) with the TargetUnit.</p>
<div id= "#Functions##IsLOS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</a>
<strong><strong>TargetUnit</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>true If the TargetUnit has LOS with the unit, otherwise 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="#(CLIENT).IsPlayer" ><strong>CLIENT:IsPlayer()</strong></a></h2>
</div>
<p>Check if an (air) unit is a client or player slot.</p>
<p>Information is retrieved from the group template.</p>
<div id= "#Functions##IsPlayer" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p>If true, unit is associated with a client or player slot.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsRefuelable" ><strong>CLIENT:IsRefuelable()</strong></a></h2>
</div>
<p>Check if the unit is refuelable.</p>
<p>Also retrieves the refuelling system (boom or probe) if applicable.</p>
<div id= "#Functions##IsRefuelable" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</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, unit is refuelable (checks for the attribute "Refuelable").</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Refueling system (if any): 0=boom, 1=probe.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsShip" ><strong>CLIENT:IsShip()</strong></a></h2>
</div>
<p>Returns if the unit is of a ship category.</p>
<p>If the unit is a ship, this method will return true, otherwise false.</p>
<div id= "#Functions##IsShip" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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">
<p>Ship category evaluation result.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsTanker" ><strong>CLIENT:IsTanker()</strong></a></h2>
</div>
<p>Check if the unit is a tanker.</p>
<p>Also retrieves the refuelling system (boom or probe) if applicable.</p>
<div id= "#Functions##IsTanker" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a></p>
</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, unit is refuelable (checks for the attribute "Refuelable").</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Refueling system (if any): 0=boom, 1=probe.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).KnowUnit" ><strong>CLIENT:KnowUnit(TargetUnit, TypeKnown, DistanceKnown)</strong></a></h2>
</div>
<p>Forces the unit to become aware of the specified target, without the unit manually detecting the other unit itself.</p>
<p>Applies only to a Unit Controller. Cannot be used at the group level.</p>
<div id= "#Functions##KnowUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</a>
<strong><strong>TargetUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The unit to be known.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>TypeKnown</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The target type is known. If <em>false</em>, the type is not known.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DistanceKnown</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The distance to the target is known. If <em>false</em>, distance is unknown.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Name" ><strong>CLIENT:Name()</strong></a></h2>
</div>
<p>Return the name of the UNIT.</p>
<div id= "#Functions##Name" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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 UNIT 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="#(CLIENT).OtherUnitInRadius" ><strong>CLIENT:OtherUnitInRadius(AwaitUnit, Radius)</strong></a></h2>
</div>
<p>Returns true if there is an <strong>other</strong> DCS Unit within a radius of the current 2D point of the DCS Unit.</p>
<div id= "#Functions##OtherUnitInRadius" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</a>
<strong><strong>AwaitUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The other UNIT wrapper object.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The radius in meters with the DCS Unit in the centre.</p>
</div>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
</div>
<div class="w3-half">
<p>true If the other DCS Unit is within the radius of the 2D point of the DCS Unit. </p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).ReSpawnAt" ><strong>CLIENT:ReSpawnAt(Coordinate, Heading)</strong></a></h2>
</div>
<p>Respawn the <a href="Wrapper.Unit.html">Wrapper.Unit</a> using a (tweaked) template of the parent Group.</p>
<p>This function will:</p>
<ul>
<li>Get the current position and heading of the group.</li>
<li>When the unit is alive, it will tweak the template x, y and heading coordinates of the group and the embedded units to the current units positions.</li>
<li>Then it will respawn the re-modelled group.
</li>
</ul>
<div id= "#Functions##ReSpawnAt" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The position where to Spawn the new Unit at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Heading</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The heading of the unit respawn.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Register" ><strong>CLIENT:Register(UnitName)</strong></a></h2>
</div>
<p>Create a new UNIT from DCSUnit.</p>
<div id= "#Functions##Register" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>UnitName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the DCS 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="##(UNIT)">#UNIT</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="#(CLIENT).ResetEvents" ><strong>CLIENT:ResetEvents()</strong></a></h2>
</div>
<p>Reset the subscriptions.</p>
<div id= "#Functions##ResetEvents" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</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="#(CLIENT).SetUnitInternalCargo" ><strong>CLIENT:SetUnitInternalCargo(mass)</strong></a></h2>
</div>
<p>Sets the Unit's Internal Cargo Mass, in kg</p>
<div id= "#Functions##SetUnitInternalCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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>mass</strong></strong>
</p>
</div>
<div class="w3-half">
<p>to set cargo 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="##(UNIT)">#UNIT</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="#(CLIENT).UnHandleEvent" ><strong>CLIENT: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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</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="##(UNIT)">#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).ClearTasks" ><strong>CLIENT:ClearTasks()</strong></a></h2>
</div>
<p>Clear all tasks from the controllable.</p>
<div id= "#Functions##ClearTasks" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandActivateBeacon" ><strong>CLIENT:CommandActivateBeacon(Type, System, Frequency, UnitID, Channel, ModeChannel, AA, Callsign, Bearing, Delay)</strong></a></h2>
</div>
<p>Give the CONTROLLABLE the command to activate a beacon.</p>
<p>See <a href="https://wiki.hoggitworld.com/view/DCS_command_activateBeacon">DCS_command_activateBeacon</a> on Hoggit.
For specific beacons like TACAN use the more convenient <a href="##(BEACON)">#BEACON</a> class.
Note that a controllable can only have one beacon activated at a time with the execption of ICLS.</p>
<div id= "#Functions##CommandActivateBeacon" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Radio.html##(BEACON.Type)">Core.Radio#BEACON.Type</a>
<strong><strong>Type</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Beacon type (VOR, DME, TACAN, RSBN, ILS etc).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Radio.html##(BEACON.System)">Core.Radio#BEACON.System</a>
<strong><strong>System</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Beacon system (VOR, DME, TACAN, RSBN, ILS etc).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequency in Hz the beacon is running on. Use <a href="##(UTILS).TACANToFrequency">UTILS.TACANToFrequency</a> to generate a frequency for TACAN beacons.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>UnitID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The ID of the unit the beacon is attached to. Useful if more units are in one group.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Channel</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Channel the beacon is using. For, e.g. TACAN beacons.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ModeChannel</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The TACAN mode of the beacon, i.e. "X" or "Y".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>AA</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, create and Air-Air beacon. IF nil, automatically set if CONTROLLABLE depending on whether unit is and aircraft or not.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Callsign</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Morse code identification callsign.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Bearing</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, beacon provides bearing information - if supported by the unit the beacon is attached to.</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>(Optional) Delay in seconds before the beacon is activated.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandActivateICLS" ><strong>CLIENT:CommandActivateICLS(Channel, UnitID, Callsign, Delay)</strong></a></h2>
</div>
<p>Activate ICLS system of the CONTROLLABLE.</p>
<p>The controllable should be an aircraft carrier!</p>
<div id= "#Functions##CommandActivateICLS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Channel</strong></strong>
</p>
</div>
<div class="w3-half">
<p>ICLS channel.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>UnitID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The ID of the unit the ICLS system is attached to. Useful if more units are in one group.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Callsign</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Morse code identification callsign.</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>(Optional) Delay in seconds before the ICLS is deactivated.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandDeactivateBeacon" ><strong>CLIENT:CommandDeactivateBeacon(Delay)</strong></a></h2>
</div>
<p>Deactivate the active beacon of the CONTROLLABLE.</p>
<div id= "#Functions##CommandDeactivateBeacon" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds before the beacon is deactivated.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandDeactivateICLS" ><strong>CLIENT:CommandDeactivateICLS(Delay)</strong></a></h2>
</div>
<p>Deactivate the ICLS of the CONTROLLABLE.</p>
<div id= "#Functions##CommandDeactivateICLS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds before the ICLS is deactivated.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandDoScript" ><strong>CLIENT:CommandDoScript(DoScript)</strong></a></h2>
</div>
<p>Do Script command</p>
<div id= "#Functions##CommandDoScript" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>DoScript</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="DCS.html##(DCSCommand)">DCS#DCSCommand</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="#(CLIENT).CommandEPLRS" ><strong>CLIENT:CommandEPLRS(SwitchOnOff, Delay)</strong></a></h2>
</div>
<p>Set EPLRS of the CONTROLLABLE on/off.</p>
<p>See <a href="https://wiki.hoggitworld.com/view/DCS_command_eplrs">DCS command EPLRS</a></p>
<div id= "#Functions##CommandEPLRS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>SwitchOnOff</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true (or nil) switch EPLRS on. If false switch off.</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>(Optional) Delay in seconds before the callsign is set. Default is immediately.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandSetCallsign" ><strong>CLIENT:CommandSetCallsign(CallName, CallNumber, Delay)</strong></a></h2>
</div>
<p>Set callsign of the CONTROLLABLE.</p>
<p>See <a href="https://wiki.hoggitworld.com/view/DCS_command_setCallsign">DCS command setCallsign</a></p>
<div id= "#Functions##CommandSetCallsign" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(CALLSIGN)">DCS#CALLSIGN</a>
<strong><strong>CallName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Number corresponding the the callsign identifier you wish this group to be 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>CallNumber</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The number value the group will be referred to as. Only valid numbers are 1-9. For example Uzi <strong>5</strong>-1. 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>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds before the callsign is set. Default is immediately.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandSetFrequency" ><strong>CLIENT:CommandSetFrequency(Frequency, Modulation, Delay)</strong></a></h2>
</div>
<p>Set radio frequency.</p>
<p>See <a href="https://wiki.hoggitworld.com/view/DCS_command_setFrequency">DCS command EPLRS</a></p>
<div id= "#Functions##CommandSetFrequency" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Radio frequency in MHz.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Modulation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Radio modulation. Default <code>radio.modulation.AM</code>.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay in seconds before the frequency is set. Default is immediately.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).CommandStopRoute" ><strong>CLIENT:CommandStopRoute(StopRoute)</strong></a></h2>
</div>
<p>Create a stop route command, which returns a string containing the command.</p>
<p>Use the result in the method <a href="##(CONTROLLABLE).SetCommand">CONTROLLABLE.SetCommand</a>().
A value of true will make the ground group stop, a value of false will make it continue.
Note that this can only work on GROUP level, although individual UNITs can be commanded, the whole GROUP will react.</p>
<p>Example missions:</p>
<ul>
<li>GRP-310</li>
</ul>
<div id= "#Functions##CommandStopRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>StopRoute</strong></strong>
</p>
</div>
<div class="w3-half">
<p>true if the ground unit needs to stop, false if it needs to continue to move.</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).CommandSwitchWayPoint" ><strong>CLIENT:CommandSwitchWayPoint(FromWayPoint, ToWayPoint)</strong></a></h2>
</div>
<p>Perform a switch waypoint command</p>
<div id= "#Functions##CommandSwitchWayPoint" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>FromWayPoint</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>
#number
<strong><strong>ToWayPoint</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- This test demonstrates the use(s) of the SwitchWayPoint method of the GROUP class.
HeliGroup = GROUP:FindByName( "Helicopter" )
-- Route the helicopter back to the FARP after 60 seconds.
-- We use the SCHEDULER class to do this.
SCHEDULER:New( nil,
function( HeliGroup )
local CommandRTB = HeliGroup:CommandSwitchWayPoint( 2, 8 )
HeliGroup:SetCommand( CommandRTB )
end, { HeliGroup }, 90
)</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).CopyRoute" ><strong>CLIENT:CopyRoute(Begin, End, Randomize, Radius)</strong></a></h2>
</div>
<p>Return the route of a controllable by using the <a href="Core.Database.html##(DATABASE)">Core.Database#DATABASE</a> class.</p>
<div id= "#Functions##CopyRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Begin</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The route point from where the copy will start. The base route point is 0.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>End</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The route point where the copy will end. The End point is the last point - the End point. The last point has base 0.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Randomize</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Randomization of the route, when true.</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>When randomization is on, the randomization is within the radius.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).EnRouteTaskAWACS" ><strong>CLIENT:EnRouteTaskAWACS()</strong></a></h2>
</div>
<p>(AIR) Aircraft will act as an AWACS for friendly units (will provide them with information about contacts).</p>
<p>No parameters.</p>
<div id= "#Functions##EnRouteTaskAWACS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskEWR" ><strong>CLIENT:EnRouteTaskEWR()</strong></a></h2>
</div>
<p>(GROUND) Ground unit (EW-radar) will act as an EWR for friendly units (will provide them with information about contacts).</p>
<p>No parameters.</p>
<div id= "#Functions##EnRouteTaskEWR" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskEngageGroup" ><strong>CLIENT:EnRouteTaskEngageGroup(AttackGroup, Priority, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit)</strong></a></h2>
</div>
<p>(AIR) Engaging a controllable.</p>
<p>The task does not assign the target controllable to the unit/controllable to attack now; it just allows the unit/controllable to engage the target controllable as well as other assigned targets.</p>
<div id= "#Functions##EnRouteTaskEngageGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Controllable to be attacked.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</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##(Distance)">DCS#Distance</a>
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired attack start altitude. Controllable/aircraft will make its attacks from the altitude. If the altitude is too low or too high to use weapon aircraft/controllable will choose closest altitude to the desired attack start altitude. If the desired altitude is defined controllable/aircraft will not attack from safe altitude.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>AttackQtyLimit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The flag determines how to interpret attackQty parameter. If the flag is true then attackQty is a limit on maximal attack quantity for "AttackGroup" and "AttackUnit" tasks. If the flag is false then attackQty is a desired attack quantity for "Bombing" and "BombingRunway" tasks.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskEngageTargets" ><strong>CLIENT:EnRouteTaskEngageTargets(Distance, TargetTypes, Priority)</strong></a></h2>
</div>
<p>(AIR) Engaging targets of defined types.</p>
<div id= "#Functions##EnRouteTaskEngageTargets" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Distance)">DCS#Distance</a>
<strong><strong>Distance</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Maximal distance from the target to a route leg. If the target is on a greater distance it will be ignored.</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##(AttributeNameArray)">DCS#AttributeNameArray</a>
<strong><strong>TargetTypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Array of target categories allowed to engage.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>All enroute tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. 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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskEngageTargetsInZone" ><strong>CLIENT:EnRouteTaskEngageTargetsInZone(Vec2, Radius, TargetTypes, Priority)</strong></a></h2>
</div>
<p>(AIR) Engaging a targets of defined types at circle-shaped zone.</p>
<div id= "#Functions##EnRouteTaskEngageTargetsInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>2D-coordinates of the zone.</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##(Distance)">DCS#Distance</a>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Radius of the zone.</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##(AttributeNameArray)">DCS#AttributeNameArray</a>
<strong><strong>TargetTypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Array of target categories allowed to engage. Default {"Air"}.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. 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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskEngageUnit" ><strong>CLIENT:EnRouteTaskEngageUnit(EngageUnit, Priority, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, Visible, ControllableAttack)</strong></a></h2>
</div>
<p>(AIR) Search and attack the Unit.</p>
<div id= "#Functions##EnRouteTaskEngageUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>EngageUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The UNIT.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) If true, all units in the group will attack the Unit when found.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</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##(Distance)">DCS#Distance</a>
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired altitude to perform the unit engagement.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Visible</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Unit must be visible.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>ControllableAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a controllable, not to a single aircraft.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskFAC" ><strong>CLIENT:EnRouteTaskFAC(Radius, Priority)</strong></a></h2>
</div>
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose a targets (enemy ground controllable) around as well as other assigned targets.</p>
<p>The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
If the task is assigned to the controllable lead unit will be a FAC.</p>
<div id= "#Functions##EnRouteTaskFAC" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Distance)">DCS#Distance</a>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p> The maximal distance from the FAC to a target.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskFAC_EngageGroup" ><strong>CLIENT:EnRouteTaskFAC_EngageGroup(AttackGroup, Priority, WeaponType, Designation, Datalink)</strong></a></h2>
</div>
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and lets the FAC to choose the target (enemy ground controllable) as well as other assigned targets.</p>
<p>The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
If the task is assigned to the controllable lead unit will be a FAC.</p>
<div id= "#Functions##EnRouteTaskFAC_EngageGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Target CONTROLLABLE.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Priority</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) All en-route tasks have the priority parameter. This is a number (less value - higher priority) that determines actions related to what task will be performed first. Default is 0.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Bitmask of weapon types those allowed to use. Default is "Auto".</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##(AI.Task.Designation)">DCS#AI.Task.Designation</a>
<strong><strong>Designation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Designation type.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Datalink</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Allows to use datalink to send the target information to attack aircraft. Enabled by 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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).EnRouteTaskTanker" ><strong>CLIENT:EnRouteTaskTanker()</strong></a></h2>
</div>
<p>(AIR) Aircraft will act as a tanker for friendly units.</p>
<p>No parameters.</p>
<div id= "#Functions##EnRouteTaskTanker" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).GetDetectedGroupSet" ><strong>CLIENT:GetDetectedGroupSet(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Return the detected target groups of the controllable as a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>.</p>
<p>The optional parametes specify the detection methods that can be applied.
If no detection method is given, the detection will use all the available methods by default.</p>
<div id= "#Functions##GetDetectedGroupSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include visually detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include optically detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by radar.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by IRST.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by RWR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by data link.</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.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>:</p>
</div>
<div class="w3-half">
<p>Set of detected 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="#(CLIENT).GetDetectedTargets" ><strong>CLIENT:GetDetectedTargets(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Return the detected targets of the controllable.</p>
<p>The optional parametes specify the detection methods that can be applied.
If no detection method is given, the detection will use all the available methods by default.</p>
<div id= "#Functions##GetDetectedTargets" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional)</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>DetectedTargets</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetDetectedUnitSet" ><strong>CLIENT:GetDetectedUnitSet(DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Return the detected targets of the controllable.</p>
<p>The optional parametes specify the detection methods that can be applied.
If <strong>no</strong> detection method is given, the detection will use <strong>all</strong> the available methods by default.
If <strong>at least one</strong> detection method is specified, only the methods set to <em>true</em> will be used.</p>
<div id= "#Functions##GetDetectedUnitSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include visually detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include optically detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by radar.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by IRST.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by RWR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by data link.</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.Set.html##(SET_UNIT)">Core.Set#SET_UNIT</a>:</p>
</div>
<div class="w3-half">
<p>Set of detected units.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetFuel" ><strong>CLIENT:GetFuel()</strong></a></h2>
</div>
<p>Returns relative amount of fuel (from 0.0 to 1.0) the unit has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetFuelAve" ><strong>CLIENT:GetFuelAve()</strong></a></h2>
</div>
<p>Returns relative average amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuelAve" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetFuelMin" ><strong>CLIENT:GetFuelMin()</strong></a></h2>
</div>
<p>Returns relative minimum amount of fuel (from 0.0 to 1.0) a unit or group has in its internal tanks.</p>
<p>This method returns nil to ensure polymorphic behavior! This method needs to be overridden by GROUP or UNIT.</p>
<div id= "#Functions##GetFuelMin" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLife" ><strong>CLIENT:GetLife()</strong></a></h2>
</div>
<p>Returns the health.</p>
<p>Dead controllables have health &lt;= 1.0.</p>
<div id= "#Functions##GetLife" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></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>The controllable health value (unit or group average).</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The controllable is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLife0" ><strong>CLIENT:GetLife0()</strong></a></h2>
</div>
<p>Returns the initial health.</p>
<div id= "#Functions##GetLife0" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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 controllable health value (unit or group average) or <code>nil</code> if the controllable does not exist.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetTaskMission" ><strong>CLIENT:GetTaskMission()</strong></a></h2>
</div>
<p>Return the mission template of the controllable.</p>
<div id= "#Functions##GetTaskMission" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>The MissionTemplate
TODO: Rework the method how to retrieve a template ...</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetTaskRoute" ><strong>CLIENT:GetTaskRoute()</strong></a></h2>
</div>
<p>Return the mission route of the controllable.</p>
<div id= "#Functions##GetTaskRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>The mission route defined by points.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetWayPoints" ><strong>CLIENT:GetWayPoints()</strong></a></h2>
</div>
<p>Get the current WayPoints set with the WayPoint functions( Note that the WayPoints can be nil, although there ARE waypoints).</p>
<div id= "#Functions##GetWayPoints" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>WayPoints If WayPoints is given, then return the WayPoints 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="#(CLIENT).HasTask" ><strong>CLIENT:HasTask()</strong></a></h2>
</div>
<p>Checking the Task Queue of the controllable.</p>
<p>Returns false if no task is on the queue. true if there is a task.</p>
<div id= "#Functions##HasTask" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).IsAirPlane" ><strong>CLIENT:IsAirPlane()</strong></a></h2>
</div>
<p>Returns if the Controllable contains AirPlanes.</p>
<div id= "#Functions##IsAirPlane" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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">
<p>true if Controllable contains AirPlanes.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsGroupDetected" ><strong>CLIENT:IsGroupDetected(Group, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Check if a certain GROUP is detected by the controllable.</p>
<p>The optional parametes specify the detection methods that can be applied.
If <strong>no</strong> detection method is given, the detection will use <strong>all</strong> the available methods by default.
If <strong>at least one</strong> detection method is specified, only the methods set to <em>true</em> will be used.</p>
<div id= "#Functions##IsGroupDetected" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>Group</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The group that is supposed to be detected.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include visually detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include optically detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by radar.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by IRST.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by RWR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by data link.</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>True if any unit of the group is detected.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsHelicopter" ><strong>CLIENT:IsHelicopter()</strong></a></h2>
</div>
<p>Returns if the Controllable contains Helicopters.</p>
<div id= "#Functions##IsHelicopter" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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">
<p>true if Controllable contains Helicopters.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsTargetDetected" ><strong>CLIENT:IsTargetDetected(DCSObject, self, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Check if a target is detected.</p>
<p>The optional parametes specify the detection methods that can be applied.
If <strong>no</strong> detection method is given, the detection will use <strong>all</strong> the available methods by default.
If <strong>at least one</strong> detection method is specified, only the methods set to <em>true</em> will be used.</p>
<div id= "#Functions##IsTargetDetected" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Object)">DCS#Object</a>
<strong><strong>DCSObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The DCS object that is checked.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>self</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>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include visually detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include optically detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by radar.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by IRST.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by RWR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by data link.</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>True if target is detected.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if target is visible by line of sight.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Mission time when target was detected.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if target type is known.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if distance to target is known.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Last known position vector of the target.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Last known velocity vector of the target.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsUnitDetected" ><strong>CLIENT:IsUnitDetected(Unit, DetectVisual, DetectOptical, DetectRadar, DetectIRST, DetectRWR, DetectDLINK)</strong></a></h2>
</div>
<p>Check if a certain UNIT is detected by the controllable.</p>
<p>The optional parametes specify the detection methods that can be applied.
If <strong>no</strong> detection method is given, the detection will use <strong>all</strong> the available methods by default.
If <strong>at least one</strong> detection method is specified, only the methods set to <em>true</em> will be used.</p>
<div id= "#Functions##IsUnitDetected" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>Unit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The unit that is supposed to be detected.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectVisual</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include visually detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectOptical</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include optically detected targets.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRadar</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by radar.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectIRST</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by IRST.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectRWR</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by RWR.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>DetectDLINK</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If <em>false</em>, do not include targets detected by data link.</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>True if target is detected.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if target is visible by line of sight.</p>
</div>
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>Mission time when target was detected.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if target type is known.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>True if distance to target is known.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Last known position vector of the target.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Last known velocity vector of the target.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).New" ><strong>CLIENT:New(ControllableName)</strong></a></h2>
</div>
<p>Create a new CONTROLLABLE from a DCSControllable</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>ControllableName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The DCS Controllable 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><a href="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionAAAttackRange" ><strong>CLIENT:OptionAAAttackRange(range)</strong></a></h2>
</div>
<p>Sets Controllable Option for A2A attack range for AIR FIGHTER units.</p>
<div id= "#Functions##OptionAAAttackRange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>range</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Defines the range</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>Range can be one of MAX_RANGE = 0, NEZ_RANGE = 1, HALF_WAY_RMAX_NEZ = 2, TARGET_THREAT_EST = 3, RANDOM_RANGE = 4. Defaults to 3. See: https://wiki.hoggitworld.com/view/DCS_option_missileAttack</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).OptionAlarmStateAuto" ><strong>CLIENT:OptionAlarmStateAuto()</strong></a></h2>
</div>
<p>Alarm state to Auto: AI will automatically switch alarm states based on the presence of threats.</p>
<p>The AI kind of cheats in this regard.</p>
<div id= "#Functions##OptionAlarmStateAuto" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionAlarmStateGreen" ><strong>CLIENT:OptionAlarmStateGreen()</strong></a></h2>
</div>
<p>Alarm state to Green: Group is not combat ready.</p>
<p>Sensors are stowed if possible.</p>
<div id= "#Functions##OptionAlarmStateGreen" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionAlarmStateRed" ><strong>CLIENT:OptionAlarmStateRed()</strong></a></h2>
</div>
<p>Alarm state to Red: Group is combat ready and actively searching for targets.</p>
<div id= "#Functions##OptionAlarmStateRed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionAllowJettisonWeaponsOnThreat" ><strong>CLIENT:OptionAllowJettisonWeaponsOnThreat()</strong></a></h2>
</div>
<p>Allow to Jettison of weapons upon threat.</p>
<div id= "#Functions##OptionAllowJettisonWeaponsOnThreat" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionDisperseOnAttack" ><strong>CLIENT:OptionDisperseOnAttack(Seconds)</strong></a></h2>
</div>
<p>Defines how long a GROUND unit/group will move to avoid an ongoing attack.</p>
<div id= "#Functions##OptionDisperseOnAttack" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Seconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Any positive number: AI will disperse, but only for the specified time before continuing their route. 0: AI will not disperse.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionECM_AlwaysOn" ><strong>CLIENT:OptionECM_AlwaysOn()</strong></a></h2>
</div>
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
<p>AI will leave their ECM on all the time.</p>
<div id= "#Functions##OptionECM_AlwaysOn" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionECM_DetectedLockByRadar" ><strong>CLIENT:OptionECM_DetectedLockByRadar()</strong></a></h2>
</div>
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
<p>If the AI is being detected by a radar they will enable their ECM.</p>
<div id= "#Functions##OptionECM_DetectedLockByRadar" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionECM_Never" ><strong>CLIENT:OptionECM_Never()</strong></a></h2>
</div>
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
<p>Disables the ability for AI to use their ECM.</p>
<div id= "#Functions##OptionECM_Never" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionECM_OnlyLockByRadar" ><strong>CLIENT:OptionECM_OnlyLockByRadar()</strong></a></h2>
</div>
<p>Defines the usage of Electronic Counter Measures by airborne forces.</p>
<p>If the AI is actively being locked by an enemy radar they will enable their ECM jammer.</p>
<div id= "#Functions##OptionECM_OnlyLockByRadar" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionEngageRange" ><strong>CLIENT:OptionEngageRange(EngageRange)</strong></a></h2>
</div>
<p>Defines the range at which a GROUND unit/group is allowed to use its weapons automatically.</p>
<div id= "#Functions##OptionEngageRange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>EngageRange</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Engage range limit in percent (a number between 0 and 100). Default 100.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionKeepWeaponsOnThreat" ><strong>CLIENT:OptionKeepWeaponsOnThreat()</strong></a></h2>
</div>
<p>Keep weapons upon threat.</p>
<div id= "#Functions##OptionKeepWeaponsOnThreat" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionProhibitAfterburner" ><strong>CLIENT:OptionProhibitAfterburner(Prohibit)</strong></a></h2>
</div>
<p>Prohibit Afterburner.</p>
<div id= "#Functions##OptionProhibitAfterburner" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Prohibit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true or nil, prohibit. If false, do not prohibit.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROE" ><strong>CLIENT:OptionROE(ROEvalue)</strong></a></h2>
</div>
<p>Set option for Rules of Engagement (ROE).</p>
<div id= "#Functions##OptionROE" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>ROEvalue</strong></strong>
</p>
</div>
<div class="w3-half">
<p>ROE value. See ENUMS.ROE.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEHoldFire" ><strong>CLIENT:OptionROEHoldFire()</strong></a></h2>
</div>
<p>Weapons Hold: AI will hold fire under all circumstances.</p>
<div id= "#Functions##OptionROEHoldFire" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEHoldFirePossible" ><strong>CLIENT:OptionROEHoldFirePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE hold their weapons?</p>
<div id= "#Functions##OptionROEHoldFirePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROEOpenFire" ><strong>CLIENT:OptionROEOpenFire()</strong></a></h2>
</div>
<p>Open Fire (Only Designated): AI will engage only targets specified in its taskings.</p>
<div id= "#Functions##OptionROEOpenFire" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEOpenFirePossible" ><strong>CLIENT:OptionROEOpenFirePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE attack designated targets?</p>
<div id= "#Functions##OptionROEOpenFirePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROEOpenFireWeaponFree" ><strong>CLIENT:OptionROEOpenFireWeaponFree()</strong></a></h2>
</div>
<p>Open Fire, Weapons Free (Priority Designated): AI will engage any enemy group it detects, but will prioritize targets specified in the groups tasking.</p>
<p><strong>Only for AIR units!</strong></p>
<div id= "#Functions##OptionROEOpenFireWeaponFree" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEOpenFireWeaponFreePossible" ><strong>CLIENT:OptionROEOpenFireWeaponFreePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE attack priority designated targets?</p>
<p>Only for AIR!</p>
<div id= "#Functions##OptionROEOpenFireWeaponFreePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROEReturnFire" ><strong>CLIENT:OptionROEReturnFire()</strong></a></h2>
</div>
<p>Return Fire: AI will only engage threats that shoot first.</p>
<div id= "#Functions##OptionROEReturnFire" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEReturnFirePossible" ><strong>CLIENT:OptionROEReturnFirePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE attack returning on enemy fire?</p>
<div id= "#Functions##OptionROEReturnFirePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROEWeaponFree" ><strong>CLIENT:OptionROEWeaponFree()</strong></a></h2>
</div>
<p>Weapon free.</p>
<div id= "#Functions##OptionROEWeaponFree" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROEWeaponFreePossible" ><strong>CLIENT:OptionROEWeaponFreePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE attack targets of opportunity?</p>
<div id= "#Functions##OptionROEWeaponFreePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROT" ><strong>CLIENT:OptionROT(ROTvalue)</strong></a></h2>
</div>
<p>Set Reation On Threat behaviour.</p>
<div id= "#Functions##OptionROT" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>ROTvalue</strong></strong>
</p>
</div>
<div class="w3-half">
<p>ROT value. See ENUMS.ROT.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROTEvadeFire" ><strong>CLIENT:OptionROTEvadeFire()</strong></a></h2>
</div>
<p>Evade on fire.</p>
<div id= "#Functions##OptionROTEvadeFire" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROTEvadeFirePossible" ><strong>CLIENT:OptionROTEvadeFirePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE evade on enemy fire?</p>
<div id= "#Functions##OptionROTEvadeFirePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROTNoReaction" ><strong>CLIENT:OptionROTNoReaction()</strong></a></h2>
</div>
<p>No evasion on enemy threats.</p>
<div id= "#Functions##OptionROTNoReaction" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROTNoReactionPossible" ><strong>CLIENT:OptionROTNoReactionPossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE ignore enemy fire?</p>
<div id= "#Functions##OptionROTNoReactionPossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROTPassiveDefense" ><strong>CLIENT:OptionROTPassiveDefense()</strong></a></h2>
</div>
<p>Evasion passive defense.</p>
<div id= "#Functions##OptionROTPassiveDefense" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROTPassiveDefensePossible" ><strong>CLIENT:OptionROTPassiveDefensePossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE evade using passive defenses?</p>
<div id= "#Functions##OptionROTPassiveDefensePossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionROTVertical" ><strong>CLIENT:OptionROTVertical()</strong></a></h2>
</div>
<p>Evade on fire using vertical manoeuvres.</p>
<div id= "#Functions##OptionROTVertical" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionROTVerticalPossible" ><strong>CLIENT:OptionROTVerticalPossible()</strong></a></h2>
</div>
<p>Can the CONTROLLABLE evade on fire using vertical manoeuvres?</p>
<div id= "#Functions##OptionROTVerticalPossible" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).OptionRTBAmmo" ><strong>CLIENT:OptionRTBAmmo(WeaponsFlag)</strong></a></h2>
</div>
<p>Set RTB on ammo.</p>
<div id= "#Functions##OptionRTBAmmo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>WeaponsFlag</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Weapons.flag enumerator.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionRTBBingoFuel" ><strong>CLIENT:OptionRTBBingoFuel(RTB)</strong></a></h2>
</div>
<p>Set RTB on bingo fuel.</p>
<div id= "#Functions##OptionRTBBingoFuel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>RTB</strong></strong>
</p>
</div>
<div class="w3-half">
<p>true if RTB on bingo fuel (default), false if no RTB on bingo fuel.
Warning! When you switch this option off, the airborne group will continue to fly until all fuel has been consumed, and will crash.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).OptionRestrictBurner" ><strong>CLIENT:OptionRestrictBurner(RestrictBurner)</strong></a></h2>
</div>
<p>Sets Controllable Option for Restriction of Afterburner.</p>
<div id= "#Functions##OptionRestrictBurner" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>RestrictBurner</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, restrict burner. If false or nil, allow (unrestrict) burner.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).PatrolRoute" ><strong>CLIENT:PatrolRoute()</strong></a></h2>
</div>
<p>(GROUND) Patrol iteratively using the waypoints the for the (parent) group.</p>
<div id= "#Functions##PatrolRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).PatrolRouteRandom" ><strong>CLIENT:PatrolRouteRandom(Speed, Formation, ToWaypoint)</strong></a></h2>
</div>
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
<p>A random waypoint will be picked and the group will move towards that point.</p>
<div id= "#Functions##PatrolRouteRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Speed in km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The formation the group uses.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToWaypoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The waypoint where the group should move 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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).PatrolZones" ><strong>CLIENT:PatrolZones(ZoneList, Speed, Formation, DelayMin, DelayMax)</strong></a></h2>
</div>
<p>(GROUND) Patrol randomly to the waypoints the for the (parent) group.</p>
<p>A random waypoint will be picked and the group will move towards that point.</p>
<div id= "#Functions##PatrolZones" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>ZoneList</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Table of zones.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Speed in km/h the group moves at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Formation the group should use.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelayMin</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Delay in seconds before the group progresses to the next route point. Default 1 sec.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelayMax</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Max. delay in seconds. Actual delay is randomly chosen between DelayMin and DelayMax. Default equal to DelayMin.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).PopCurrentTask" ><strong>CLIENT:PopCurrentTask()</strong></a></h2>
</div>
<p>Popping current Task from the controllable.</p>
<div id= "#Functions##PopCurrentTask" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).PushTask" ><strong>CLIENT:PushTask(DCSTask, WaitTime)</strong></a></h2>
</div>
<p>Pushing Task on the queue from the controllable.</p>
<div id= "#Functions##PushTask" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>DCSTask</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>WaitTime</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).RelocateGroundRandomInRadius" ><strong>CLIENT:RelocateGroundRandomInRadius(speed, radius, onroad, shortcut, formation)</strong></a></h2>
</div>
<p>(GROUND) Relocate controllable to a random point within a given radius; use e.g.for evasive actions; Note that not all ground controllables can actually drive, also the alarm state of the controllable might stop it from moving.</p>
<div id= "#Functions##RelocateGroundRandomInRadius" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Speed of the controllable, default 20</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>Radius of the relocation zone, default 500</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>onroad</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true, route on road (less problems with AI way finding), default true</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>shortcut</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true and onroad is set, take a shorter route - if available - off road, default false</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Formation string as in the mission editor, e.g. "Vee", "Diamond", "Line abreast", etc. Defaults to "Off Road"</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).Route" ><strong>CLIENT:Route(Route, DelaySeconds)</strong></a></h2>
</div>
<p>Make the controllable to follow a given route.</p>
<div id= "#Functions##Route" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Route</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A table of Route Points.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Wait for the specified seconds before executing the Route. Default is one second.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RouteAirTo" ><strong>CLIENT:RouteAirTo(ToCoordinate, AltType, Type, Action, Speed, DelaySeconds)</strong></a></h2>
</div>
<p>Make the AIR Controllable fly towards a specific point.</p>
<div id= "#Functions##RouteAirTo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive 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.Point.html##(COORDINATE.RoutePointAltType)">Core.Point#COORDINATE.RoutePointAltType</a>
<strong><strong>AltType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The altitude type.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE.RoutePointType)">Core.Point#COORDINATE.RoutePointType</a>
<strong><strong>Type</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The route point type.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE.RoutePointAction)">Core.Point#COORDINATE.RoutePointAction</a>
<strong><strong>Action</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The route point action.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Speed in km/h. The default speed is 500 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Wait for the specified seconds before executing the Route.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RouteGroundOnRailRoads" ><strong>CLIENT:RouteGroundOnRailRoads(ToCoordinate, Speed, DelaySeconds, WaypointFunction, WaypointFunctionArguments)</strong></a></h2>
</div>
<p>Make the TRAIN Controllable to drive towards a specific point using railroads.</p>
<div id= "#Functions##RouteGroundOnRailRoads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Speed in km/h. The default speed is 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Wait for the specified seconds before executing the Route. Default is one second.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WaypointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>WaypointFunctionArguments</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) List of parameters passed to the <em>WaypointFunction</em>.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RouteGroundOnRoad" ><strong>CLIENT:RouteGroundOnRoad(ToCoordinate, Speed, DelaySeconds, OffRoadFormation, WaypointFunction, WaypointFunctionArguments)</strong></a></h2>
</div>
<p>Make the GROUND Controllable to drive towards a specific point using (mostly) roads.</p>
<div id= "#Functions##RouteGroundOnRoad" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Speed in km/h. The default speed is 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Wait for the specified seconds before executing the Route. Default is one second.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>OffRoadFormation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The formation at initial and final waypoint. Default is "Off Road".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WaypointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>WaypointFunctionArguments</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) List of parameters passed to the <em>WaypointFunction</em>.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RouteGroundTo" ><strong>CLIENT:RouteGroundTo(ToCoordinate, Speed, Formation, DelaySeconds, WaypointFunction, WaypointFunctionArguments)</strong></a></h2>
</div>
<p>Make the GROUND Controllable to drive towards a specific point.</p>
<div id= "#Functions##RouteGroundTo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Speed in km/h. The default speed is 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The route point Formation, which is a text string that specifies exactly the Text in the Type of the route point, like "Vee", "Echelon Right".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Wait for the specified seconds before executing the Route.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WaypointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>WaypointFunctionArguments</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) List of parameters passed to the <em>WaypointFunction</em>.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RoutePush" ><strong>CLIENT:RoutePush(Route, DelaySeconds)</strong></a></h2>
</div>
<p>Make the controllable to push follow a given route.</p>
<div id= "#Functions##RoutePush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Route</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A table of Route Points.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>DelaySeconds</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Wait for the specified seconds before executing the Route. Default is one second.</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
<p>The CONTROLLABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).RouteResume" ><strong>CLIENT:RouteResume()</strong></a></h2>
</div>
<p>Resumes the movement of the vehicle on the route.</p>
<div id= "#Functions##RouteResume" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).RouteStop" ><strong>CLIENT:RouteStop()</strong></a></h2>
</div>
<p>Stops the movement of the vehicle on the route.</p>
<div id= "#Functions##RouteStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).RouteToVec2" ><strong>CLIENT:RouteToVec2(Point, Speed)</strong></a></h2>
</div>
<p>(AIR + GROUND) Make the Controllable move to fly to a given point.</p>
<div id= "#Functions##RouteToVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec3)">DCS#Vec3</a>
<strong><strong>Point</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The destination point in Vec3 format.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed [m/s] to travel.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).RouteToVec3" ><strong>CLIENT:RouteToVec3(Point, Speed)</strong></a></h2>
</div>
<p>(AIR + GROUND) Make the Controllable move to a given point.</p>
<div id= "#Functions##RouteToVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec3)">DCS#Vec3</a>
<strong><strong>Point</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The destination point in Vec3 format.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed [m/s] to travel.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).SetCommand" ><strong>CLIENT:SetCommand(DCSCommand)</strong></a></h2>
</div>
<p>Executes a command action for the CONTROLLABLE.</p>
<div id= "#Functions##SetCommand" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Command)">DCS#Command</a>
<strong><strong>DCSCommand</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The command to be executed.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).SetOption" ><strong>CLIENT:SetOption(OptionID, OptionValue)</strong></a></h2>
</div>
<p>Set option.</p>
<div id= "#Functions##SetOption" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>OptionID</strong></strong>
</p>
</div>
<div class="w3-half">
<p>ID/Type of the option.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>OptionValue</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Value of the option</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).SetTask" ><strong>CLIENT:SetTask(DCSTask, WaitTime)</strong></a></h2>
</div>
<p>Clearing the Task Queue and Setting the Task on the queue from the controllable.</p>
<div id= "#Functions##SetTask" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Task)">DCS#Task</a>
<strong><strong>DCSTask</strong></strong>
</p>
</div>
<div class="w3-half">
<p>DCS Task array.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WaitTime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Time in seconds, before the task is set.</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="#(CLIENT).SetTaskWaypoint" ><strong>CLIENT:SetTaskWaypoint(Waypoint, Task)</strong></a></h2>
</div>
<p>Set a Task at a Waypoint using a Route list.</p>
<div id= "#Functions##SetTaskWaypoint" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Waypoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Waypoint!</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##(Task)">DCS#Task</a>
<strong><strong>Task</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Task structure to be executed!</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).StartUncontrolled" ><strong>CLIENT:StartUncontrolled(delay)</strong></a></h2>
</div>
<p>Give an uncontrolled air controllable the start command.</p>
<div id= "#Functions##StartUncontrolled" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>delay</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Delay before start command in seconds.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskAttackGroup" ><strong>CLIENT:TaskAttackGroup(AttackGroup, WeaponType, WeaponExpend, AttackQty, Direction, Altitude, AttackQtyLimit, GroupAttack)</strong></a></h2>
</div>
<p>(AIR) Attack a Controllable.</p>
<div id= "#Functions##TaskAttackGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Group to be attacked.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Bitmask of weapon types those allowed to use. If parameter is not defined that means no limits on weapon usage.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</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##(Distance)">DCS#Distance</a>
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired attack start altitude. Controllable/aircraft will make its attacks from the altitude. If the altitude is too low or too high to use weapon aircraft/controllable will choose closest altitude to the desired attack start altitude. If the desired altitude is defined controllable/aircraft will not attack from safe altitude.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>AttackQtyLimit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The flag determines how to interpret attackQty parameter. If the flag is true then attackQty is a limit on maximal attack quantity for "AttackGroup" and "AttackUnit" tasks. If the flag is false then attackQty is a desired attack quantity for "Bombing" and "BombingRunway" tasks.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If true, attack as 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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskAttackMapObject" ><strong>CLIENT:TaskAttackMapObject(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType)</strong></a></h2>
</div>
<p>(AIR) Attacking the map object (building, structure, etc).</p>
<div id= "#Functions##TaskAttackMapObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>2D-coordinates of the point to deliver weapon at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If true, all units in the group will attack the Unit when found.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The altitude [meters] from where to attack. Default 30 m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The WeaponType. Default Auto=1073741822.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskAttackUnit" ><strong>CLIENT:TaskAttackUnit(AttackUnit, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType)</strong></a></h2>
</div>
<p>(AIR) Attack the Unit.</p>
<div id= "#Functions##TaskAttackUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
<strong><strong>AttackUnit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The UNIT to be attacked</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If true, all units in the group will attack the Unit when found. Default false.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Determines how many weapons will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Limits maximal quantity of attack. The aircraft/controllable will not make more attacks than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The (minimum) altitude in meters from where to attack. Default is altitude of unit to attack but at least 1000 m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The WeaponType. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag">DCS Enumerator Weapon Type</a> on Hoggit.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskBombing" ><strong>CLIENT:TaskBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, Divebomb)</strong></a></h2>
</div>
<p>(AIR) Delivering weapon at the point on the ground.</p>
<div id= "#Functions##TaskBombing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>2D-coordinates of the point to deliver weapon at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) If true, all units in the group will attack the Unit when found.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit / controllable will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The altitude from where to attack.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The WeaponType.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Divebomb</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Perform dive bombing. Default false.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskBombingRunway" ><strong>CLIENT:TaskBombingRunway(Airbase, WeaponType, WeaponExpend, AttackQty, Direction, GroupAttack)</strong></a></h2>
</div>
<p>(AIR) Delivering weapon on the runway.</p>
<p>See <a href="https://wiki.hoggitworld.com/view/DCS_task_bombingRunway">hoggit</a></p>
<p>Make sure the aircraft has the following role:</p>
<ul>
<li>CAS</li>
<li>Ground Attack</li>
<li>Runway Attack</li>
<li>Anti-Ship Strike</li>
<li>AFAC</li>
<li>Pinpoint Strike</li>
</ul>
<div id= "#Functions##TaskBombingRunway" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
<strong><strong>Airbase</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Airbase to attack.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Bitmask of weapon types those allowed to use. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_weapon_flag">DCS enum weapon flag</a>. Default 2147485694 = AnyBomb (GuidedBomb + AnyUnguidedBomb).</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Enum AI.Task.WeaponExpend that defines how much munitions the AI will expend per attack run. Default "ALL".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Number of times the group will attack if the target. Default 1.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Flag indicates that the target must be engaged by all aircrafts of the controllable. Has effect only if the task is assigned to a group and not to a single aircraft.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskCarpetBombing" ><strong>CLIENT:TaskCarpetBombing(Vec2, GroupAttack, WeaponExpend, AttackQty, Direction, Altitude, WeaponType, CarpetLength)</strong></a></h2>
</div>
<p>(AIR) Delivering weapon via CarpetBombing (all bombers in formation release at same time) at the point on the ground.</p>
<div id= "#Functions##TaskCarpetBombing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>2D-coordinates of the point to deliver weapon at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>GroupAttack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) If true, all units in the group will attack the Unit when found.</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##(AI.Task.WeaponExpend)">DCS#AI.Task.WeaponExpend</a>
<strong><strong>WeaponExpend</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Determines how much weapon will be released at each attack. If parameter is not defined the unit will choose expend on its own discretion.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AttackQty</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) This parameter limits maximal quantity of attack. The aircraft/controllable will not make more attack than allowed even if the target controllable not destroyed and the aircraft/controllable still have ammo. If not defined the aircraft/controllable will attack target until it will be destroyed or until the aircraft/controllable will run out of ammo.</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##(Azimuth)">DCS#Azimuth</a>
<strong><strong>Direction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Desired ingress direction from the target to the attacking aircraft. Controllable/aircraft will make its attacks from the direction. Of course if there is no way to attack from the direction due the terrain controllable/aircraft will choose another direction.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The altitude from where to attack.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The WeaponType.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>CarpetLength</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) default to 500 m.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskCombo" ><strong>CLIENT:TaskCombo(DCSTasks)</strong></a></h2>
</div>
<p>Return a Combo Task taking an array of Tasks.</p>
<div id= "#Functions##TaskCombo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(TaskArray)">DCS#TaskArray</a>
<strong><strong>DCSTasks</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Array of <a href="DCSTasking.Task.html##(Task)">DCSTasking.Task#Task</a></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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).TaskCondition" ><strong>CLIENT:TaskCondition(time, userFlag, userFlagValue, condition, duration, lastWayPoint)</strong></a></h2>
</div>
<p>Return a condition section for a controlled task.</p>
<div id= "#Functions##TaskCondition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>time</strong></strong>
</p>
</div>
<div class="w3-half">
<p>DCS mission time.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>userFlag</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Name of the user flag.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>userFlagValue</strong></strong>
</p>
</div>
<div class="w3-half">
<p>User flag value <em>true</em> or <em>false</em>. Could also be numeric, i.e. either 0=<em>false</em> or 1=<em>true</em>. Other numeric values don't work!</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>condition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Lua string.</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##(Time)">DCS#Time</a>
<strong><strong>duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Duration in seconds.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>lastWayPoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Last waypoint.
return DCS#Task</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskControlled" ><strong>CLIENT:TaskControlled(DCSTask, DCSStopCondition)</strong></a></h2>
</div>
<p>Return a Controlled Task taking a Task and a TaskCondition.</p>
<div id= "#Functions##TaskControlled" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Task)">DCS#Task</a>
<strong><strong>DCSTask</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>
<a href="DCS.html##(DCSStopCondition)">DCS#DCSStopCondition</a>
<strong><strong>DCSStopCondition</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).TaskDisembarking" ><strong>CLIENT:TaskDisembarking(Coordinate, GroupSetToDisembark)</strong></a></h2>
</div>
<p>Specifies the location infantry groups that is being transported by helicopters will be unloaded at.</p>
<p>Used in conjunction with the EmbarkToTransport task.</p>
<div id= "#Functions##TaskDisembarking" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coordinates where AI is expecting to be picked up.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>GroupSetToDisembark</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>Embark to transport task.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskEPLRS" ><strong>CLIENT:TaskEPLRS(SwitchOnOff, idx)</strong></a></h2>
</div>
<p>Set EPLRS data link on/off.</p>
<div id= "#Functions##TaskEPLRS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a></p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>SwitchOnOff</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true (or nil) switch EPLRS on. If false switch off.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>idx</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Task index. Default 1.</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>Task wrapped action.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskEmbarkToTransport" ><strong>CLIENT:TaskEmbarkToTransport(Coordinate, Radius, UnitType)</strong></a></h2>
</div>
<p>Used in conjunction with the embarking task for a transport helicopter group.</p>
<p>The Ground units will move to the specified location and wait to be picked up by a helicopter.
The helicopter will then fly them to their dropoff point defined by another task for the ground forces; DisembarkFromTransport task.
The controllable has to be an infantry group!</p>
<div id= "#Functions##TaskEmbarkToTransport" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coordinates where AI is expecting to be picked up.</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>Radius in meters. Default 200 m.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>UnitType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The unit type name of the carrier, e.g. "UH-1H". Must not be specified.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>Embark to transport task.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskEmbarking" ><strong>CLIENT:TaskEmbarking(Coordinate, GroupSetForEmbarking, Duration, Distribution)</strong></a></h2>
</div>
<p>(AIR HELICOPTER) Move the controllable to a Vec2 Point, wait for a defined duration and embark infantry groups.</p>
<div id= "#Functions##TaskEmbarking" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The point where to pickup the troops.</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_GROUP)">Core.Set#SET_GROUP</a>
<strong><strong>GroupSetForEmbarking</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Set of groups to embark.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The maximum duration in seconds to wait until all groups have embarked.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Distribution</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Distribution used to put the infantry groups into specific carrier units.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskEscort" ><strong>CLIENT:TaskEscort(FollowControllable, Vec3, LastWaypointIndex, EngagementDistance, TargetTypes)</strong></a></h2>
</div>
<p>(AIR) Escort another airborne controllable.</p>
<p>The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders.
The unit / controllable will also protect that controllable from threats of specified types.</p>
<div id= "#Functions##TaskEscort" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable to be escorted.</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##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Position of the unit / lead unit of the controllable relative lead unit of another controllable in frame reference oriented by course of lead unit of another controllable. If another controllable is on land the unit / controllable will orbit around.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWaypointIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>EngagementDistance</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Maximal distance from escorted controllable to threat. If the threat is already engaged by escort escort will disengage if the distance becomes greater than 1.5 * engagementDistMax.</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##(AttributeNameArray)">DCS#AttributeNameArray</a>
<strong><strong>TargetTypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Array of AttributeName that is contains threat categories allowed to engage. Default {"Air"}.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskFAC_AttackGroup" ><strong>CLIENT:TaskFAC_AttackGroup(AttackGroup, WeaponType, Designation, Datalink, Frequency, Modulation, CallsignName, CallsignNumber)</strong></a></h2>
</div>
<p>(AIR + GROUND) The task makes the controllable/unit a FAC and orders the FAC to control the target (enemy ground controllable) destruction.</p>
<p>The killer is player-controlled allied CAS-aircraft that is in contact with the FAC.
If the task is assigned to the controllable lead unit will be a FAC.
It's important to note that depending on the type of unit that is being assigned the task (AIR or GROUND), you must choose the correct type of callsign enumerator. For airborne controllables use CALLSIGN.Aircraft and for ground based use CALLSIGN.JTAC enumerators.</p>
<div id= "#Functions##TaskFAC_AttackGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>AttackGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Target GROUP object.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Bitmask of weapon types, which are allowed to use.</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##(AI.Task.Designation)">DCS#AI.Task.Designation</a>
<strong><strong>Designation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Designation type.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Datalink</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Allows to use datalink to send the target information to attack aircraft. Enabled by default.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Frequency</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Frequency in MHz used to communicate with the FAC. Default 133 MHz.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Modulation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Modulation of radio for communication. Default 0=AM.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>CallsignName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Callsign enumerator name of the FAC. (CALLSIGN.Aircraft.{name} for airborne controllables, CALLSIGN.JTACS.{name} for ground units)</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>CallsignNumber</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Callsign number, e.g. Axeman-<strong>1</strong>.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskFireAtPoint" ><strong>CLIENT:TaskFireAtPoint(Vec2, Radius, AmmoCount, WeaponType, Altitude, ASL)</strong></a></h2>
</div>
<p>(GROUND) Fire at a VEC2 point until ammunition is finished.</p>
<div id= "#Functions##TaskFireAtPoint" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The point to fire at.</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##(Distance)">DCS#Distance</a>
<strong><strong>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The radius of the zone to deploy the fire at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AmmoCount</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Quantity of ammunition to expand (omit to fire until ammunition is depleted).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WeaponType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Enum for weapon type ID. This value is only required if you want the group firing to use a specific weapon, for instance using the task on a ship to force it to fire guided missiles at targets within cannon range. See http://wiki.hoggit.us/view/DCS_enum_weapon_flag</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Altitude in meters.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>ASL</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Altitude is above mean sea level. Default is above ground level.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskFollow" ><strong>CLIENT:TaskFollow(FollowControllable, Vec3, LastWaypointIndex)</strong></a></h2>
</div>
<p>(AIR) Following another airborne controllable.</p>
<p>The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders.
If another controllable is on land the unit / controllable will orbit around.</p>
<div id= "#Functions##TaskFollow" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable to be followed.</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##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Position of the unit / lead unit of the controllable relative lead unit of another controllable in frame reference oriented by course of lead unit of another controllable. If another controllable is on land the unit / controllable will orbit around.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWaypointIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskFollowBigFormation" ><strong>CLIENT:TaskFollowBigFormation(FollowControllable, Vec3, LastWaypointIndex)</strong></a></h2>
</div>
<p>(AIR) Following another airborne controllable.</p>
<p>The unit / controllable will follow lead unit of another controllable, wingmens of both controllables will continue following their leaders.
Used to support CarpetBombing Task</p>
<div id= "#Functions##TaskFollowBigFormation" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>FollowControllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable to be followed.</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##(Vec3)">DCS#Vec3</a>
<strong><strong>Vec3</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Position of the unit / lead unit of the controllable relative lead unit of another controllable in frame reference oriented by course of lead unit of another controllable. If another controllable is on land the unit / controllable will orbit around.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LastWaypointIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Detach waypoint of another controllable. Once reached the unit / controllable Follow task is finished.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskFunction" ><strong>CLIENT:TaskFunction(FunctionString, ...)</strong></a></h2>
</div>
<p>This creates a Task element, with an action to call a function as part of a Wrapped Task.</p>
<p>This Task can then be embedded at a Waypoint by calling the method <a href="##(CONTROLLABLE).SetTaskWaypoint">CONTROLLABLE.SetTaskWaypoint</a>.</p>
<div id= "#Functions##TaskFunction" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>FunctionString</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function name embedded as a string that will be called.</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>The variable arguments passed to the function when called! These arguments can be of any type!</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="##(CONTROLLABLE)">#CONTROLLABLE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
local ZoneList = {
ZONE:New( "ZONE1" ),
ZONE:New( "ZONE2" ),
ZONE:New( "ZONE3" ),
ZONE:New( "ZONE4" ),
ZONE:New( "ZONE5" )
}
GroundGroup = GROUP:FindByName( "Vehicle" )
--- @param Wrapper.Group#GROUP GroundGroup
function RouteToZone( Vehicle, ZoneRoute )
local Route = {}
Vehicle:E( { ZoneRoute = ZoneRoute } )
Vehicle:MessageToAll( "Moving to zone " .. ZoneRoute:GetName(), 10 )
-- Get the current coordinate of the Vehicle
local FromCoord = Vehicle:GetCoordinate()
-- Select a random Zone and get the Coordinate of the new Zone.
local RandomZone = ZoneList[ math.random( 1, #ZoneList ) ] -- Core.Zone#ZONE
local ToCoord = RandomZone:GetCoordinate()
-- Create a "ground route point", which is a "point" structure that can be given as a parameter to a Task
Route[#Route+1] = FromCoord:WaypointGround( 72 )
Route[#Route+1] = ToCoord:WaypointGround( 60, "Vee" )
local TaskRouteToZone = Vehicle:TaskFunction( "RouteToZone", RandomZone )
Vehicle:SetTaskWaypoint( Route[#Route], TaskRouteToZone ) -- Set for the given Route at Waypoint 2 the TaskRouteToZone.
Vehicle:Route( Route, math.random( 10, 20 ) ) -- Move after a random seconds to the Route. See the Route method for details.
end
RouteToZone( GroundGroup, ZoneList[1] )
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskGroundOnRailRoads" ><strong>CLIENT:TaskGroundOnRailRoads(ToCoordinate, Speed, WaypointFunction, WaypointFunctionArguments)</strong></a></h2>
</div>
<p>Make a task for a TRAIN Controllable to drive towards a specific point using railroad.</p>
<div id= "#Functions##TaskGroundOnRailRoads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Speed in km/h. The default speed is 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WaypointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>WaypointFunctionArguments</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) List of parameters passed to the <em>WaypointFunction</em>.</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>Task</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskGroundOnRoad" ><strong>CLIENT:TaskGroundOnRoad(ToCoordinate, Speed, OffRoadFormation, Shortcut, FromCoordinate, WaypointFunction, WaypointFunctionArguments)</strong></a></h2>
</div>
<p>Make a task for a GROUND Controllable to drive towards a specific point using (mostly) roads.</p>
<div id= "#Functions##TaskGroundOnRoad" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>ToCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A Coordinate to drive to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Speed in km/h. The default speed is 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>OffRoadFormation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The formation at initial and final waypoint. Default is "Off Road".</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Shortcut</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If true, controllable will take the direct route if the path on road is 10x longer or path on road is less than 5% of total path.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>FromCoordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Explicit initial coordinate. Default is the position of the controllable.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WaypointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) Function called when passing a waypoint. First parameters of the function are the <a href="CONTROLLABLE.html">CONTROLLABLE</a> object, the number of the waypoint and the total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>WaypointFunctionArguments</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) List of parameters passed to the <em>WaypointFunction</em>.</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>Task.</p>
</div>
<div class="w3-half">
<p>#boolean:</p>
</div>
<div class="w3-half">
<p>If true, path on road is possible. If false, task will route the group directly to its destination.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskHold" ><strong>CLIENT:TaskHold()</strong></a></h2>
</div>
<p>(GROUND) Hold ground controllable from moving.</p>
<div id= "#Functions##TaskHold" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskHoldPosition" ><strong>CLIENT:TaskHoldPosition(Duration)</strong></a></h2>
</div>
<p>(AIR) Hold position at the current position of the first unit of the controllable.</p>
<div id= "#Functions##TaskHoldPosition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The maximum duration in seconds to hold the position.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskLandAtVec2" ><strong>CLIENT:TaskLandAtVec2(Vec2, Duration)</strong></a></h2>
</div>
<p>(AIR HELICOPTER) Landing at the ground.</p>
<p>For helicopters only.</p>
<div id= "#Functions##TaskLandAtVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The point where to land.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration in seconds to stay on the ground.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskLandAtZone" ><strong>CLIENT:TaskLandAtZone(Zone, Duration, RandomPoint)</strong></a></h2>
</div>
<p>(AIR) Land the controllable at a @{Core.Zone#ZONE_RADIUS).</p>
<div id= "#Functions##TaskLandAtZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The zone where to land.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration in seconds to stay on the ground.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>RandomPoint</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskMission" ><strong>CLIENT:TaskMission(TaskMission)</strong></a></h2>
</div>
<p>(AIR + GROUND) Return a mission task from a mission template.</p>
<div id= "#Functions##TaskMission" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>TaskMission</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A table containing the mission task.</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).TaskOrbit" ><strong>CLIENT:TaskOrbit(Coord, Altitude, Speed, CoordRaceTrack)</strong></a></h2>
</div>
<p>(AIR) Orbit at a position with at a given altitude and speed.</p>
<p>Optionally, a race track pattern can be specified.</p>
<div id= "#Functions##TaskOrbit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coord</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Coordinate at which the CONTROLLABLE orbits.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Altitude in meters of the orbit pattern. Default y component of Coord.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Speed [m/s] flying the orbit pattern. Default 128 m/s = 250 knots.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>CoordRaceTrack</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If this coordinate is specified, the CONTROLLABLE will fly a race-track pattern using this and the initial coordinate.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskOrbitCircle" ><strong>CLIENT:TaskOrbitCircle(Altitude, Speed, Coordinate)</strong></a></h2>
</div>
<p>(AIR) Orbit at the current position of the first unit of the controllable at a specified altitude.</p>
<div id= "#Functions##TaskOrbitCircle" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The altitude [m] to hold the position.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed [m/s] flying when holding the position.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) The coordinate where to orbit. If the coordinate is not given, then the current position of the controllable is used.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskOrbitCircleAtVec2" ><strong>CLIENT:TaskOrbitCircleAtVec2(Point, Altitude, Speed)</strong></a></h2>
</div>
<p>(AIR) Orbit at a specified position at a specified altitude during a specified duration with a specified speed.</p>
<div id= "#Functions##TaskOrbitCircleAtVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Point</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The point to hold the position.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Altitude</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The altitude AGL in meters to hold the position.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed [m/s] flying when holding the position.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).TaskRefueling" ><strong>CLIENT:TaskRefueling()</strong></a></h2>
</div>
<p>(AIR) Refueling from the nearest tanker.</p>
<p>No parameters.</p>
<div id= "#Functions##TaskRefueling" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Task)">DCS#Task</a>:</p>
</div>
<div class="w3-half">
<p>The DCS task 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="#(CLIENT).TaskRoute" ><strong>CLIENT:TaskRoute(Points)</strong></a></h2>
</div>
<p>Return a Mission task to follow a given route defined by Points.</p>
<div id= "#Functions##TaskRoute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>Points</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A table of route points.</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).TaskRouteToVec2" ><strong>CLIENT:TaskRouteToVec2(Vec2, Speed, Formation)</strong></a></h2>
</div>
<p>(GROUND) Route the controllable to a given Vec2.</p>
<p>A speed can be given in km/h.
A given formation can be given.</p>
<div id= "#Functions##TaskRouteToVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Vec2)">DCS#Vec2</a>
<strong><strong>Vec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Vec2 where to route to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Base.html##(FORMATION)">Base#FORMATION</a>
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The formation string.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskRouteToZone" ><strong>CLIENT:TaskRouteToZone(Zone, Randomize, Speed, Formation)</strong></a></h2>
</div>
<p>(AIR + GROUND) Route the controllable to a given zone.</p>
<p>The controllable final destination point can be randomized.
A speed can be given in km/h.
A given formation can be given.</p>
<div id= "#Functions##TaskRouteToZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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.Zone.html##(ZONE)">Core.Zone#ZONE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The zone where to route to.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>Randomize</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Defines whether to target point gets randomized within the Zone.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Speed</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The speed in m/s. Default is 5.555 m/s = 20 km/h.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Base.html##(FORMATION)">Base#FORMATION</a>
<strong><strong>Formation</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The formation string.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TaskWrappedAction" ><strong>CLIENT:TaskWrappedAction(DCSCommand, Index)</strong></a></h2>
</div>
<p>Return a WrappedAction Task taking a Command.</p>
<div id= "#Functions##TaskWrappedAction" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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##(Command)">DCS#Command</a>
<strong><strong>DCSCommand</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>Index</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="DCS.html##(Task)">DCS#Task</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="#(CLIENT).WayPointExecute" ><strong>CLIENT:WayPointExecute(WayPoint, WaitTime)</strong></a></h2>
</div>
<p>Executes the WayPoint plan.</p>
<p>The function gets a WayPoint parameter, that you can use to restart the mission at a specific WayPoint.
Note that when the WayPoint parameter is used, the new start mission waypoint of the controllable will be 1!</p>
<div id= "#Functions##WayPointExecute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>WayPoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The WayPoint from where to execute the mission.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>WaitTime</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The amount seconds to wait before initiating the mission.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).WayPointFunction" ><strong>CLIENT:WayPointFunction(WayPoint, WayPointIndex, WayPointFunction, ...)</strong></a></h2>
</div>
<p>Registers a waypoint function that will be executed when the controllable moves over the WayPoint.</p>
<div id= "#Functions##WayPointFunction" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>WayPoint</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The waypoint number. Note that the start waypoint on the route is WayPoint 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>WayPointIndex</strong></strong>
</p>
</div>
<div class="w3-half">
<p>When defining multiple WayPoint functions for one WayPoint, use WayPointIndex to set the sequence of actions.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>WayPointFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The waypoint function to be called when the controllable moves over the waypoint. The waypoint function takes variable parameters.</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></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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT).WayPointInitialize" ><strong>CLIENT:WayPointInitialize(WayPoints)</strong></a></h2>
</div>
<p> Retrieve the controllable mission and allow to place function hooks within the mission waypoint plan.</p>
<p> Use the method <a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</a> to define the hook functions for specific waypoints.
Use the method @{Controllable@CONTROLLABLE:WayPointExecute) to start the execution of the new mission plan.
Note that when WayPointInitialize is called, the Mission of the controllable is RESTARTED!</p>
<div id= "#Functions##WayPointInitialize" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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>WayPoints</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If WayPoints is given, then use the route.</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="##(CONTROLLABLE)">#CONTROLLABLE</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="#(CLIENT)._GetController" ><strong>CLIENT:_GetController()</strong></a></h2>
</div>
<p>Get the controller for the CONTROLLABLE.</p>
<div id= "#Functions##_GetController" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="DCS.html##(Controller)">DCS#Controller</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="#(CLIENT).___PassingWaypoint" ><strong>CLIENT.___PassingWaypoint(controllable, n, N, waypointfunction, ...)</strong></a></h2>
</div>
<p>Task function when controllable passes a waypoint.</p>
<div id= "#Functions##___PassingWaypoint" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Controllable.html##(CONTROLLABLE)">Wrapper.Controllable#CONTROLLABLE</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="##(CONTROLLABLE)">#CONTROLLABLE</a>
<strong><strong>controllable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The controllable object.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>n</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Current waypoint number passed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>N</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Total number of waypoints.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>waypointfunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Function called when a waypoint is passed.</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></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 id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).AddCargo" ><strong>CLIENT:AddCargo(Cargo)</strong></a></h2>
</div>
<p>Add cargo.</p>
<div id= "#Functions##AddCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>
<strong><strong>Cargo</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="##(POSITIONABLE)">#POSITIONABLE</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="#(CLIENT).CargoItemCount" ><strong>CLIENT:CargoItemCount()</strong></a></h2>
</div>
<p>Get cargo item count.</p>
<div id= "#Functions##CargoItemCount" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>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="#(CLIENT).ClearCargo" ><strong>CLIENT:ClearCargo()</strong></a></h2>
</div>
<p>Clear all cargo.</p>
<div id= "#Functions##ClearCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Destroy" ><strong>CLIENT:Destroy(GenerateEvent)</strong></a></h2>
</div>
<p>Destroys the POSITIONABLE.</p>
<div id= "#Functions##Destroy" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>GenerateEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If true, generates a crash or dead event for the unit. If false, no event generated. If nil, a remove event is generated. </p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive.</p>
</div>
</div>
<h2><strong>Usages:</strong></h2>
<ul>
<li><pre class="example"><code>
Air unit example: destroy the Helicopter and generate a S_EVENT_CRASH for each unit in the Helicopter group.
Helicopter = UNIT:FindByName( "Helicopter" )
Helicopter:Destroy( true )
</code></pre></li>
<li><pre class="example"><code>-- Ground unit example: destroy the Tanks and generate a S_EVENT_DEAD for each unit in the Tanks group.
Tanks = UNIT:FindByName( "Tanks" )
Tanks:Destroy( true )
</code></pre></li>
<li><pre class="example"><code>-- Ship unit example: destroy the Ship silently.
Ship = STATIC:FindByName( "Ship" )
Ship:Destroy()
</code></pre></li>
<li><pre class="example"><code>-- Destroy without event generation example.
Ship = STATIC:FindByName( "Boat" )
Ship:Destroy( false ) -- Don't generate an event upon destruction.
</code></pre></li>
</ul>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).Flare" ><strong>CLIENT:Flare(FlareColor)</strong></a></h2>
</div>
<p>Signal a flare at the position of the POSITIONABLE.</p>
<div id= "#Functions##Flare" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="Utilities.Utils.html##(FLARECOLOR)">Utilities.Utils#FLARECOLOR</a>
<strong><strong>FlareColor</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="#(CLIENT).FlareGreen" ><strong>CLIENT:FlareGreen()</strong></a></h2>
</div>
<p>Signal a green flare at the position of the POSITIONABLE.</p>
<div id= "#Functions##FlareGreen" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).FlareRed" ><strong>CLIENT:FlareRed()</strong></a></h2>
</div>
<p>Signal a red flare at the position of the POSITIONABLE.</p>
<div id= "#Functions##FlareRed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).FlareWhite" ><strong>CLIENT:FlareWhite()</strong></a></h2>
</div>
<p>Signal a white flare at the position of the POSITIONABLE.</p>
<div id= "#Functions##FlareWhite" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).FlareYellow" ><strong>CLIENT:FlareYellow()</strong></a></h2>
</div>
<p>Signal a yellow flare at the position of the POSITIONABLE.</p>
<div id= "#Functions##FlareYellow" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetAltitude" ><strong>CLIENT:GetAltitude()</strong></a></h2>
</div>
<p>Returns the altitude of the POSITIONABLE.</p>
<div id= "#Functions##GetAltitude" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>The altitude of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetAoA" ><strong>CLIENT:GetAoA()</strong></a></h2>
</div>
<p>Returns the Angle of Attack of a POSITIONABLE.</p>
<div id= "#Functions##GetAoA" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>Angle of attack in degrees.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetBeacon" ><strong>CLIENT:GetBeacon()</strong></a></h2>
</div>
<p>Create a <a href="Core.Radio.html##(BEACON)">Core.Radio#BEACON</a>, to allow this POSITIONABLE to broadcast beacon signals</p>
<div id= "#Functions##GetBeacon" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Radio.html##(RADIO)">Core.Radio#RADIO</a>:</p>
</div>
<div class="w3-half">
<p>Radio</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetBoundingBox" ><strong>CLIENT:GetBoundingBox()</strong></a></h2>
</div>
<p>Get the bounding box of the underlying POSITIONABLE DCS Object.</p>
<div id= "#Functions##GetBoundingBox" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Box3)">DCS#Box3</a>:</p>
</div>
<div class="w3-half">
<p>The bounding box of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetBoundingRadius" ><strong>CLIENT:GetBoundingRadius(MinDist)</strong></a></h2>
</div>
<p>Get the bounding radius of the underlying POSITIONABLE DCS Object.</p>
<div id= "#Functions##GetBoundingRadius" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>MinDist</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(Optional) If bounding box is smaller than this value, MinDist is returned.</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="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>The bounding radius of the POSITIONABLE</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCargo" ><strong>CLIENT:GetCargo()</strong></a></h2>
</div>
<p>Get all contained cargo.</p>
<div id= "#Functions##GetCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="##(POSITIONABLE)">#POSITIONABLE</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="#(CLIENT).GetCargoBayFreeWeight" ><strong>CLIENT:GetCargoBayFreeWeight()</strong></a></h2>
</div>
<p>Get Cargo Bay Free Weight in kg.</p>
<div id= "#Functions##GetCargoBayFreeWeight" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>CargoBayFreeWeight</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetClimbAngle" ><strong>CLIENT:GetClimbAngle()</strong></a></h2>
</div>
<p>Returns the climb or descent angle of the POSITIONABLE.</p>
<div id= "#Functions##GetClimbAngle" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>Climb or descent angle in degrees. Or 0 if velocity vector norm is zero.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCoord" ><strong>CLIENT:GetCoord()</strong></a></h2>
</div>
<p>Returns a reference to a COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<p>This function works similar to POSITIONABLE.GetCoordinate(), however, this function caches, updates and re-uses the same COORDINATE object stored
within the POSITIONABLE. This has higher performance, but comes with all considerations associated with the possible referencing to the same COORDINATE object.
This should only be used when performance is critical and there is sufficient awareness of the possible pitfalls. However, in most instances, GetCoordinate() is
preferred as it will return a fresh new COORDINATE and thus avoid potentially unexpected issues.</p>
<div id= "#Functions##GetCoord" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
</div>
<div class="w3-half">
<p>A reference to the COORDINATE object of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCoordinate" ><strong>CLIENT:GetCoordinate()</strong></a></h2>
</div>
<p>Returns a new COORDINATE object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
</div>
<div class="w3-half">
<p>A new COORDINATE object of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetDCSObject" ><strong>CLIENT:GetDCSObject()</strong></a></h2>
</div>
<p>Returns the DCS object.</p>
<p>Polymorphic for other classes like UNIT, STATIC, GROUP, AIRBASE.</p>
<div id= "#Functions##GetDCSObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="DCS.html##(Object)">DCS#Object</a>:</p>
</div>
<div class="w3-half">
<p>The DCS 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="#(CLIENT).GetHeading" ><strong>CLIENT:GetHeading()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE heading in degrees.</p>
<div id= "#Functions##GetHeading" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>The POSITIONABLE heading in degrees.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetHeight" ><strong>CLIENT:GetHeight()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE height in meters.</p>
<div id= "#Functions##GetHeight" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The height of the POSITIONABLE in meters.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetLaserCode" ><strong>CLIENT:GetLaserCode()</strong></a></h2>
</div>
<p>Get the last assigned laser code</p>
<div id= "#Functions##GetLaserCode" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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 laser 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="#(CLIENT).GetMessage" ><strong>CLIENT:GetMessage(Message, Duration, Name)</strong></a></h2>
</div>
<p>Returns a message with the callsign embedded (if there is one).</p>
<div id= "#Functions##GetMessage" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</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.Message.html##(MESSAGE)">Core.Message#MESSAGE</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="#(CLIENT).GetMessageText" ><strong>CLIENT:GetMessageText(Message, Name)</strong></a></h2>
</div>
<p>Returns the message text with the callsign embedded (if there is one).</p>
<div id= "#Functions##GetMessageText" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
<h2><strong>Return values:</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 message text.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetMessageType" ><strong>CLIENT:GetMessageType(Message, MessageType, Name)</strong></a></h2>
</div>
<p>Returns a message of a specified type with the callsign embedded (if there is one).</p>
<div id= "#Functions##GetMessageType" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Message.html##(MESSAGE)">Core.Message#MESSAGE</a>
<strong><strong>MessageType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>MessageType The message type.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</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.Message.html##(MESSAGE)">Core.Message#MESSAGE</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="#(CLIENT).GetObjectSize" ><strong>CLIENT:GetObjectSize()</strong></a></h2>
</div>
<p>Get the object size.</p>
<div id= "#Functions##GetObjectSize" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>Max size of object in x, z or 0 if bounding box could not be obtained.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>Length x or 0 if bounding box could not be obtained.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>Height y or 0 if bounding box could not be obtained.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Distance)">DCS#Distance</a>:</p>
</div>
<div class="w3-half">
<p>Width z or 0 if bounding box could not be obtained.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetOffsetCoordinate" ><strong>CLIENT:GetOffsetCoordinate(x, y, z)</strong></a></h2>
</div>
<p>Returns a COORDINATE object, which is offset with respect to the orientation of the POSITIONABLE.</p>
<div id= "#Functions##GetOffsetCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>x</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offset in the direction "the nose" of the unit is pointing 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>
#number
<strong><strong>y</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offset "above" the unit 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>
#number
<strong><strong>z</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Offset in the direction "the wing" of the unit is pointing in meters. z>0 starboard, z&lt;0 port. Default 0 m.</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
</div>
<div class="w3-half">
<p>The COORDINATE of the offset with respect to the orientation of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetOrientation" ><strong>CLIENT:GetOrientation()</strong></a></h2>
</div>
<p> Returns a {@DCS#Vec3} table of the objects current orientation in 3D space.</p>
<p>X, Y, Z values are unit vectors defining the objects orientation.
X is the orientation parallel to the movement of the object, Z perpendicular and Y vertical orientation.</p>
<div id= "#Functions##GetOrientation" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>X orientation, i.e. parallel to the direction of movement.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Y orientation, i.e. vertical.</p>
</div>
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Z orientation, i.e. perpendicular to the direction of movement.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetOrientationX" ><strong>CLIENT:GetOrientationX()</strong></a></h2>
</div>
<p> Returns a {@DCS#Vec3} table of the objects current X orientation in 3D space, i.e.</p>
<p>along the direction of movement.</p>
<div id= "#Functions##GetOrientationX" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>X orientation, i.e. parallel to the direction of movement.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetOrientationY" ><strong>CLIENT:GetOrientationY()</strong></a></h2>
</div>
<p> Returns a {@DCS#Vec3} table of the objects current Y orientation in 3D space, i.e.</p>
<p>vertical orientation.</p>
<div id= "#Functions##GetOrientationY" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Y orientation, i.e. vertical.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetOrientationZ" ><strong>CLIENT:GetOrientationZ()</strong></a></h2>
</div>
<p> Returns a {@DCS#Vec3} table of the objects current Z orientation in 3D space, i.e.</p>
<p>perpendicular to direction of movement.</p>
<div id= "#Functions##GetOrientationZ" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>Z orientation, i.e. perpendicular to movement.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPitch" ><strong>CLIENT:GetPitch()</strong></a></h2>
</div>
<p>Returns the pitch angle of a POSITIONABLE.</p>
<div id= "#Functions##GetPitch" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>Pitch angle in degrees.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPointVec2" ><strong>CLIENT:GetPointVec2()</strong></a></h2>
</div>
<p>Returns a POINT_VEC2 object indicating the point in 2D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>:</p>
</div>
<div class="w3-half">
<p>The 2D point vector of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPointVec3" ><strong>CLIENT:GetPointVec3()</strong></a></h2>
</div>
<p>Returns a POINT_VEC3 object indicating the point in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetPointVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Point.html##(POINT_VEC3)">Core.Point#POINT_VEC3</a>:</p>
</div>
<div class="w3-half">
<p>The 3D point vector of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPosition" ><strong>CLIENT:GetPosition()</strong></a></h2>
</div>
<p>Returns a pos3 table of the objects current position and orientation in 3D space.</p>
<p>X, Y, Z values are unit vectors defining the objects orientation.
Coordinates are dependent on the position of the maps origin.</p>
<div id= "#Functions##GetPosition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="DCS.html##(Position3)">DCS#Position3</a>:</p>
</div>
<div class="w3-half">
<p>Table consisting of the point and orientation tables.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetPositionVec3" ><strong>CLIENT:GetPositionVec3()</strong></a></h2>
</div>
<p>Returns the <a href="DCS.html##(Position3)">DCS#Position3</a> position vectors indicating the point and direction vectors in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetPositionVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Position)">DCS#Position</a>:</p>
</div>
<div class="w3-half">
<p>The 3D position vectors of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRadio" ><strong>CLIENT:GetRadio()</strong></a></h2>
</div>
<p>Create a <a href="Core.Radio.html##(RADIO)">Core.Radio#RADIO</a>, to allow radio transmission for this POSITIONABLE.</p>
<p>Set parameters with the methods provided, then use RADIO:Broadcast() to actually broadcast the message</p>
<div id= "#Functions##GetRadio" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Radio.html##(RADIO)">Core.Radio#RADIO</a>:</p>
</div>
<div class="w3-half">
<p>Radio</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRandomVec3" ><strong>CLIENT:GetRandomVec3(Radius)</strong></a></h2>
</div>
<p>Returns a random <a href="DCS.html##(Vec3)">DCS#Vec3</a> vector within a range, indicating the point in 3D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetRandomVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Radius</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The 3D point vector of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- If Radius is ignored, returns the DCS#Vec3 of first UNIT of the GROUP</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRelativeVelocity" ><strong>CLIENT:GetRelativeVelocity(Positionable)</strong></a></h2>
</div>
<p>Get relative velocity with respect to another POSITIONABLE.</p>
<div id= "#Functions##GetRelativeVelocity" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="##(POSITIONABLE)">#POSITIONABLE</a>
<strong><strong>Positionable</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Other POSITIONABLE.</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>Relative velocity in m/s.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetRoll" ><strong>CLIENT:GetRoll()</strong></a></h2>
</div>
<p>Returns the roll angle of a unit.</p>
<div id= "#Functions##GetRoll" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>Pitch angle in degrees.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetSize" ><strong>CLIENT:GetSize()</strong></a></h2>
</div>
<div id= "#Functions##GetSize" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetSpot" ><strong>CLIENT:GetSpot()</strong></a></h2>
</div>
<p>Get the Spot</p>
<div id= "#Functions##GetSpot" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Spot.html##(SPOT)">Core.Spot#SPOT</a>:</p>
</div>
<div class="w3-half">
<p>The Spot</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVec2" ><strong>CLIENT:GetVec2()</strong></a></h2>
</div>
<p>Returns the <a href="DCS.html##(Vec2)">DCS#Vec2</a> vector indicating the point in 2D of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
</div>
<div class="w3-half">
<p>The 2D point vector of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVec3" ><strong>CLIENT:GetVec3()</strong></a></h2>
</div>
<p>Returns the <a href="DCS.html##(Vec3)">DCS#Vec3</a> vector indicating the 3D vector of the POSITIONABLE within the mission.</p>
<div id= "#Functions##GetVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The 3D point vector of the POSITIONABLE.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVelocity" ><strong>CLIENT:GetVelocity()</strong></a></h2>
</div>
<p>Returns the a <a href="Velocity.html">Velocity</a> object from the POSITIONABLE.</p>
<div id= "#Functions##GetVelocity" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Core.Velocity.html##(VELOCITY)">Core.Velocity#VELOCITY</a>:</p>
</div>
<div class="w3-half">
<p>Velocity The Velocity object.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVelocityKMH" ><strong>CLIENT:GetVelocityKMH()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE velocity in km/h.</p>
<div id= "#Functions##GetVelocityKMH" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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 velocity in km/h.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVelocityKNOTS" ><strong>CLIENT:GetVelocityKNOTS()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE velocity in knots.</p>
<div id= "#Functions##GetVelocityKNOTS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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 velocity in knots.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVelocityMPS" ><strong>CLIENT:GetVelocityMPS()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE velocity in meters per second.</p>
<div id= "#Functions##GetVelocityMPS" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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 velocity in meters per second.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetVelocityVec3" ><strong>CLIENT:GetVelocityVec3()</strong></a></h2>
</div>
<p>Returns the POSITIONABLE velocity Vec3 vector.</p>
<div id= "#Functions##GetVelocityVec3" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
</div>
<div class="w3-half">
<p>The velocity Vec3 vector</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetYaw" ><strong>CLIENT:GetYaw()</strong></a></h2>
</div>
<p>Returns the yaw angle of a POSITIONABLE.</p>
<div id= "#Functions##GetYaw" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></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>Yaw angle in degrees.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).HasCargo" ><strong>CLIENT:HasCargo(Cargo)</strong></a></h2>
</div>
<p>Returns if carrier has given cargo.</p>
<div id= "#Functions##HasCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Cargo</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="Core.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>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="#(CLIENT).InAir" ><strong>CLIENT:InAir()</strong></a></h2>
</div>
<p>Returns true if the POSITIONABLE is in the air.</p>
<p>Polymorphic, is overridden in GROUP and UNIT.</p>
<div id= "#Functions##InAir" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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>true if in the air.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsAboveRunway" ><strong>CLIENT:IsAboveRunway()</strong></a></h2>
</div>
<p>Returns if the Positionable is located above a runway.</p>
<div id= "#Functions##IsAboveRunway" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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>true if Positionable is above a runway.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsAir" ><strong>CLIENT:IsAir()</strong></a></h2>
</div>
<p>Returns if the unit is of an air category.</p>
<p>If the unit is a helicopter or a plane, then this method will return true, otherwise false.</p>
<div id= "#Functions##IsAir" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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>Air category evaluation result.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsCargoEmpty" ><strong>CLIENT:IsCargoEmpty()</strong></a></h2>
</div>
<p>Is cargo bay empty.</p>
<div id= "#Functions##IsCargoEmpty" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsGround" ><strong>CLIENT:IsGround()</strong></a></h2>
</div>
<p>Returns if the unit is of an ground category.</p>
<p>If the unit is a ground vehicle or infantry, this method will return true, otherwise false.</p>
<div id= "#Functions##IsGround" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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>Ground category evaluation result.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsInZone" ><strong>CLIENT:IsInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if the unit is within a <a href="Zone.html">Zone</a>.</p>
<div id= "#Functions##IsInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The zone to test.</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>Returns true if the unit is within the <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsLasing" ><strong>CLIENT:IsLasing()</strong></a></h2>
</div>
<p>Check if the POSITIONABLE is lasing a target</p>
<div id= "#Functions##IsLasing" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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">
<p>true if it is lasing a target</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsNotInZone" ><strong>CLIENT:IsNotInZone(Zone)</strong></a></h2>
</div>
<p>Returns true if the unit is not within a <a href="Zone.html">Zone</a>.</p>
<div id= "#Functions##IsNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The zone to test.</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>Returns true if the unit is not within the <a href="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsShip" ><strong>CLIENT:IsShip()</strong></a></h2>
</div>
<p>Returns if the unit is of ship category.</p>
<div id= "#Functions##IsShip" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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>Ship category evaluation result.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE is not existing or alive.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsSubmarine" ><strong>CLIENT:IsSubmarine()</strong></a></h2>
</div>
<p>Returns if the unit is a submarine.</p>
<div id= "#Functions##IsSubmarine" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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">
<p>Submarines attributes result.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).LaseCoordinate" ><strong>CLIENT:LaseCoordinate(Coordinate, LaserCode, Duration)</strong></a></h2>
</div>
<p>Start Lasing a COORDINATE.</p>
<div id= "#Functions##LaseCoordinate" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The coordinate where the lase is pointing at.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LaserCode</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Laser code or random number in [1000, 9999].</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Duration of lasing in seconds.</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.Spot.html##(SPOT)">Core.Spot#SPOT</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="#(CLIENT).LaseOff" ><strong>CLIENT:LaseOff()</strong></a></h2>
</div>
<p>Stop Lasing a POSITIONABLE</p>
<div id= "#Functions##LaseOff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="##(POSITIONABLE)">#POSITIONABLE</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="#(CLIENT).LaseUnit" ><strong>CLIENT:LaseUnit(Target, LaserCode, Duration)</strong></a></h2>
</div>
<p>Start Lasing a POSITIONABLE</p>
<div id= "#Functions##LaseUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="##(POSITIONABLE)">#POSITIONABLE</a>
<strong><strong>Target</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The target to lase.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>LaserCode</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Laser code or random number in [1000, 9999].</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Duration of lasing in seconds.</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.Spot.html##(SPOT)">Core.Spot#SPOT</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="#(CLIENT).Message" ><strong>CLIENT:Message(Message, Duration, Name)</strong></a></h2>
</div>
<p>Send a message to the players in the <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##Message" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToAll" ><strong>CLIENT:MessageToAll(Message, Duration, Name)</strong></a></h2>
</div>
<p>Send a message to all coalitions.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToAll" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToBlue" ><strong>CLIENT:MessageToBlue(Message, Duration, Name)</strong></a></h2>
</div>
<p>Send a message to the blue coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToBlue" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToClient" ><strong>CLIENT:MessageToClient(Message, Duration, Client, Name)</strong></a></h2>
</div>
<p>Send a message to a client.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>Client</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The client object receiving the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToCoalition" ><strong>CLIENT:MessageToCoalition(Message, Duration, MessageCoalition, Name)</strong></a></h2>
</div>
<p>Send a message to a coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToCoalition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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##(coalition)">DCS#coalition</a>
<strong><strong>MessageCoalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Coalition receiving the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToGroup" ><strong>CLIENT:MessageToGroup(Message, Duration, MessageGroup, Name)</strong></a></h2>
</div>
<p>Send a message to a <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</p>
</div>
</div>
<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>MessageGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The GROUP object receiving the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToRed" ><strong>CLIENT:MessageToRed(Message, Duration, Name)</strong></a></h2>
</div>
<p>Send a message to the red coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToRed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageToSetGroup" ><strong>CLIENT:MessageToSetGroup(Message, Duration, MessageSetGroup, Name)</strong></a></h2>
</div>
<p>Send a message to a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageToSetGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</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##(Duration)">DCS#Duration</a>
<strong><strong>Duration</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The duration of the message.</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_GROUP)">Core.Set#SET_GROUP</a>
<strong><strong>MessageSetGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The SET_GROUP collection receiving the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageTypeToCoalition" ><strong>CLIENT:MessageTypeToCoalition(Message, MessageType, MessageCoalition, Name)</strong></a></h2>
</div>
<p>Send a message to a coalition.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageTypeToCoalition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a>
<strong><strong>MessageType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message type that determines the duration.</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##(coalition)">DCS#coalition</a>
<strong><strong>MessageCoalition</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Coalition receiving the message.</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>(Optional) The Name of the sender. If not provided, Name is set to the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).MessageTypeToGroup" ><strong>CLIENT:MessageTypeToGroup(Message, MessageType, MessageGroup, Name)</strong></a></h2>
</div>
<p>Send a message of a message type to a <a href="Wrapper.Group.html">Wrapper.Group</a>.</p>
<p>The message will appear in the message area. The message will begin with the callsign of the group and the type of the first unit sending the message.</p>
<div id= "#Functions##MessageTypeToGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>Message</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message text</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Message.html##(MESSAGE.Type)">Core.Message#MESSAGE.Type</a>
<strong><strong>MessageType</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The message type that determines the duration.</p>
</div>
</div>
<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>MessageGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The GROUP object receiving the message.</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>(Optional) The Name of the sender. If not provided, the Name is the type of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).New" ><strong>CLIENT:New(PositionableName)</strong></a></h2>
</div>
<p>Create a new POSITIONABLE from a DCSPositionable</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="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>PositionableName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The POSITIONABLE 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><a href="##(POSITIONABLE)">#POSITIONABLE</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="#(CLIENT).RemoveCargo" ><strong>CLIENT:RemoveCargo(Cargo)</strong></a></h2>
</div>
<p>Remove cargo.</p>
<div id= "#Functions##RemoveCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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.Cargo.html##(CARGO)">Core.Cargo#CARGO</a>
<strong><strong>Cargo</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="##(POSITIONABLE)">#POSITIONABLE</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="#(CLIENT).SetCargoBayWeightLimit" ><strong>CLIENT:SetCargoBayWeightLimit(WeightLimit)</strong></a></h2>
</div>
<p>Set Cargo Bay Weight Limit in kg.</p>
<div id= "#Functions##SetCargoBayWeightLimit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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>WeightLimit</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="#(CLIENT).Smoke" ><strong>CLIENT:Smoke(SmokeColor, Range, AddHeight)</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE.</p>
<div id= "#Functions##Smoke" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</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="Utilities.Utils.html##(SMOKECOLOR)">Utilities.Utils#SMOKECOLOR</a>
<strong><strong>SmokeColor</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The smoke color.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Range</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The range in meters to randomize the smoking around the POSITIONABLE.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>AddHeight</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The height in meters to add to the altitude of the POSITIONABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SmokeBlue" ><strong>CLIENT:SmokeBlue()</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE Blue.</p>
<div id= "#Functions##SmokeBlue" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SmokeGreen" ><strong>CLIENT:SmokeGreen()</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE Green.</p>
<div id= "#Functions##SmokeGreen" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SmokeOrange" ><strong>CLIENT:SmokeOrange()</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE Orange.</p>
<div id= "#Functions##SmokeOrange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SmokeRed" ><strong>CLIENT:SmokeRed()</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE Red.</p>
<div id= "#Functions##SmokeRed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SmokeWhite" ><strong>CLIENT:SmokeWhite()</strong></a></h2>
</div>
<p>Smoke the POSITIONABLE White.</p>
<div id= "#Functions##SmokeWhite" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a></p>
</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 id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).GetCallsign" ><strong>CLIENT:GetCallsign()</strong></a></h2>
</div>
<p>Gets the CallSign of the IDENTIFIABLE, which is a blank by default.</p>
<div id= "#Functions##GetCallsign" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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 CallSign of the IDENTIFIABLE.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCategory" ><strong>CLIENT:GetCategory()</strong></a></h2>
</div>
<p>Returns object category of the DCS Identifiable.</p>
<p>One of</p>
<ul>
<li>Object.Category.UNIT = 1</li>
<li>Object.Category.WEAPON = 2</li>
<li>Object.Category.STATIC = 3</li>
<li>Object.Category.BASE = 4</li>
<li>Object.Category.SCENERY = 5</li>
<li>Object.Category.Cargo = 6
</li>
</ul>
<div id= "#Functions##GetCategory" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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="DCS.html##(Object.Category)">DCS#Object.Category</a>:</p>
</div>
<div class="w3-half">
<p>The category ID, i.e. a number.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCategoryName" ><strong>CLIENT:GetCategoryName()</strong></a></h2>
</div>
<p>Returns the DCS Identifiable category name as defined within the DCS Identifiable Descriptor.</p>
<div id= "#Functions##GetCategoryName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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 DCS Identifiable Category 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="#(CLIENT).GetCoalition" ><strong>CLIENT:GetCoalition()</strong></a></h2>
</div>
<p>Returns coalition of the Identifiable.</p>
<div id= "#Functions##GetCoalition" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(coalition.side)">DCS#coalition.side</a>:</p>
</div>
<div class="w3-half">
<p>The side of the coalition.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCoalitionName" ><strong>CLIENT:GetCoalitionName()</strong></a></h2>
</div>
<p>Returns the name of the coalition of the Identifiable.</p>
<div id= "#Functions##GetCoalitionName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
<h2><strong>Return values:</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 name of the coalition.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCountry" ><strong>CLIENT:GetCountry()</strong></a></h2>
</div>
<p>Returns country of the Identifiable.</p>
<div id= "#Functions##GetCountry" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(country.id)">DCS#country.id</a>:</p>
</div>
<div class="w3-half">
<p>The country identifier.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetCountryName" ><strong>CLIENT:GetCountryName()</strong></a></h2>
</div>
<p>Returns country name of the Identifiable.</p>
<div id= "#Functions##GetCountryName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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>Name of the country. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetDesc" ><strong>CLIENT:GetDesc()</strong></a></h2>
</div>
<p>Returns Identifiable descriptor.</p>
<p>Descriptor type depends on Identifiable category.</p>
<div id= "#Functions##GetDesc" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
<h2><strong>Return values:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="DCS.html##(Object.Desc)">DCS#Object.Desc</a>:</p>
</div>
<div class="w3-half">
<p>The Identifiable descriptor.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetName" ><strong>CLIENT:GetName()</strong></a></h2>
</div>
<p>Returns DCS Identifiable object name.</p>
<p>The function provides access to non-activated objects too.</p>
<div id= "#Functions##GetName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
<h2><strong>Return values:</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 name of the DCS Identifiable.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetThreatLevel" ><strong>CLIENT:GetThreatLevel()</strong></a></h2>
</div>
<div id= "#Functions##GetThreatLevel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetTypeName" ><strong>CLIENT:GetTypeName()</strong></a></h2>
</div>
<p>Returns the type name of the DCS Identifiable.</p>
<div id= "#Functions##GetTypeName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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 type name of the DCS Identifiable.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).HasAttribute" ><strong>CLIENT:HasAttribute(AttributeName)</strong></a></h2>
</div>
<p>Check if the Object has the attribute.</p>
<div id= "#Functions##HasAttribute" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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>AttributeName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The attribute 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>true if the attribute exists.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).IsAlive" ><strong>CLIENT:IsAlive()</strong></a></h2>
</div>
<p>Returns if the Identifiable is alive.</p>
<p>If the Identifiable is not alive, nil is returned. <br/>
If the Identifiable is alive, true is returned. </p>
<div id= "#Functions##IsAlive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</a></p>
</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>true if Identifiable is alive.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>if the Identifiable is not existing or is not alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).New" ><strong>CLIENT:New(IdentifiableName)</strong></a></h2>
</div>
<p>Create a new IDENTIFIABLE from a DCSIdentifiable</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="Wrapper.Identifiable.html##(IDENTIFIABLE)">Wrapper.Identifiable#IDENTIFIABLE</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>IdentifiableName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The DCS Identifiable 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><a href="##(IDENTIFIABLE)">#IDENTIFIABLE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).Destroy" ><strong>CLIENT:Destroy()</strong></a></h2>
</div>
<p>Destroys the OBJECT.</p>
<div id= "#Functions##Destroy" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a></p>
</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>true if the object is destroyed.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>The DCS Unit is not existing or alive. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).GetID" ><strong>CLIENT:GetID()</strong></a></h2>
</div>
<p>Returns the unit's unique identifier.</p>
<div id= "#Functions##GetID" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Wrapper.Object.html##(OBJECT)">Wrapper.Object#OBJECT</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="DCS.html##(Object.ID)">DCS#Object.ID</a>:</p>
</div>
<div class="w3-half">
<p>ObjectID or #nil if the DCS Object is not existing or alive. Note that the ID is passed as a string and not a number. </p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).New" ><strong>CLIENT:New(ObjectName, Test)</strong></a></h2>
</div>
<p>Create a new OBJECT from a DCSObject</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="Wrapper.Object.html##(OBJECT)">Wrapper.Object#OBJECT</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##(Object)">DCS#Object</a>
<strong><strong>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Object name</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Test</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="##(OBJECT)">#OBJECT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).AliveCheckScheduler" ><strong>CLIENT.AliveCheckScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientAlive2" ><strong>CLIENT.ClientAlive2</strong></a>
<p> Alive2.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientBriefing" ><strong>CLIENT.ClientBriefing</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientBriefingShown" ><strong>CLIENT.ClientBriefingShown</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientCallBack" ><strong>CLIENT.ClientCallBack</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupID" ><strong>CLIENT.ClientGroupID</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientGroupName" ><strong>CLIENT.ClientGroupName</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientName" ><strong>CLIENT.ClientName</strong></a>
<p> Set client name.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CLIENT).ClientParameters" ><strong>CLIENT.ClientParameters</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).ClientTransport" ><strong>CLIENT.ClientTransport</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#boolean
<a id="#(CLIENT).MessageSwitch" ><strong>CLIENT.MessageSwitch</strong></a>
<p> Message switch.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT).Players" ><strong>CLIENT.Players</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CLIENT)._Menus" ><strong>CLIENT._Menus</strong></a>
</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="#(CLIENT).ClearState" ><strong>CLIENT: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="#(CLIENT).CreateEventBirth" ><strong>CLIENT: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="#(CLIENT).CreateEventCrash" ><strong>CLIENT:CreateEventCrash(EventTime, Initiator)</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>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).CreateEventDead" ><strong>CLIENT:CreateEventDead(EventTime, Initiator)</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>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).CreateEventPlayerEnterAircraft" ><strong>CLIENT: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="#(CLIENT).CreateEventRemoveUnit" ><strong>CLIENT: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="#(CLIENT).CreateEventTakeoff" ><strong>CLIENT: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="#(CLIENT).E" ><strong>CLIENT: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="#(CLIENT).EventDispatcher" ><strong>CLIENT: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="#(CLIENT).EventRemoveAll" ><strong>CLIENT: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="#(CLIENT).F" ><strong>CLIENT: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="#(CLIENT).F2" ><strong>CLIENT: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="#(CLIENT).F3" ><strong>CLIENT: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="#(CLIENT).GetClassID" ><strong>CLIENT: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="#(CLIENT).GetClassName" ><strong>CLIENT: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="#(CLIENT).GetClassNameAndID" ><strong>CLIENT: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="#(CLIENT).GetEventPriority" ><strong>CLIENT:GetEventPriority()</strong></a></h2>
</div>
<p>Get the Class <a href="Event.html">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="Event.html">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="#(CLIENT).GetParent" ><strong>CLIENT: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="#(CLIENT).GetState" ><strong>CLIENT: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="#(CLIENT).HandleEvent" ><strong>CLIENT: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="#(CLIENT).I" ><strong>CLIENT: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="#(CLIENT).Inherit" ><strong>CLIENT: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="#(CLIENT).IsInstanceOf" ><strong>CLIENT: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="#(CLIENT).IsTrace" ><strong>CLIENT: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="#(CLIENT).New" ><strong>CLIENT: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="#(CLIENT).OnEvent" ><strong>CLIENT:OnEvent(EventData)</strong></a></h2>
</div>
<p>Occurs when an object is completely destroyed.</p>
<p>initiator : The unit that is was destroyed.</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="#(CLIENT).OnEventBDA" ><strong>CLIENT:OnEventBDA(EventData)</strong></a></h2>
</div>
<p>BDA.</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="#(CLIENT).OnEventBaseCaptured" ><strong>CLIENT:OnEventBaseCaptured(EventData)</strong></a></h2>
</div>
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
<p>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="#(CLIENT).OnEventBirth" ><strong>CLIENT:OnEventBirth(EventData)</strong></a></h2>
</div>
<p>Occurs when any object is spawned into the mission.</p>
<p>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="#(CLIENT).OnEventCrash" ><strong>CLIENT:OnEventCrash(EventData)</strong></a></h2>
</div>
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
<p>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="#(CLIENT).OnEventDead" ><strong>CLIENT:OnEventDead(EventData)</strong></a></h2>
</div>
<p>Occurs when an object is dead.</p>
<p>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="#(CLIENT).OnEventDetailedFailure" ><strong>CLIENT: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="#(CLIENT).OnEventDiscardChairAfterEjection" ><strong>CLIENT:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
</div>
<p>Discard chair after ejection.</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="#(CLIENT).OnEventEjection" ><strong>CLIENT:OnEventEjection(EventData)</strong></a></h2>
</div>
<p>Occurs when a pilot ejects from an aircraft
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="#(CLIENT).OnEventEngineShutdown" ><strong>CLIENT:OnEventEngineShutdown(EventData)</strong></a></h2>
</div>
<p>Occurs when any aircraft shuts down its engines.</p>
<p>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="#(CLIENT).OnEventEngineStartup" ><strong>CLIENT:OnEventEngineStartup(EventData)</strong></a></h2>
</div>
<p>Occurs when any aircraft starts its engines.</p>
<p>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="#(CLIENT).OnEventHit" ><strong>CLIENT:OnEventHit(EventData)</strong></a></h2>
</div>
<p>Occurs whenever an object is hit by a weapon.</p>
<p>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="#(CLIENT).OnEventHumanFailure" ><strong>CLIENT:OnEventHumanFailure(EventData)</strong></a></h2>
</div>
<p>Occurs when any system fails on a human controlled aircraft.</p>
<p>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="#(CLIENT).OnEventKill" ><strong>CLIENT: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.</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="#(CLIENT).OnEventLand" ><strong>CLIENT:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed.</p>
<p>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="#(CLIENT).OnEventLandingAfterEjection" ><strong>CLIENT: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.</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="#(CLIENT).OnEventLandingQualityMark" ><strong>CLIENT:OnEventLandingQualityMark(EventData)</strong></a></h2>
</div>
<p>Landing quality mark.</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="#(CLIENT).OnEventMarkAdded" ><strong>CLIENT:OnEventMarkAdded(EventData)</strong></a></h2>
</div>
<p>Occurs when a new mark was added.</p>
<p>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="#(CLIENT).OnEventMarkChange" ><strong>CLIENT:OnEventMarkChange(EventData)</strong></a></h2>
</div>
<p>Occurs when a mark text was changed.</p>
<p>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="#(CLIENT).OnEventMarkRemoved" ><strong>CLIENT:OnEventMarkRemoved(EventData)</strong></a></h2>
</div>
<p>Occurs when a mark was removed.</p>
<p>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="#(CLIENT).OnEventMissionEnd" ><strong>CLIENT:OnEventMissionEnd(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission ends.</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="#(CLIENT).OnEventMissionStart" ><strong>CLIENT:OnEventMissionStart(EventData)</strong></a></h2>
</div>
<p>Occurs when a mission starts.</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="#(CLIENT).OnEventParatrooperLanding" ><strong>CLIENT: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.</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="#(CLIENT).OnEventPilotDead" ><strong>CLIENT: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.
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="#(CLIENT).OnEventPlayerEnterAircraft" ><strong>CLIENT:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
</div>
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
<p><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="#(CLIENT).OnEventPlayerEnterUnit" ><strong>CLIENT:OnEventPlayerEnterUnit(EventData)</strong></a></h2>
</div>
<p>Occurs when any player assumes direct control of a unit.</p>
<p>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="#(CLIENT).OnEventPlayerLeaveUnit" ><strong>CLIENT:OnEventPlayerLeaveUnit(EventData)</strong></a></h2>
</div>
<p>Occurs when any player relieves control of a unit to the AI.</p>
<p>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="#(CLIENT).OnEventRefueling" ><strong>CLIENT:OnEventRefueling(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
<p>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="#(CLIENT).OnEventRefuelingStop" ><strong>CLIENT:OnEventRefuelingStop(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft is finished taking fuel.</p>
<p>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="#(CLIENT).OnEventScore" ><strong>CLIENT: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.</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="#(CLIENT).OnEventShootingEnd" ><strong>CLIENT: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.
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="#(CLIENT).OnEventShootingStart" ><strong>CLIENT: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), auto cannons, and machine guns.
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="#(CLIENT).OnEventShot" ><strong>CLIENT: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 auto cannon based weapon, those are handled by EVENT.ShootingStart.</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="#(CLIENT).OnEventTakeoff" ><strong>CLIENT:OnEventTakeoff(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
<p>initiator : The unit that took off.
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="#(CLIENT).OnEventTriggerZone" ><strong>CLIENT:OnEventTriggerZone(EventData)</strong></a></h2>
</div>
<p>Trigger zone.</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="#(CLIENT).OnEventUnitLost" ><strong>CLIENT:OnEventUnitLost(EventData)</strong></a></h2>
</div>
<p>Occurs when the game thinks an object is destroyed.</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="#(CLIENT).ScheduleOnce" ><strong>CLIENT: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>
#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>#number:</p>
</div>
<div class="w3-half">
<p>The ScheduleID 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="#(CLIENT).ScheduleRepeat" ><strong>CLIENT: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>#number:</p>
</div>
<div class="w3-half">
<p>The ScheduleID 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="#(CLIENT).ScheduleStop" ><strong>CLIENT:ScheduleStop(SchedulerFunction)</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>
#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>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).SetEventPriority" ><strong>CLIENT:SetEventPriority(EventPriority)</strong></a></h2>
</div>
<p>Set the Class <a href="Event.html">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="Event.html">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="#(CLIENT).SetState" ><strong>CLIENT: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="#(CLIENT).T" ><strong>CLIENT: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="#(CLIENT).T2" ><strong>CLIENT: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="#(CLIENT).T3" ><strong>CLIENT: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="#(CLIENT).TraceAll" ><strong>CLIENT: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="#(CLIENT).TraceClass" ><strong>CLIENT: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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TraceClassMethod" ><strong>CLIENT: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></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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CLIENT).TraceLevel" ><strong>CLIENT: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="#(CLIENT).TraceOff" ><strong>CLIENT: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="#(CLIENT).TraceOn" ><strong>CLIENT: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="#(CLIENT).TraceOnOff" ><strong>CLIENT: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="#(CLIENT).UnHandleEvent" ><strong>CLIENT: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="#(CLIENT)._F" ><strong>CLIENT:_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="#(CLIENT)._T" ><strong>CLIENT:_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="#(CLIENT).onEvent" ><strong>CLIENT:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure.
- The main event handling function... This function captures all events generated for the class.
@param #BASE self
@param DCS#Event 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>
<strong><strong>event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script>
function myLoadFunction() {
document.getElementById("myHeader").style.backgroundImage = "url('../Images/Wrapper_Client.JPG')";
}
</script>
</div>
<script>
function w3_open() {
document.getElementsByClassName("w3-sidenav")[0].style.width = "95vw";
document.getElementsByClassName("w3-sidenav")[0].style.maxWidth = "1400px";
document.getElementsByClassName("w3-sidenav")[0].style.display = "block";
}
function w3_close() {
document.getElementsByClassName("w3-sidenav")[0].style.display = "none";
}
function myFunction(id) {
var x = document.getElementById(id);
if (x.className.indexOf("w3-show") == -1) {
x.className += " w3-show";
} else {
x.className = x.className.replace(" w3-show", "");
}
}
</script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink