MOOSE_DOCS/Documentation/Core.Set.html
FlightControl b20fa48c68 Clean
2018-10-20 12:42:00 +02:00

52462 lines
1.7 MiB

<!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_Air_To_Air_Dispatching.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A.html">AI.AI_A2A</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 operations 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_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_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> -- (R2.4) - 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> -- (R2.4) - 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_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> -- (R2.4) - Models the intelligent transportation of infantry (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_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> -- (R2.4) - 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> -- (2.4) - 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_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> -- (R2.4) - Models the intelligent transportation of infantry (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/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>Core</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_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_Radio.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Radio.html">Core.Radio</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Is responsible for everything that is related to radio transmission and you can hear in DCS, be it TACAN beacons, 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_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 new statics in your 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_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_Userflag.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserFlag.html">Core.UserFlag</a></strong></h2></div>
</div>
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
<p><strong>Core</strong> - Manage user flags to interact with the mission editor trigger system and server side scripts.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/Core_Usersound.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserSound.html">Core.UserSound</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 sound.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<div class="w3-card-4 w3-white w3-margin-16">
<div class="w3-display-container w3-text-white w3-text-shadow">
<img src= "../Images/MOOSE.JPG" alt="Image">
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="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>DCS API prototypes
See <a href="https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation">https://wiki.hoggitworld.com/view/Simulator_Scripting_Engine_Documentation</a>
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/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/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/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/MOOSE.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/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="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,
which are excellent tools to be reused in an OO environment!.</p>
</p></div>
</div>
</div>
<div class="w3-col s12 m6 l4">
<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/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\Core_Sets.JPG" alt="Banner Image"/>
<div id="content">
<div class="w3-container w3-theme-d5" id="module_title">
<h1>Module <strong>Core.Set</strong></h1>
</div>
<div class="w3-container w3-white" id="module_description">
<p><strong>Core</strong> - Define collections of objects to perform bulk actions and logically group objects.</p>
<hr/>
<h2>Features:</h2>
<ul>
<li>Dynamically maintain collections of objects.</li>
<li>Manually modify the collection, by adding or removing objects.</li>
<li>Collections of different types.</li>
<li>Validate the presence of objects in the collection.</li>
<li>Perform bulk actions on collection.</li>
</ul>
<hr/>
<p>Group objects or data of the same type into a collection, which is either:</p>
<ul>
<li>Manually managed using the <strong>:Add...()</strong> or <strong>:Remove...()</strong> methods. The initial SET can be filtered with the **<a href="##(SET_BASE).FilterOnce">SET_BASE.FilterOnce</a>()** method.</li>
<li>Dynamically updated when new objects are created or objects are destroyed using the **<a href="##(SET_BASE).FilterStart">SET_BASE.FilterStart</a>()** method.</li>
</ul>
<p>Various types of SET_ classes are available:</p>
<ul>
<li><a href="##(SET_GROUP)">#SET_GROUP</a>: Defines a collection of <a href="Wrapper.Group.html">Wrapper.Group</a>s filtered by filter criteria.</li>
<li><a href="##(SET_UNIT)">#SET_UNIT</a>: Defines a colleciton of <a href="Wrapper.Unit.html">Wrapper.Unit</a>s filtered by filter criteria.</li>
<li><a href="##(SET_STATIC)">#SET_STATIC</a>: Defines a collection of <a href="Wrapper.Static.html">Wrapper.Static</a>s filtered by filter criteria.</li>
<li><a href="##(SET_CLIENT)">#SET_CLIENT</a>: Defines a collection of <a href="Client.html">Client</a>s filterd by filter criteria.</li>
<li><a href="##(SET_AIRBASE)">#SET_AIRBASE</a>: Defines a collection of <a href="Wrapper.Airbase.html">Wrapper.Airbase</a>s filtered by filter criteria.</li>
<li><a href="##(SET_CARGO)">#SET_CARGO</a>: Defines a collection of <a href="Cargo.Cargo.html">Cargo.Cargo</a>s filtered by filter criteria.</li>
<li><a href="##(SET_ZONE)">#SET_ZONE</a>: Defines a collection of <a href="Core.Zone.html">Core.Zone</a>s filtered by filter criteria.</li>
</ul>
<p>These classes are derived from <a href="##(SET_BASE)">#SET_BASE</a>, which contains the main methods to manage the collections.</p>
<p>A multitude of other methods are available in the individual set classes that allow to:</p>
<ul>
<li>Validate the presence of objects in the SET.</li>
<li>Trigger events when objects in the SET change a zone presence.</li>
</ul>
<hr/>
<h3>Author: <strong>FlightControl</strong></h3>
<h3>Contributions:</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##SET_AIRBASE')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_AIRBASE</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_AIRBASE)">Core.Set#SET_AIRBASE</a> class to build sets of airbases optionally belonging to certain:</p>
<ul>
<li>Coalitions</li>
</ul>
<h2>SET_AIRBASE constructor</h2>
<p>Create a new SET_AIRBASE object with the <a href="##(SET_AIRBASE).New">SET_AIRBASE.New</a> method:</p>
<ul>
<li><a href="##(SET_AIRBASE).New">SET_AIRBASE.New</a>: Creates a new SET_AIRBASE object.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_AIRBASE" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_AIRBASE)">#SET_AIRBASE</a>
<a id="SET_AIRBASE" ><strong>SET_AIRBASE</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_AIRBASE)">Core.Set#SET_AIRBASE</a> class to build sets of airbases optionally belonging to certain:</p>
<ul>
<li>Coalitions</li>
</ul>
<h2>SET_AIRBASE constructor</h2>
<p>Create a new SET_AIRBASE object with the <a href="##(SET_AIRBASE).New">SET_AIRBASE.New</a> method:</p>
<ul>
<li><a href="##(SET_AIRBASE).New">SET_AIRBASE.New</a>: Creates a new SET_AIRBASE object.</li>
</ul>
<p> </p>
<h2>Add or Remove AIRBASEs from SET_AIRBASE</h2>
<p>AIRBASEs can be added and removed using the <a href="Core.Set.html##(SET_AIRBASE).AddAirbasesByName">Core.Set#SET_AIRBASE.AddAirbasesByName</a> and <a href="Core.Set.html##(SET_AIRBASE).RemoveAirbasesByName">Core.Set#SET_AIRBASE.RemoveAirbasesByName</a> respectively.
These methods take a single AIRBASE name or an array of AIRBASE names to be added or removed from SET_AIRBASE.</p>
<h2>SET_AIRBASE filter criteria</h2>
<p>You can set filter criteria to define the set of clients within the SET_AIRBASE.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_AIRBASE).FilterCoalitions">SET_AIRBASE.FilterCoalitions</a>: Builds the SET_AIRBASE with the airbases belonging to the coalition(s).</li>
</ul>
<p>Once the filter criteria have been set for the SET_AIRBASE, you can start filtering using:</p>
<ul>
<li><a href="##(SET_AIRBASE).FilterStart">SET_AIRBASE.FilterStart</a>: Starts the filtering of the airbases within the SET_AIRBASE.</li>
</ul>
<h2>SET_AIRBASE iterators</h2>
<p>Once the filters have been defined and the SET_AIRBASE has been built, you can iterate the SET_AIRBASE with the available iterator methods.
The iterator methods will walk the SET_AIRBASE set, and call for each airbase within the set a function that you provide.
The following iterator methods are currently available within the SET_AIRBASE:</p>
<ul>
<li><a href="##(SET_AIRBASE).ForEachAirbase">SET_AIRBASE.ForEachAirbase</a>: Calls a function for each airbase it finds within the SET_AIRBASE.</li>
</ul>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_BASE')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_BASE</strong></h2></p></td>
<td class="style="width:60%;">
<p>The <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> class defines the core functions that define a collection of objects.</p>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_BASE" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_BASE)">#SET_BASE</a>
<a id="SET_BASE" ><strong>SET_BASE</strong></a>
<p>The <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> class defines the core functions that define a collection of objects.</p>
<p>A SET provides iterators to iterate the SET, but will <strong>temporarily</strong> yield the ForEach interator loop at defined <strong>"intervals"</strong> to the mail simulator loop.
In this way, large loops can be done while not blocking the simulator main processing loop.
The default <strong>"yield interval"</strong> is after 10 objects processed.
The default <strong>"time interval"</strong> is after 0.001 seconds.</p>
<h2>Add or remove objects from the SET</h2>
<p>Some key core functions are <a href="Core.Set.html##(SET_BASE).Add">Core.Set#SET_BASE.Add</a> and <a href="Core.Set.html##(SET_BASE).Remove">Core.Set#SET_BASE.Remove</a> to add or remove objects from the SET in your logic.</p>
<h2>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong></h2>
<p>Modify the iterator intervals with the <a href="Core.Set.html##(SET_BASE).SetInteratorIntervals">Core.Set#SET_BASE.SetInteratorIntervals</a> method.
You can set the <strong>"yield interval"</strong>, and the <strong>"time interval"</strong>. (See above).</p>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_CARGO')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_CARGO</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_CARGO)">Core.Set#SET_CARGO</a> class to build sets of cargos optionally belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Types</li>
<li>Name or Prefix</li>
</ul>
<h2>SET_CARGO constructor</h2>
<p>Create a new SET_CARGO object with the <a href="##(SET_CARGO).New">SET_CARGO.New</a> method:</p>
<ul>
<li><a href="##(SET_CARGO).New">SET_CARGO.New</a>: Creates a new SET_CARGO object.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_CARGO" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_CARGO)">#SET_CARGO</a>
<a id="SET_CARGO" ><strong>SET_CARGO</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_CARGO)">Core.Set#SET_CARGO</a> class to build sets of cargos optionally belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Types</li>
<li>Name or Prefix</li>
</ul>
<h2>SET_CARGO constructor</h2>
<p>Create a new SET_CARGO object with the <a href="##(SET_CARGO).New">SET_CARGO.New</a> method:</p>
<ul>
<li><a href="##(SET_CARGO).New">SET_CARGO.New</a>: Creates a new SET_CARGO object.</li>
</ul>
<p> </p>
<h2>Add or Remove CARGOs from SET_CARGO</h2>
<p>CARGOs can be added and removed using the <a href="Core.Set.html##(SET_CARGO).AddCargosByName">Core.Set#SET_CARGO.AddCargosByName</a> and <a href="Core.Set.html##(SET_CARGO).RemoveCargosByName">Core.Set#SET_CARGO.RemoveCargosByName</a> respectively.
These methods take a single CARGO name or an array of CARGO names to be added or removed from SET_CARGO.</p>
<h2>SET_CARGO filter criteria</h2>
<p>You can set filter criteria to automatically maintain the SET_CARGO contents.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_CARGO).FilterCoalitions">SET_CARGO.FilterCoalitions</a>: Builds the SET_CARGO with the cargos belonging to the coalition(s).</li>
<li><a href="##(SET_CARGO).FilterPrefixes">SET_CARGO.FilterPrefixes</a>: Builds the SET_CARGO with the cargos containing the prefix string(s).</li>
<li><a href="##(SET_CARGO).FilterTypes">SET_CARGO.FilterTypes</a>: Builds the SET_CARGO with the cargos belonging to the cargo type(s).</li>
<li><a href="##(SET_CARGO).FilterCountries">SET_CARGO.FilterCountries</a>: Builds the SET_CARGO with the cargos belonging to the country(ies).</li>
</ul>
<p>Once the filter criteria have been set for the SET_CARGO, you can start filtering using:</p>
<ul>
<li><a href="##(SET_CARGO).FilterStart">SET_CARGO.FilterStart</a>: Starts the filtering of the cargos within the SET_CARGO.</li>
</ul>
<h2>SET_CARGO iterators</h2>
<p>Once the filters have been defined and the SET_CARGO has been built, you can iterate the SET_CARGO with the available iterator methods.
The iterator methods will walk the SET_CARGO set, and call for each cargo within the set a function that you provide.
The following iterator methods are currently available within the SET_CARGO:</p>
<ul>
<li><a href="##(SET_CARGO).ForEachCargo">SET_CARGO.ForEachCargo</a>: Calls a function for each cargo it finds within the SET_CARGO.</li>
</ul>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_CLIENT')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_CLIENT</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a> class to build sets of units belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Client types</li>
<li>Starting with certain prefix strings.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_CLIENT" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_CLIENT)">#SET_CLIENT</a>
<a id="SET_CLIENT" ><strong>SET_CLIENT</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a> class to build sets of units belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Client types</li>
<li>Starting with certain prefix strings.</li>
</ul>
<p> </p>
<h2>1) SET_CLIENT constructor</h2>
<p>Create a new SET_CLIENT object with the <a href="##(SET_CLIENT).New">SET_CLIENT.New</a> method:</p>
<ul>
<li><a href="##(SET_CLIENT).New">SET_CLIENT.New</a>: Creates a new SET_CLIENT object.</li>
</ul>
<h2>2) Add or Remove CLIENT(s) from SET_CLIENT</h2>
<p>CLIENTs can be added and removed using the <a href="Core.Set.html##(SET_CLIENT).AddClientsByName">Core.Set#SET_CLIENT.AddClientsByName</a> and <a href="Core.Set.html##(SET_CLIENT).RemoveClientsByName">Core.Set#SET_CLIENT.RemoveClientsByName</a> respectively.
These methods take a single CLIENT name or an array of CLIENT names to be added or removed from SET_CLIENT.</p>
<h2>3) SET_CLIENT filter criteria</h2>
<p>You can set filter criteria to define the set of clients within the SET_CLIENT.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_CLIENT).FilterCoalitions">SET_CLIENT.FilterCoalitions</a>: Builds the SET_CLIENT with the clients belonging to the coalition(s).</li>
<li><a href="##(SET_CLIENT).FilterCategories">SET_CLIENT.FilterCategories</a>: Builds the SET_CLIENT with the clients belonging to the category(ies).</li>
<li><a href="##(SET_CLIENT).FilterTypes">SET_CLIENT.FilterTypes</a>: Builds the SET_CLIENT with the clients belonging to the client type(s).</li>
<li><a href="##(SET_CLIENT).FilterCountries">SET_CLIENT.FilterCountries</a>: Builds the SET_CLIENT with the clients belonging to the country(ies).</li>
<li><a href="##(SET_CLIENT).FilterPrefixes">SET_CLIENT.FilterPrefixes</a>: Builds the SET_CLIENT with the clients starting with the same prefix string(s).</li>
<li><a href="##(SET_CLIENT).FilterActive">SET_CLIENT.FilterActive</a>: Builds the SET_CLIENT with the units that are only active. Units that are inactive (late activation) won't be included in the set!</li>
</ul>
<p>Once the filter criteria have been set for the SET_CLIENT, you can start filtering using:</p>
<ul>
<li><a href="##(SET_CLIENT).FilterStart">SET_CLIENT.FilterStart</a>: Starts the filtering of the clients <strong>dynamically</strong>.</li>
<li><a href="##(SET_CLIENT).FilterOnce">SET_CLIENT.FilterOnce</a>: Filters the clients <strong>once</strong>.</li>
</ul>
<p>Planned filter criteria within development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_CLIENT).FilterZones">SET_CLIENT.FilterZones</a>: Builds the SET_CLIENT with the clients within a <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>.</li>
</ul>
<h2>4) SET_CLIENT iterators</h2>
<p>Once the filters have been defined and the SET_CLIENT has been built, you can iterate the SET_CLIENT with the available iterator methods.
The iterator methods will walk the SET_CLIENT set, and call for each element within the set a function that you provide.
The following iterator methods are currently available within the SET_CLIENT:</p>
<ul>
<li><a href="##(SET_CLIENT).ForEachClient">SET_CLIENT.ForEachClient</a>: Calls a function for each alive client it finds within the SET_CLIENT.</li>
</ul>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_GROUP')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_GROUP</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> class to build sets of groups belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Starting with certain prefix strings.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_GROUP" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_GROUP)">#SET_GROUP</a>
<a id="SET_GROUP" ><strong>SET_GROUP</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> class to build sets of groups belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Starting with certain prefix strings.</li>
</ul>
<p> </p>
<h2>SET_GROUP constructor</h2>
<p>Create a new SET_GROUP object with the <a href="##(SET_GROUP).New">SET_GROUP.New</a> method:</p>
<ul>
<li><a href="##(SET_GROUP).New">SET_GROUP.New</a>: Creates a new SET_GROUP object.</li>
</ul>
<h2>Add or Remove GROUP(s) from SET_GROUP</h2>
<p>GROUPS can be added and removed using the <a href="Core.Set.html##(SET_GROUP).AddGroupsByName">Core.Set#SET_GROUP.AddGroupsByName</a> and <a href="Core.Set.html##(SET_GROUP).RemoveGroupsByName">Core.Set#SET_GROUP.RemoveGroupsByName</a> respectively.
These methods take a single GROUP name or an array of GROUP names to be added or removed from SET_GROUP.</p>
<h2>SET_GROUP filter criteria</h2>
<p>You can set filter criteria to define the set of groups within the SET_GROUP.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_GROUP).FilterCoalitions">SET_GROUP.FilterCoalitions</a>: Builds the SET_GROUP with the groups belonging to the coalition(s).</li>
<li><a href="##(SET_GROUP).FilterCategories">SET_GROUP.FilterCategories</a>: Builds the SET_GROUP with the groups belonging to the category(ies).</li>
<li><a href="##(SET_GROUP).FilterCountries">SET_GROUP.FilterCountries</a>: Builds the SET_GROUP with the gruops belonging to the country(ies).</li>
<li><a href="##(SET_GROUP).FilterPrefixes">SET_GROUP.FilterPrefixes</a>: Builds the SET_GROUP with the groups starting with the same prefix string(s).</li>
<li><a href="##(SET_GROUP).FilterActive">SET_GROUP.FilterActive</a>: Builds the SET_GROUP with the groups that are only active. Groups that are inactive (late activation) won't be included in the set!</li>
</ul>
<p>For the Category Filter, extra methods have been added:</p>
<ul>
<li><a href="##(SET_GROUP).FilterCategoryAirplane">SET_GROUP.FilterCategoryAirplane</a>: Builds the SET_GROUP from airplanes.</li>
<li><a href="##(SET_GROUP).FilterCategoryHelicopter">SET_GROUP.FilterCategoryHelicopter</a>: Builds the SET_GROUP from helicopters.</li>
<li><a href="##(SET_GROUP).FilterCategoryGround">SET_GROUP.FilterCategoryGround</a>: Builds the SET_GROUP from ground vehicles or infantry.</li>
<li><a href="##(SET_GROUP).FilterCategoryShip">SET_GROUP.FilterCategoryShip</a>: Builds the SET_GROUP from ships.</li>
<li><a href="##(SET_GROUP).FilterCategoryStructure">SET_GROUP.FilterCategoryStructure</a>: Builds the SET_GROUP from structures.</li>
</ul>
<p>Once the filter criteria have been set for the SET_GROUP, you can start filtering using:</p>
<ul>
<li><a href="##(SET_GROUP).FilterStart">SET_GROUP.FilterStart</a>: Starts the filtering of the groups within the SET_GROUP and add or remove GROUP objects <strong>dynamically</strong>.</li>
<li><a href="##(SET_GROUP).FilterOnce">SET_GROUP.FilterOnce</a>: Filters of the groups <strong>once</strong>.</li>
</ul>
<p>Planned filter criteria within development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_GROUP).FilterZones">SET_GROUP.FilterZones</a>: Builds the SET_GROUP with the groups within a <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>.</li>
</ul>
<h2>SET_GROUP iterators</h2>
<p>Once the filters have been defined and the SET_GROUP has been built, you can iterate the SET_GROUP with the available iterator methods.
The iterator methods will walk the SET_GROUP set, and call for each element within the set a function that you provide.
The following iterator methods are currently available within the SET_GROUP:</p>
<ul>
<li><a href="##(SET_GROUP).ForEachGroup">SET_GROUP.ForEachGroup</a>: Calls a function for each alive group it finds within the SET_GROUP.</li>
<li><a href="##(SET_GROUP).ForEachGroupCompletelyInZone">SET_GROUP.ForEachGroupCompletelyInZone</a>: Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence completely in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</li>
<li><a href="##(SET_GROUP).ForEachGroupPartlyInZone">SET_GROUP.ForEachGroupPartlyInZone</a>: Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence partly in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</li>
<li><a href="##(SET_GROUP).ForEachGroupNotInZone">SET_GROUP.ForEachGroupNotInZone</a>: Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence not in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</li>
</ul>
<h2>SET_GROUP trigger events on the GROUP objects.</h2>
<p>The SET is derived from the FSM class, which provides extra capabilities to track the contents of the GROUP objects in the SET_GROUP.</p>
<h3>When a GROUP object crashes or is dead, the SET_GROUP will trigger a <strong>Dead</strong> event.</h3>
<p>You can handle the event using the OnBefore and OnAfter event handlers.
The event handlers need to have the paramters From, Event, To, GroupObject.
The GroupObject is the GROUP object that is dead and within the SET_GROUP, and is passed as a parameter to the event handler.
See the following example:</p>
<pre><code> -- Create the SetCarrier SET_GROUP collection.
local SetHelicopter = SET_GROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
-- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
function SetHelicopter:OnAfterDead( From, Event, To, GroupObject )
self:F( { GroupObject = GroupObject:GetName() } )
end
</code></pre>
<p>While this is a good example, there is a catch.
Imageine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method.
So, the self would need to contain another object. Fortunately, this can be done, but you must use then the <strong><code>.</code></strong> notation for the method.
See the modified example:</p>
<pre><code> -- Now we have a constructor of the class AI_CARGO_DISPATCHER, that receives the SetHelicopter as a parameter.
-- Within that constructor, we want to set an enclosed event handler OnAfterDead for SetHelicopter.
-- But within the OnAfterDead method, we want to refer to the self variable of the AI_CARGO_DISPATCHER.
function AI_CARGO_DISPATCHER:New( SetCarrier, SetCargo, SetDeployZones )
local self = BASE:Inherit( self, FSM:New() ) -- #AI_CARGO_DISPATCHER
-- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
-- Note the "." notation, and the explicit declaration of SetHelicopter, which would be using the ":" notation the implicit self variable declaration.
function SetHelicopter.OnAfterDead( SetHelicopter, From, Event, To, GroupObject )
SetHelicopter:F( { GroupObject = GroupObject:GetName() } )
self.PickupCargo[GroupObject] = nil -- So here I clear the PickupCargo table entry of the self object AI_CARGO_DISPATCHER.
self.CarrierHome[GroupObject] = nil
end
end
</code></pre>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_PLAYER')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_PLAYER</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_PLAYER)">Core.Set#SET_PLAYER</a> class to build sets of units belonging to alive players:</p>
<h2>SET_PLAYER constructor</h2>
<p>Create a new SET_PLAYER object with the <a href="##(SET_PLAYER).New">SET_PLAYER.New</a> method:</p>
<ul>
<li><a href="##(SET_PLAYER).New">SET_PLAYER.New</a>: Creates a new SET_PLAYER object.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_PLAYER" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_PLAYER)">#SET_PLAYER</a>
<a id="SET_PLAYER" ><strong>SET_PLAYER</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_PLAYER)">Core.Set#SET_PLAYER</a> class to build sets of units belonging to alive players:</p>
<h2>SET_PLAYER constructor</h2>
<p>Create a new SET_PLAYER object with the <a href="##(SET_PLAYER).New">SET_PLAYER.New</a> method:</p>
<ul>
<li><a href="##(SET_PLAYER).New">SET_PLAYER.New</a>: Creates a new SET_PLAYER object.</li>
</ul>
<p> </p>
<h2>SET_PLAYER filter criteria</h2>
<p>You can set filter criteria to define the set of clients within the SET_PLAYER.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_PLAYER).FilterCoalitions">SET_PLAYER.FilterCoalitions</a>: Builds the SET_PLAYER with the clients belonging to the coalition(s).</li>
<li><a href="##(SET_PLAYER).FilterCategories">SET_PLAYER.FilterCategories</a>: Builds the SET_PLAYER with the clients belonging to the category(ies).</li>
<li><a href="##(SET_PLAYER).FilterTypes">SET_PLAYER.FilterTypes</a>: Builds the SET_PLAYER with the clients belonging to the client type(s).</li>
<li><a href="##(SET_PLAYER).FilterCountries">SET_PLAYER.FilterCountries</a>: Builds the SET_PLAYER with the clients belonging to the country(ies).</li>
<li><a href="##(SET_PLAYER).FilterPrefixes">SET_PLAYER.FilterPrefixes</a>: Builds the SET_PLAYER with the clients starting with the same prefix string(s).</li>
</ul>
<p>Once the filter criteria have been set for the SET_PLAYER, you can start filtering using:</p>
<ul>
<li><a href="##(SET_PLAYER).FilterStart">SET_PLAYER.FilterStart</a>: Starts the filtering of the clients within the SET_PLAYER.</li>
</ul>
<p>Planned filter criteria within development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_PLAYER).FilterZones">SET_PLAYER.FilterZones</a>: Builds the SET_PLAYER with the clients within a <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>.</li>
</ul>
<h2>SET_PLAYER iterators</h2>
<p>Once the filters have been defined and the SET_PLAYER has been built, you can iterate the SET_PLAYER with the available iterator methods.
The iterator methods will walk the SET_PLAYER set, and call for each element within the set a function that you provide.
The following iterator methods are currently available within the SET_PLAYER:</p>
<ul>
<li><a href="##(SET_PLAYER).ForEachClient">SET_PLAYER.ForEachClient</a>: Calls a function for each alive client it finds within the SET_PLAYER.</li>
</ul>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_STATIC')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_STATIC</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Static types</li>
<li>Starting with certain prefix strings.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_STATIC" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_STATIC)">#SET_STATIC</a>
<a id="SET_STATIC" ><strong>SET_STATIC</strong></a>
<p>Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Static types</li>
<li>Starting with certain prefix strings.</li>
</ul>
<p> </p>
<h2>SET_STATIC constructor</h2>
<p>Create a new SET_STATIC object with the <a href="##(SET_STATIC).New">SET_STATIC.New</a> method:</p>
<ul>
<li><a href="##(SET_STATIC).New">SET_STATIC.New</a>: Creates a new SET_STATIC object.</li>
</ul>
<h2>Add or Remove STATIC(s) from SET_STATIC</h2>
<p>STATICs can be added and removed using the <a href="Core.Set.html##(SET_STATIC).AddStaticsByName">Core.Set#SET_STATIC.AddStaticsByName</a> and <a href="Core.Set.html##(SET_STATIC).RemoveStaticsByName">Core.Set#SET_STATIC.RemoveStaticsByName</a> respectively.
These methods take a single STATIC name or an array of STATIC names to be added or removed from SET_STATIC.</p>
<h2>SET_STATIC filter criteria</h2>
<p>You can set filter criteria to define the set of units within the SET_STATIC.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_STATIC).FilterCoalitions">SET_STATIC.FilterCoalitions</a>: Builds the SET_STATIC with the units belonging to the coalition(s).</li>
<li><a href="##(SET_STATIC).FilterCategories">SET_STATIC.FilterCategories</a>: Builds the SET_STATIC with the units belonging to the category(ies).</li>
<li><a href="##(SET_STATIC).FilterTypes">SET_STATIC.FilterTypes</a>: Builds the SET_STATIC with the units belonging to the unit type(s).</li>
<li><a href="##(SET_STATIC).FilterCountries">SET_STATIC.FilterCountries</a>: Builds the SET_STATIC with the units belonging to the country(ies).</li>
<li><a href="##(SET_STATIC).FilterPrefixes">SET_STATIC.FilterPrefixes</a>: Builds the SET_STATIC with the units starting with the same prefix string(s).</li>
</ul>
<p>Once the filter criteria have been set for the SET_STATIC, you can start filtering using:</p>
<ul>
<li><a href="##(SET_STATIC).FilterStart">SET_STATIC.FilterStart</a>: Starts the filtering of the units within the SET_STATIC.</li>
</ul>
<p>Planned filter criteria within development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_STATIC).FilterZones">SET_STATIC.FilterZones</a>: Builds the SET_STATIC with the units within a <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>.</li>
</ul>
<h2>SET_STATIC iterators</h2>
<p>Once the filters have been defined and the SET_STATIC has been built, you can iterate the SET_STATIC with the available iterator methods.
The iterator methods will walk the SET_STATIC set, and call for each element within the set a function that you provide.
The following iterator methods are currently available within the SET_STATIC:</p>
<ul>
<li><a href="##(SET_STATIC).ForEachStatic">SET_STATIC.ForEachStatic</a>: Calls a function for each alive unit it finds within the SET_STATIC.</li>
<li><a href="##(SET_GROUP).ForEachGroupCompletelyInZone">SET_GROUP.ForEachGroupCompletelyInZone</a>: Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence completely in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</li>
<li><a href="##(SET_GROUP).ForEachGroupNotInZone">SET_GROUP.ForEachGroupNotInZone</a>: Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence not in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</li>
</ul>
<p>Planned iterators methods in development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_STATIC).ForEachStaticInZone">SET_STATIC.ForEachStaticInZone</a>: Calls a function for each unit contained within the SET_STATIC.</li>
<li><a href="##(SET_STATIC).ForEachStaticCompletelyInZone">SET_STATIC.ForEachStaticCompletelyInZone</a>: Iterate and call an iterator function for each <strong>alive</strong> STATIC presence completely in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</li>
<li><a href="##(SET_STATIC).ForEachStaticNotInZone">SET_STATIC.ForEachStaticNotInZone</a>: Iterate and call an iterator function for each <strong>alive</strong> STATIC presence not in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</li>
</ul>
<h2>SET_STATIC atomic methods</h2>
<p>Various methods exist for a SET_STATIC to perform actions or calculations and retrieve results from the SET_STATIC:</p>
<ul>
<li><a href="##(SET_STATIC).GetTypeNames">SET_STATIC.GetTypeNames</a>(): Retrieve the type names of the <a href="Static.html">Static</a>s in the SET, delimited by a comma.</li>
</ul>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_UNIT')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_UNIT</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the SET_UNIT class to build sets of units belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Unit types</li>
<li>Starting with certain prefix strings.</li>
</ul>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_UNIT" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_UNIT)">#SET_UNIT</a>
<a id="SET_UNIT" ><strong>SET_UNIT</strong></a>
<p>Mission designers can use the SET_UNIT class to build sets of units belonging to certain:</p>
<ul>
<li>Coalitions</li>
<li>Categories</li>
<li>Countries</li>
<li>Unit types</li>
<li>Starting with certain prefix strings.</li>
</ul>
<p> </p>
<h2>1) SET_UNIT constructor</h2>
<p>Create a new SET_UNIT object with the <a href="##(SET_UNIT).New">SET_UNIT.New</a> method:</p>
<ul>
<li><a href="##(SET_UNIT).New">SET_UNIT.New</a>: Creates a new SET_UNIT object.</li>
</ul>
<h2>2) Add or Remove UNIT(s) from SET_UNIT</h2>
<p>UNITs can be added and removed using the <a href="Core.Set.html##(SET_UNIT).AddUnitsByName">Core.Set#SET_UNIT.AddUnitsByName</a> and <a href="Core.Set.html##(SET_UNIT).RemoveUnitsByName">Core.Set#SET_UNIT.RemoveUnitsByName</a> respectively.
These methods take a single UNIT name or an array of UNIT names to be added or removed from SET_UNIT.</p>
<h2>3) SET_UNIT filter criteria</h2>
<p>You can set filter criteria to define the set of units within the SET_UNIT.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_UNIT).FilterCoalitions">SET_UNIT.FilterCoalitions</a>: Builds the SET_UNIT with the units belonging to the coalition(s).</li>
<li><a href="##(SET_UNIT).FilterCategories">SET_UNIT.FilterCategories</a>: Builds the SET_UNIT with the units belonging to the category(ies).</li>
<li><a href="##(SET_UNIT).FilterTypes">SET_UNIT.FilterTypes</a>: Builds the SET_UNIT with the units belonging to the unit type(s).</li>
<li><a href="##(SET_UNIT).FilterCountries">SET_UNIT.FilterCountries</a>: Builds the SET_UNIT with the units belonging to the country(ies).</li>
<li><a href="##(SET_UNIT).FilterPrefixes">SET_UNIT.FilterPrefixes</a>: Builds the SET_UNIT with the units starting with the same prefix string(s).</li>
<li><a href="##(SET_UNIT).FilterActive">SET_UNIT.FilterActive</a>: Builds the SET_UNIT with the units that are only active. Units that are inactive (late activation) won't be included in the set!</li>
</ul>
<p>Once the filter criteria have been set for the SET_UNIT, you can start filtering using:</p>
<ul>
<li><a href="##(SET_UNIT).FilterStart">SET_UNIT.FilterStart</a>: Starts the filtering of the units <strong>dynamically</strong>.</li>
<li><a href="##(SET_UNIT).FilterOnce">SET_UNIT.FilterOnce</a>: Filters of the units <strong>once</strong>.</li>
</ul>
<p>Planned filter criteria within development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_UNIT).FilterZones">SET_UNIT.FilterZones</a>: Builds the SET_UNIT with the units within a <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>.</li>
</ul>
<h2>4) SET_UNIT iterators</h2>
<p>Once the filters have been defined and the SET_UNIT has been built, you can iterate the SET_UNIT with the available iterator methods.
The iterator methods will walk the SET_UNIT set, and call for each element within the set a function that you provide.
The following iterator methods are currently available within the SET_UNIT:</p>
<ul>
<li><a href="##(SET_UNIT).ForEachUnit">SET_UNIT.ForEachUnit</a>: Calls a function for each alive unit it finds within the SET_UNIT.</li>
<li><a href="##(SET_UNIT).ForEachUnitInZone">SET_UNIT.ForEachUnitInZone</a>: Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT object presence completely in a <a href="Zone.html">Zone</a>, providing the UNIT object and optional parameters to the called function.</li>
<li><a href="##(SET_UNIT).ForEachUnitNotInZone">SET_UNIT.ForEachUnitNotInZone</a>: Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT object presence not in a <a href="Zone.html">Zone</a>, providing the UNIT object and optional parameters to the called function.</li>
</ul>
<p>Planned iterators methods in development are (so these are not yet available):</p>
<ul>
<li><a href="##(SET_UNIT).ForEachUnitInUnit">SET_UNIT.ForEachUnitInUnit</a>: Calls a function for each unit contained within the SET_UNIT.</li>
<li><a href="##(SET_UNIT).ForEachUnitCompletelyInZone">SET_UNIT.ForEachUnitCompletelyInZone</a>: Iterate and call an iterator function for each <strong>alive</strong> UNIT presence completely in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</li>
<li><a href="##(SET_UNIT).ForEachUnitNotInZone">SET_UNIT.ForEachUnitNotInZone</a>: Iterate and call an iterator function for each <strong>alive</strong> UNIT presence not in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</li>
</ul>
<h2>5) SET_UNIT atomic methods</h2>
<p>Various methods exist for a SET_UNIT to perform actions or calculations and retrieve results from the SET_UNIT:</p>
<ul>
<li><a href="##(SET_UNIT).GetTypeNames">SET_UNIT.GetTypeNames</a>(): Retrieve the type names of the <a href="Wrapper.Unit.html">Wrapper.Unit</a>s in the SET, delimited by a comma.</li>
</ul>
<h2>6) SET_UNIT trigger events on the UNIT objects.</h2>
<p>The SET is derived from the FSM class, which provides extra capabilities to track the contents of the UNIT objects in the SET_UNIT.</p>
<h3>6.1) When a UNIT object crashes or is dead, the SET_UNIT will trigger a <strong>Dead</strong> event.</h3>
<p>You can handle the event using the OnBefore and OnAfter event handlers.
The event handlers need to have the paramters From, Event, To, GroupObject.
The GroupObject is the UNIT object that is dead and within the SET_UNIT, and is passed as a parameter to the event handler.
See the following example:</p>
<pre><code> -- Create the SetCarrier SET_UNIT collection.
local SetHelicopter = SET_UNIT:New():FilterPrefixes( "Helicopter" ):FilterStart()
-- Put a Dead event handler on SetCarrier, to ensure that when a carrier unit is destroyed, that all internal parameters are reset.
function SetHelicopter:OnAfterDead( From, Event, To, UnitObject )
self:F( { UnitObject = UnitObject:GetName() } )
end
</code></pre>
<p>While this is a good example, there is a catch.
Imageine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method.
So, the self would need to contain another object. Fortunately, this can be done, but you must use then the <strong><code>.</code></strong> notation for the method.
See the modified example:</p>
<pre><code> -- Now we have a constructor of the class AI_CARGO_DISPATCHER, that receives the SetHelicopter as a parameter.
-- Within that constructor, we want to set an enclosed event handler OnAfterDead for SetHelicopter.
-- But within the OnAfterDead method, we want to refer to the self variable of the AI_CARGO_DISPATCHER.
function ACLASS:New( SetCarrier, SetCargo, SetDeployZones )
local self = BASE:Inherit( self, FSM:New() ) -- #AI_CARGO_DISPATCHER
-- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
-- Note the "." notation, and the explicit declaration of SetHelicopter, which would be using the ":" notation the implicit self variable declaration.
function SetHelicopter.OnAfterDead( SetHelicopter, From, Event, To, UnitObject )
SetHelicopter:F( { UnitObject = UnitObject:GetName() } )
self.array[UnitObject] = nil -- So here I clear the array table entry of the self object ACLASS.
end
end
</code></pre>
<hr/>
</div>
</div>
<div class="w3-theme-d2 w3-margin-top ">
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##SET_ZONE')">
<tr>
<td class="style="width:40%;"><p><h2>Global <strong>SET_ZONE</strong></h2></p></td>
<td class="style="width:60%;">
<p>Mission designers can use the <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> class to build sets of zones of various types.</p>
</td>
</tr>
</table>
</div>
<div id= "#Globals##SET_ZONE" class="w3-container w3-white w3-padding-small">
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="##(SET_ZONE)">#SET_ZONE</a>
<a id="SET_ZONE" ><strong>SET_ZONE</strong></a>
<p>Mission designers can use the <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> class to build sets of zones of various types.</p>
<h2>SET_ZONE constructor</h2>
<p>Create a new SET_ZONE object with the <a href="##(SET_ZONE).New">SET_ZONE.New</a> method:</p>
<ul>
<li><a href="##(SET_ZONE).New">SET_ZONE.New</a>: Creates a new SET_ZONE object.</li>
</ul>
<h2>Add or Remove ZONEs from SET_ZONE</h2>
<p>ZONEs can be added and removed using the <a href="Core.Set.html##(SET_ZONE).AddZonesByName">Core.Set#SET_ZONE.AddZonesByName</a> and <a href="Core.Set.html##(SET_ZONE).RemoveZonesByName">Core.Set#SET_ZONE.RemoveZonesByName</a> respectively.
These methods take a single ZONE name or an array of ZONE names to be added or removed from SET_ZONE.</p>
<h2>SET_ZONE filter criteria</h2>
<p>You can set filter criteria to build the collection of zones in SET_ZONE.
Filter criteria are defined by:</p>
<ul>
<li><a href="##(SET_ZONE).FilterPrefixes">SET_ZONE.FilterPrefixes</a>: Builds the SET_ZONE with the zones having a certain text pattern of prefix.</li>
</ul>
<p>Once the filter criteria have been set for the SET_ZONE, you can start filtering using:</p>
<ul>
<li><a href="##(SET_ZONE).FilterStart">SET_ZONE.FilterStart</a>: Starts the filtering of the zones within the SET_ZONE.</li>
</ul>
<h2>SET_ZONE iterators</h2>
<p>Once the filters have been defined and the SET_ZONE has been built, you can iterate the SET_ZONE with the available iterator methods.
The iterator methods will walk the SET_ZONE set, and call for each airbase within the set a function that you provide.
The following iterator methods are currently available within the SET_ZONE:</p>
<ul>
<li><a href="##(SET_ZONE).ForEachZone">SET_ZONE.ForEachZone</a>: Calls a function for each zone it finds within the SET_ZONE.</li>
</ul>
<hr/>
</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="#(SET_AIRBASE)">Type <strong>SET_AIRBASE</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_AIRBASE)">SET_AIRBASE</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_AIRBASE</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="##(SET_AIRBASE).AddAirbase">SET_AIRBASE:AddAirbase(airbase)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add an AIRBASE object to SET_AIRBASE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).AddAirbasesByName">SET_AIRBASE:AddAirbasesByName(AddAirbaseNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add AIRBASEs to SET_AIRBASE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).AddInDatabase">SET_AIRBASE:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterCategories">SET_AIRBASE:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of airbases out of categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterCoalitions">SET_AIRBASE:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of airbases of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterStart">SET_AIRBASE:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FindAirbase">SET_AIRBASE:FindAirbase(AirbaseName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Airbase based on the Airbase Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FindAirbaseInRange">SET_AIRBASE:FindAirbaseInRange(Coordinate, Range)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an Airbase in range of a coordinate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FindInDatabase">SET_AIRBASE:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FindNearestAirbaseFromPointVec2">SET_AIRBASE:FindNearestAirbaseFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_AIRBASE while identifying the nearest <a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a> from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).ForEachAirbase">SET_AIRBASE:ForEachAirbase(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_AIRBASE and call an interator function for each AIRBASE, providing the AIRBASE and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetRandomAirbase">SET_AIRBASE:GetRandomAirbase()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a random Airbase in the set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).IsIncludeObject">SET_AIRBASE:IsIncludeObject(MAirbase)</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="##(SET_AIRBASE).New">SET_AIRBASE:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_AIRBASE object, building a set of airbases belonging to a coalitions and categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).OnEventBaseCaptured">SET_AIRBASE:OnEventBaseCaptured(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).RemoveAirbasesByName">SET_AIRBASE:RemoveAirbasesByName(RemoveAirbaseNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove AIRBASEs from SET_AIRBASE.</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 SET_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="##(SET_AIRBASE).Add">SET_AIRBASE:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).AddObject">SET_AIRBASE:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).CallScheduler">SET_AIRBASE.CallScheduler</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="##(SET_AIRBASE).Count">SET_AIRBASE:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).Database">SET_AIRBASE.Database</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="##(SET_AIRBASE).Filter">SET_AIRBASE.Filter</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="##(SET_AIRBASE).FilterCrashes">SET_AIRBASE:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterDeads">SET_AIRBASE:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterOnce">SET_AIRBASE:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FilterStop">SET_AIRBASE:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).FindNearestObjectFromPointVec2">SET_AIRBASE:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).Flush">SET_AIRBASE:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).ForEach">SET_AIRBASE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).Get">SET_AIRBASE:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetFirst">SET_AIRBASE:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetLast">SET_AIRBASE:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetObjectNames">SET_AIRBASE:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetRandom">SET_AIRBASE:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetSet">SET_AIRBASE:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetSetNames">SET_AIRBASE:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).GetSetObjects">SET_AIRBASE:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).IsIncludeObject">SET_AIRBASE:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).List">SET_AIRBASE.List</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="##(SET_AIRBASE).New">SET_AIRBASE:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).OnAfterAdded">SET_AIRBASE:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).OnAfterRemoved">SET_AIRBASE:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).Remove">SET_AIRBASE:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).Set">SET_AIRBASE.Set</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="##(SET_AIRBASE).SetDatabase">SET_AIRBASE:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).SetIteratorIntervals">SET_AIRBASE:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).TimeInterval">SET_AIRBASE.TimeInterval</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="##(SET_AIRBASE).YieldInterval">SET_AIRBASE.YieldInterval</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="##(SET_AIRBASE)._EventOnBirth">SET_AIRBASE:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE)._EventOnDeadOrCrash">SET_AIRBASE:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE)._FilterStart">SET_AIRBASE:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE)._Find">SET_AIRBASE:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_AIRBASE).ClassID">SET_AIRBASE.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="##(SET_AIRBASE).ClassName">SET_AIRBASE.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="##(SET_AIRBASE).ClassNameAndID">SET_AIRBASE.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="##(SET_AIRBASE).ClearState">SET_AIRBASE: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="##(SET_AIRBASE).CreateEventBirth">SET_AIRBASE: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="##(SET_AIRBASE).CreateEventCrash">SET_AIRBASE: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="##(SET_AIRBASE).CreateEventDead">SET_AIRBASE: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="##(SET_AIRBASE).CreateEventRemoveUnit">SET_AIRBASE: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="##(SET_AIRBASE).CreateEventTakeoff">SET_AIRBASE: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="##(SET_AIRBASE).E">SET_AIRBASE: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="##(SET_AIRBASE).EventDispatcher">SET_AIRBASE: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="##(SET_AIRBASE).EventRemoveAll">SET_AIRBASE: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="##(SET_AIRBASE).F">SET_AIRBASE: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="##(SET_AIRBASE).F2">SET_AIRBASE: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="##(SET_AIRBASE).F3">SET_AIRBASE: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="##(SET_AIRBASE).GetClassID">SET_AIRBASE: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="##(SET_AIRBASE).GetClassName">SET_AIRBASE: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="##(SET_AIRBASE).GetClassNameAndID">SET_AIRBASE: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="##(SET_AIRBASE).GetEventPriority">SET_AIRBASE: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="##(SET_AIRBASE).GetParent">SET_AIRBASE: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="##(SET_AIRBASE).GetState">SET_AIRBASE: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="##(SET_AIRBASE).HandleEvent">SET_AIRBASE:HandleEvent(Event, 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="##(SET_AIRBASE).I">SET_AIRBASE: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="##(SET_AIRBASE).Inherit">SET_AIRBASE: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="##(SET_AIRBASE).IsInstanceOf">SET_AIRBASE: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="##(SET_AIRBASE).IsTrace">SET_AIRBASE: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="##(SET_AIRBASE).New">SET_AIRBASE: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="##(SET_AIRBASE).OnEvent">SET_AIRBASE: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="##(SET_AIRBASE).OnEventBaseCaptured">SET_AIRBASE: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="##(SET_AIRBASE).OnEventBirth">SET_AIRBASE: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="##(SET_AIRBASE).OnEventCrash">SET_AIRBASE: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="##(SET_AIRBASE).OnEventDead">SET_AIRBASE: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="##(SET_AIRBASE).OnEventEjection">SET_AIRBASE: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="##(SET_AIRBASE).OnEventEngineShutdown">SET_AIRBASE: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="##(SET_AIRBASE).OnEventEngineStartup">SET_AIRBASE: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="##(SET_AIRBASE).OnEventHit">SET_AIRBASE: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="##(SET_AIRBASE).OnEventHumanFailure">SET_AIRBASE: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="##(SET_AIRBASE).OnEventLand">SET_AIRBASE: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_AIRBASE).OnEventMissionEnd">SET_AIRBASE: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="##(SET_AIRBASE).OnEventMissionStart">SET_AIRBASE: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="##(SET_AIRBASE).OnEventPilotDead">SET_AIRBASE: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="##(SET_AIRBASE).OnEventPlayerEnterUnit">SET_AIRBASE: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="##(SET_AIRBASE).OnEventPlayerLeaveUnit">SET_AIRBASE: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="##(SET_AIRBASE).OnEventRefueling">SET_AIRBASE: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="##(SET_AIRBASE).OnEventRefuelingStop">SET_AIRBASE: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="##(SET_AIRBASE).OnEventShootingEnd">SET_AIRBASE: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="##(SET_AIRBASE).OnEventShootingStart">SET_AIRBASE: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="##(SET_AIRBASE).OnEventShot">SET_AIRBASE: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="##(SET_AIRBASE).OnEventTakeoff">SET_AIRBASE: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="##(SET_AIRBASE).ScheduleOnce">SET_AIRBASE: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="##(SET_AIRBASE).ScheduleRepeat">SET_AIRBASE: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="##(SET_AIRBASE).ScheduleStop">SET_AIRBASE: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="##(SET_AIRBASE).Scheduler">SET_AIRBASE.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="##(SET_AIRBASE).SetEventPriority">SET_AIRBASE: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="##(SET_AIRBASE).SetState">SET_AIRBASE: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="##(SET_AIRBASE).T">SET_AIRBASE: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="##(SET_AIRBASE).T2">SET_AIRBASE: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="##(SET_AIRBASE).T3">SET_AIRBASE: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="##(SET_AIRBASE).TraceAll">SET_AIRBASE: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="##(SET_AIRBASE).TraceClass">SET_AIRBASE: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="##(SET_AIRBASE).TraceClassMethod">SET_AIRBASE: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="##(SET_AIRBASE).TraceLevel">SET_AIRBASE: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="##(SET_AIRBASE).TraceOnOff">SET_AIRBASE: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="##(SET_AIRBASE).UnHandleEvent">SET_AIRBASE:UnHandleEvent(Event)</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="##(SET_AIRBASE)._">SET_AIRBASE._</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="##(SET_AIRBASE)._F">SET_AIRBASE:_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="##(SET_AIRBASE)._T">SET_AIRBASE:_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="##(SET_AIRBASE).__">SET_AIRBASE.__</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="##(SET_AIRBASE).onEvent">SET_AIRBASE: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="#(SET_BASE)">Type <strong>SET_BASE</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_BASE)">SET_BASE</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 SET_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="##(SET_BASE).Add">SET_BASE:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).AddObject">SET_BASE:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).CallScheduler">SET_BASE.CallScheduler</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="##(SET_BASE).Count">SET_BASE:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).Database">SET_BASE.Database</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="##(SET_BASE).Filter">SET_BASE.Filter</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="##(SET_BASE).FilterCrashes">SET_BASE:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).FilterDeads">SET_BASE:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).FilterOnce">SET_BASE:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).FilterStop">SET_BASE:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).FindNearestObjectFromPointVec2">SET_BASE:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).Flush">SET_BASE:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).ForEach">SET_BASE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).Get">SET_BASE:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetFirst">SET_BASE:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetLast">SET_BASE:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetObjectNames">SET_BASE:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetRandom">SET_BASE:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetSet">SET_BASE:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetSetNames">SET_BASE:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).GetSetObjects">SET_BASE:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).IsIncludeObject">SET_BASE:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).List">SET_BASE.List</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="##(SET_BASE).New">SET_BASE:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).OnAfterAdded">SET_BASE:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).OnAfterRemoved">SET_BASE:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).Remove">SET_BASE:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).Set">SET_BASE.Set</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="##(SET_BASE).SetDatabase">SET_BASE:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).SetIteratorIntervals">SET_BASE:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).TimeInterval">SET_BASE.TimeInterval</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="##(SET_BASE).YieldInterval">SET_BASE.YieldInterval</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="##(SET_BASE)._EventOnBirth">SET_BASE:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE)._EventOnDeadOrCrash">SET_BASE:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE)._FilterStart">SET_BASE:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE)._Find">SET_BASE:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_BASE).ClassID">SET_BASE.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="##(SET_BASE).ClassName">SET_BASE.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="##(SET_BASE).ClassNameAndID">SET_BASE.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="##(SET_BASE).ClearState">SET_BASE: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="##(SET_BASE).CreateEventBirth">SET_BASE: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="##(SET_BASE).CreateEventCrash">SET_BASE: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="##(SET_BASE).CreateEventDead">SET_BASE: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="##(SET_BASE).CreateEventRemoveUnit">SET_BASE: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="##(SET_BASE).CreateEventTakeoff">SET_BASE: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="##(SET_BASE).E">SET_BASE: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="##(SET_BASE).EventDispatcher">SET_BASE: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="##(SET_BASE).EventRemoveAll">SET_BASE: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="##(SET_BASE).F">SET_BASE: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="##(SET_BASE).F2">SET_BASE: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="##(SET_BASE).F3">SET_BASE: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="##(SET_BASE).GetClassID">SET_BASE: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="##(SET_BASE).GetClassName">SET_BASE: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="##(SET_BASE).GetClassNameAndID">SET_BASE: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="##(SET_BASE).GetEventPriority">SET_BASE: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="##(SET_BASE).GetParent">SET_BASE: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="##(SET_BASE).GetState">SET_BASE: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="##(SET_BASE).HandleEvent">SET_BASE:HandleEvent(Event, 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="##(SET_BASE).I">SET_BASE: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="##(SET_BASE).Inherit">SET_BASE: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="##(SET_BASE).IsInstanceOf">SET_BASE: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="##(SET_BASE).IsTrace">SET_BASE: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="##(SET_BASE).New">SET_BASE: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="##(SET_BASE).OnEvent">SET_BASE: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="##(SET_BASE).OnEventBaseCaptured">SET_BASE: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="##(SET_BASE).OnEventBirth">SET_BASE: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="##(SET_BASE).OnEventCrash">SET_BASE: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="##(SET_BASE).OnEventDead">SET_BASE: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="##(SET_BASE).OnEventEjection">SET_BASE: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="##(SET_BASE).OnEventEngineShutdown">SET_BASE: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="##(SET_BASE).OnEventEngineStartup">SET_BASE: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="##(SET_BASE).OnEventHit">SET_BASE: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="##(SET_BASE).OnEventHumanFailure">SET_BASE: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="##(SET_BASE).OnEventLand">SET_BASE: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_BASE).OnEventMissionEnd">SET_BASE: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="##(SET_BASE).OnEventMissionStart">SET_BASE: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="##(SET_BASE).OnEventPilotDead">SET_BASE: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="##(SET_BASE).OnEventPlayerEnterUnit">SET_BASE: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="##(SET_BASE).OnEventPlayerLeaveUnit">SET_BASE: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="##(SET_BASE).OnEventRefueling">SET_BASE: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="##(SET_BASE).OnEventRefuelingStop">SET_BASE: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="##(SET_BASE).OnEventShootingEnd">SET_BASE: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="##(SET_BASE).OnEventShootingStart">SET_BASE: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="##(SET_BASE).OnEventShot">SET_BASE: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="##(SET_BASE).OnEventTakeoff">SET_BASE: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="##(SET_BASE).ScheduleOnce">SET_BASE: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="##(SET_BASE).ScheduleRepeat">SET_BASE: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="##(SET_BASE).ScheduleStop">SET_BASE: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="##(SET_BASE).Scheduler">SET_BASE.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="##(SET_BASE).SetEventPriority">SET_BASE: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="##(SET_BASE).SetState">SET_BASE: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="##(SET_BASE).T">SET_BASE: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="##(SET_BASE).T2">SET_BASE: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="##(SET_BASE).T3">SET_BASE: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="##(SET_BASE).TraceAll">SET_BASE: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="##(SET_BASE).TraceClass">SET_BASE: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="##(SET_BASE).TraceClassMethod">SET_BASE: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="##(SET_BASE).TraceLevel">SET_BASE: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="##(SET_BASE).TraceOnOff">SET_BASE: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="##(SET_BASE).UnHandleEvent">SET_BASE:UnHandleEvent(Event)</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="##(SET_BASE)._">SET_BASE._</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="##(SET_BASE)._F">SET_BASE:_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="##(SET_BASE)._T">SET_BASE:_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="##(SET_BASE).__">SET_BASE.__</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="##(SET_BASE).onEvent">SET_BASE: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="#(SET_CARGO)">Type <strong>SET_CARGO</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_CARGO)">SET_CARGO</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_CARGO</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="##(SET_CARGO).AddCargo">SET_CARGO:AddCargo(Cargo)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Add CARGO to SET_CARGO.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).AddCargosByName">SET_CARGO:AddCargosByName(AddCargoNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Add CARGOs to SET_CARGO.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).AddInDatabase">SET_CARGO:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterCoalitions">SET_CARGO:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Builds a set of cargos of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterCountries">SET_CARGO:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Builds a set of cargos of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterPrefixes">SET_CARGO:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Builds a set of cargos of defined cargo prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterStart">SET_CARGO:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterStop">SET_CARGO:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterTypes">SET_CARGO:FilterTypes(Types)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Builds a set of cargos of defined cargo types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FindCargo">SET_CARGO:FindCargo(CargoName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Finds a Cargo based on the Cargo Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FindInDatabase">SET_CARGO:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FindNearestCargoFromPointVec2">SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Iterate the SET_CARGO while identifying the nearest <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FirstCargoDeployed">SET_CARGO:FirstCargoDeployed()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is Deployed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FirstCargoLoaded">SET_CARGO:FirstCargoLoaded()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is Loaded.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FirstCargoUnLoaded">SET_CARGO:FirstCargoUnLoaded()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is UnLoaded.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FirstCargoUnLoadedAndNotDeployed">SET_CARGO:FirstCargoUnLoadedAndNotDeployed()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is UnLoaded and not Deployed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FirstCargoWithState">SET_CARGO:FirstCargoWithState(State)</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="##(SET_CARGO).FirstCargoWithStateAndNotDeployed">SET_CARGO:FirstCargoWithStateAndNotDeployed(State)</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="##(SET_CARGO).ForEachCargo">SET_CARGO:ForEachCargo(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).IsIncludeObject">SET_CARGO:IsIncludeObject(MCargo)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) </p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).New">SET_CARGO:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).OnEventDeleteCargo">SET_CARGO:OnEventDeleteCargo(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).OnEventNewCargo">SET_CARGO:OnEventNewCargo(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Handles the OnEventNewCargo event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).RemoveCargosByName">SET_CARGO:RemoveCargosByName(RemoveCargoNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(R2.1) Remove CARGOs from SET_CARGO.</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 SET_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="##(SET_CARGO).Add">SET_CARGO:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).AddObject">SET_CARGO:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).CallScheduler">SET_CARGO.CallScheduler</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="##(SET_CARGO).Count">SET_CARGO:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).Database">SET_CARGO.Database</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="##(SET_CARGO).Filter">SET_CARGO.Filter</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="##(SET_CARGO).FilterCrashes">SET_CARGO:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterDeads">SET_CARGO:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterOnce">SET_CARGO:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FilterStop">SET_CARGO:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).FindNearestObjectFromPointVec2">SET_CARGO:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).Flush">SET_CARGO:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).ForEach">SET_CARGO:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).Get">SET_CARGO:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetFirst">SET_CARGO:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetLast">SET_CARGO:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetObjectNames">SET_CARGO:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetRandom">SET_CARGO:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetSet">SET_CARGO:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetSetNames">SET_CARGO:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).GetSetObjects">SET_CARGO:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).IsIncludeObject">SET_CARGO:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).List">SET_CARGO.List</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="##(SET_CARGO).New">SET_CARGO:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).OnAfterAdded">SET_CARGO:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).OnAfterRemoved">SET_CARGO:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).Remove">SET_CARGO:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).Set">SET_CARGO.Set</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="##(SET_CARGO).SetDatabase">SET_CARGO:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).SetIteratorIntervals">SET_CARGO:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).TimeInterval">SET_CARGO.TimeInterval</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="##(SET_CARGO).YieldInterval">SET_CARGO.YieldInterval</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="##(SET_CARGO)._EventOnBirth">SET_CARGO:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO)._EventOnDeadOrCrash">SET_CARGO:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO)._FilterStart">SET_CARGO:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO)._Find">SET_CARGO:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_CARGO).ClassID">SET_CARGO.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="##(SET_CARGO).ClassName">SET_CARGO.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="##(SET_CARGO).ClassNameAndID">SET_CARGO.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="##(SET_CARGO).ClearState">SET_CARGO: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="##(SET_CARGO).CreateEventBirth">SET_CARGO: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="##(SET_CARGO).CreateEventCrash">SET_CARGO: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="##(SET_CARGO).CreateEventDead">SET_CARGO: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="##(SET_CARGO).CreateEventRemoveUnit">SET_CARGO: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="##(SET_CARGO).CreateEventTakeoff">SET_CARGO: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="##(SET_CARGO).E">SET_CARGO: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="##(SET_CARGO).EventDispatcher">SET_CARGO: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="##(SET_CARGO).EventRemoveAll">SET_CARGO: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="##(SET_CARGO).F">SET_CARGO: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="##(SET_CARGO).F2">SET_CARGO: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="##(SET_CARGO).F3">SET_CARGO: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="##(SET_CARGO).GetClassID">SET_CARGO: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="##(SET_CARGO).GetClassName">SET_CARGO: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="##(SET_CARGO).GetClassNameAndID">SET_CARGO: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="##(SET_CARGO).GetEventPriority">SET_CARGO: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="##(SET_CARGO).GetParent">SET_CARGO: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="##(SET_CARGO).GetState">SET_CARGO: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="##(SET_CARGO).HandleEvent">SET_CARGO:HandleEvent(Event, 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="##(SET_CARGO).I">SET_CARGO: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="##(SET_CARGO).Inherit">SET_CARGO: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="##(SET_CARGO).IsInstanceOf">SET_CARGO: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="##(SET_CARGO).IsTrace">SET_CARGO: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="##(SET_CARGO).New">SET_CARGO: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="##(SET_CARGO).OnEvent">SET_CARGO: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="##(SET_CARGO).OnEventBaseCaptured">SET_CARGO: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="##(SET_CARGO).OnEventBirth">SET_CARGO: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="##(SET_CARGO).OnEventCrash">SET_CARGO: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="##(SET_CARGO).OnEventDead">SET_CARGO: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="##(SET_CARGO).OnEventEjection">SET_CARGO: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="##(SET_CARGO).OnEventEngineShutdown">SET_CARGO: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="##(SET_CARGO).OnEventEngineStartup">SET_CARGO: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="##(SET_CARGO).OnEventHit">SET_CARGO: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="##(SET_CARGO).OnEventHumanFailure">SET_CARGO: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="##(SET_CARGO).OnEventLand">SET_CARGO: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CARGO).OnEventMissionEnd">SET_CARGO: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="##(SET_CARGO).OnEventMissionStart">SET_CARGO: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="##(SET_CARGO).OnEventPilotDead">SET_CARGO: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="##(SET_CARGO).OnEventPlayerEnterUnit">SET_CARGO: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="##(SET_CARGO).OnEventPlayerLeaveUnit">SET_CARGO: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="##(SET_CARGO).OnEventRefueling">SET_CARGO: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="##(SET_CARGO).OnEventRefuelingStop">SET_CARGO: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="##(SET_CARGO).OnEventShootingEnd">SET_CARGO: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="##(SET_CARGO).OnEventShootingStart">SET_CARGO: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="##(SET_CARGO).OnEventShot">SET_CARGO: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="##(SET_CARGO).OnEventTakeoff">SET_CARGO: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="##(SET_CARGO).ScheduleOnce">SET_CARGO: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="##(SET_CARGO).ScheduleRepeat">SET_CARGO: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="##(SET_CARGO).ScheduleStop">SET_CARGO: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="##(SET_CARGO).Scheduler">SET_CARGO.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="##(SET_CARGO).SetEventPriority">SET_CARGO: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="##(SET_CARGO).SetState">SET_CARGO: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="##(SET_CARGO).T">SET_CARGO: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="##(SET_CARGO).T2">SET_CARGO: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="##(SET_CARGO).T3">SET_CARGO: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="##(SET_CARGO).TraceAll">SET_CARGO: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="##(SET_CARGO).TraceClass">SET_CARGO: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="##(SET_CARGO).TraceClassMethod">SET_CARGO: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="##(SET_CARGO).TraceLevel">SET_CARGO: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="##(SET_CARGO).TraceOnOff">SET_CARGO: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="##(SET_CARGO).UnHandleEvent">SET_CARGO:UnHandleEvent(Event)</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="##(SET_CARGO)._">SET_CARGO._</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="##(SET_CARGO)._F">SET_CARGO:_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="##(SET_CARGO)._T">SET_CARGO:_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="##(SET_CARGO).__">SET_CARGO.__</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="##(SET_CARGO).onEvent">SET_CARGO: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="#(SET_CLIENT)">Type <strong>SET_CLIENT</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_CLIENT)">SET_CLIENT</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_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="##(SET_CLIENT).AddClientsByName">SET_CLIENT:AddClientsByName(AddClientNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add CLIENT(s) to SET_CLIENT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).AddInDatabase">SET_CLIENT:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterActive">SET_CLIENT:FilterActive(Active)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients that are only active.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterCategories">SET_CLIENT:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients out of categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterCoalitions">SET_CLIENT:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterCountries">SET_CLIENT:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterPrefixes">SET_CLIENT:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined client prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterStart">SET_CLIENT:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterTypes">SET_CLIENT:FilterTypes(Types)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined client types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FindClient">SET_CLIENT:FindClient(ClientName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Client based on the Client Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FindInDatabase">SET_CLIENT:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).ForEachClient">SET_CLIENT:ForEachClient(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CLIENT and call an interator function for each <strong>alive</strong> CLIENT, providing the CLIENT and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).ForEachClientInZone">SET_CLIENT:ForEachClientInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CLIENT and call an iterator function for each <strong>alive</strong> CLIENT presence completely in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).ForEachClientNotInZone">SET_CLIENT:ForEachClientNotInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_CLIENT and call an iterator function for each <strong>alive</strong> CLIENT presence not in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).IsIncludeObject">SET_CLIENT:IsIncludeObject(MClient)</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="##(SET_CLIENT).New">SET_CLIENT:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_CLIENT object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).RemoveClientsByName">SET_CLIENT:RemoveClientsByName(RemoveClientNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove CLIENT(s) from SET_CLIENT.</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 SET_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="##(SET_CLIENT).Add">SET_CLIENT:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).AddObject">SET_CLIENT:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).CallScheduler">SET_CLIENT.CallScheduler</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="##(SET_CLIENT).Count">SET_CLIENT:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).Database">SET_CLIENT.Database</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="##(SET_CLIENT).Filter">SET_CLIENT.Filter</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="##(SET_CLIENT).FilterCrashes">SET_CLIENT:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterDeads">SET_CLIENT:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterOnce">SET_CLIENT:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FilterStop">SET_CLIENT:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).FindNearestObjectFromPointVec2">SET_CLIENT:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).Flush">SET_CLIENT:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).ForEach">SET_CLIENT:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).Get">SET_CLIENT:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetFirst">SET_CLIENT:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetLast">SET_CLIENT:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetObjectNames">SET_CLIENT:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetRandom">SET_CLIENT:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetSet">SET_CLIENT:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetSetNames">SET_CLIENT:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).GetSetObjects">SET_CLIENT:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).IsIncludeObject">SET_CLIENT:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).List">SET_CLIENT.List</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="##(SET_CLIENT).New">SET_CLIENT:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).OnAfterAdded">SET_CLIENT:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).OnAfterRemoved">SET_CLIENT:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).Remove">SET_CLIENT:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).Set">SET_CLIENT.Set</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="##(SET_CLIENT).SetDatabase">SET_CLIENT:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).SetIteratorIntervals">SET_CLIENT:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).TimeInterval">SET_CLIENT.TimeInterval</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="##(SET_CLIENT).YieldInterval">SET_CLIENT.YieldInterval</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="##(SET_CLIENT)._EventOnBirth">SET_CLIENT:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT)._EventOnDeadOrCrash">SET_CLIENT:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT)._FilterStart">SET_CLIENT:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT)._Find">SET_CLIENT:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_CLIENT).ClassID">SET_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="##(SET_CLIENT).ClassName">SET_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="##(SET_CLIENT).ClassNameAndID">SET_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="##(SET_CLIENT).ClearState">SET_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="##(SET_CLIENT).CreateEventBirth">SET_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="##(SET_CLIENT).CreateEventCrash">SET_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="##(SET_CLIENT).CreateEventDead">SET_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="##(SET_CLIENT).CreateEventRemoveUnit">SET_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="##(SET_CLIENT).CreateEventTakeoff">SET_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="##(SET_CLIENT).E">SET_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="##(SET_CLIENT).EventDispatcher">SET_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="##(SET_CLIENT).EventRemoveAll">SET_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="##(SET_CLIENT).F">SET_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="##(SET_CLIENT).F2">SET_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="##(SET_CLIENT).F3">SET_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="##(SET_CLIENT).GetClassID">SET_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="##(SET_CLIENT).GetClassName">SET_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="##(SET_CLIENT).GetClassNameAndID">SET_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="##(SET_CLIENT).GetEventPriority">SET_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="##(SET_CLIENT).GetParent">SET_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="##(SET_CLIENT).GetState">SET_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="##(SET_CLIENT).HandleEvent">SET_CLIENT:HandleEvent(Event, 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="##(SET_CLIENT).I">SET_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="##(SET_CLIENT).Inherit">SET_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="##(SET_CLIENT).IsInstanceOf">SET_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="##(SET_CLIENT).IsTrace">SET_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="##(SET_CLIENT).New">SET_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="##(SET_CLIENT).OnEvent">SET_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="##(SET_CLIENT).OnEventBaseCaptured">SET_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="##(SET_CLIENT).OnEventBirth">SET_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="##(SET_CLIENT).OnEventCrash">SET_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="##(SET_CLIENT).OnEventDead">SET_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="##(SET_CLIENT).OnEventEjection">SET_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="##(SET_CLIENT).OnEventEngineShutdown">SET_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="##(SET_CLIENT).OnEventEngineStartup">SET_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="##(SET_CLIENT).OnEventHit">SET_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="##(SET_CLIENT).OnEventHumanFailure">SET_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="##(SET_CLIENT).OnEventLand">SET_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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_CLIENT).OnEventMissionEnd">SET_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="##(SET_CLIENT).OnEventMissionStart">SET_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="##(SET_CLIENT).OnEventPilotDead">SET_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="##(SET_CLIENT).OnEventPlayerEnterUnit">SET_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="##(SET_CLIENT).OnEventPlayerLeaveUnit">SET_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="##(SET_CLIENT).OnEventRefueling">SET_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="##(SET_CLIENT).OnEventRefuelingStop">SET_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="##(SET_CLIENT).OnEventShootingEnd">SET_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="##(SET_CLIENT).OnEventShootingStart">SET_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="##(SET_CLIENT).OnEventShot">SET_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="##(SET_CLIENT).OnEventTakeoff">SET_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="##(SET_CLIENT).ScheduleOnce">SET_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="##(SET_CLIENT).ScheduleRepeat">SET_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="##(SET_CLIENT).ScheduleStop">SET_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="##(SET_CLIENT).Scheduler">SET_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="##(SET_CLIENT).SetEventPriority">SET_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="##(SET_CLIENT).SetState">SET_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="##(SET_CLIENT).T">SET_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="##(SET_CLIENT).T2">SET_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="##(SET_CLIENT).T3">SET_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="##(SET_CLIENT).TraceAll">SET_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="##(SET_CLIENT).TraceClass">SET_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="##(SET_CLIENT).TraceClassMethod">SET_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="##(SET_CLIENT).TraceLevel">SET_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="##(SET_CLIENT).TraceOnOff">SET_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="##(SET_CLIENT).UnHandleEvent">SET_CLIENT:UnHandleEvent(Event)</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="##(SET_CLIENT)._">SET_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="##(SET_CLIENT)._F">SET_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="##(SET_CLIENT)._T">SET_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="##(SET_CLIENT).__">SET_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="##(SET_CLIENT).onEvent">SET_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="#(SET_GROUP)">Type <strong>SET_GROUP</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_GROUP)">SET_GROUP</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_GROUP</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="##(SET_GROUP).AddGroup">SET_GROUP:AddGroup(group)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add a GROUP to SET_GROUP.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AddGroupsByName">SET_GROUP:AddGroupsByName(AddGroupNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add GROUP(s) to SET_GROUP.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AddInDatabase">SET_GROUP:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AllCompletelyInZone">SET_GROUP:AllCompletelyInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and return true if all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completely in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AnyCompletelyInZone">SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and return true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completely inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AnyInZone">SET_GROUP:AnyInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and return true if at least one <a href="##(UNIT)">#UNIT</a> of one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <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="##(SET_GROUP).AnyPartlyInZone">SET_GROUP:AnyPartlyInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and return true if at least one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is partly in <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="##(SET_GROUP).CountInZone">SET_GROUP:CountInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and count how many GROUPs are completely in the Zone
That could easily be done with SET_GROUP:ForEachGroupCompletelyInZone(), but this function
provides an easy to use shortcut...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).CountUnitInZone">SET_GROUP:CountUnitInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and count how many UNITs are completely in the Zone</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterActive">SET_GROUP:FilterActive(Active)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups that are only active.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCategories">SET_GROUP:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out of categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCategoryAirplane">SET_GROUP:FilterCategoryAirplane()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out of airplane category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCategoryGround">SET_GROUP:FilterCategoryGround()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out of ground category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCategoryHelicopter">SET_GROUP:FilterCategoryHelicopter()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out of helicopter category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCategoryShip">SET_GROUP:FilterCategoryShip()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out 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="##(SET_GROUP).FilterCategoryStructure">SET_GROUP:FilterCategoryStructure()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups out of structure category.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCoalitions">SET_GROUP:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterCountries">SET_GROUP:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterPrefixes">SET_GROUP:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of groups of defined GROUP prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterStart">SET_GROUP:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FindGroup">SET_GROUP:FindGroup(GroupName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Group based on the Group Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FindInDatabase">SET_GROUP:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FindNearestGroupFromPointVec2">SET_GROUP:FindNearestGroupFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroup">SET_GROUP:ForEachGroup(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each GROUP object, providing the GROUP and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroupAlive">SET_GROUP:ForEachGroupAlive(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP object, providing the GROUP and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroupAnyInZone">SET_GROUP:ForEachGroupAnyInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each alive GROUP that has any unit in the <a href="Core.Zone.html">Core.Zone</a>, providing the GROUP and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroupCompletelyInZone">SET_GROUP:ForEachGroupCompletelyInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence completely in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroupNotInZone">SET_GROUP:ForEachGroupNotInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence not in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEachGroupPartlyInZone">SET_GROUP:ForEachGroupPartlyInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence partly in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetAliveSet">SET_GROUP:GetAliveSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).IsIncludeObject">SET_GROUP:IsIncludeObject(MGroup)</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="##(SET_GROUP).New">SET_GROUP:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_GROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).NoneInZone">SET_GROUP:NoneInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and return true if no <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a>
This could also be achieved with <code>not SET_GROUP:AnyPartlyInZone(Zone)</code>, but it's easier for the
mission designer to add a dedicated method</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).RemoveGroupsByName">SET_GROUP:RemoveGroupsByName(RemoveGroupNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove GROUP(s) from SET_GROUP.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).SetCargoBayWeightLimit">SET_GROUP:SetCargoBayWeightLimit()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_GROUP and set for each unit the default cargo bay weight limit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP)._EventOnDeadOrCrash">SET_GROUP:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive groups set.</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 SET_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="##(SET_GROUP).Add">SET_GROUP:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).AddObject">SET_GROUP:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).CallScheduler">SET_GROUP.CallScheduler</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="##(SET_GROUP).Count">SET_GROUP:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).Database">SET_GROUP.Database</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="##(SET_GROUP).Filter">SET_GROUP.Filter</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="##(SET_GROUP).FilterCrashes">SET_GROUP:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterDeads">SET_GROUP:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterOnce">SET_GROUP:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FilterStop">SET_GROUP:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).FindNearestObjectFromPointVec2">SET_GROUP:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).Flush">SET_GROUP:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).ForEach">SET_GROUP:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).Get">SET_GROUP:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetFirst">SET_GROUP:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetLast">SET_GROUP:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetObjectNames">SET_GROUP:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetRandom">SET_GROUP:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetSet">SET_GROUP:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetSetNames">SET_GROUP:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).GetSetObjects">SET_GROUP:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).IsIncludeObject">SET_GROUP:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).List">SET_GROUP.List</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="##(SET_GROUP).New">SET_GROUP:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).OnAfterAdded">SET_GROUP:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).OnAfterRemoved">SET_GROUP:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).Remove">SET_GROUP:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).Set">SET_GROUP.Set</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="##(SET_GROUP).SetDatabase">SET_GROUP:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).SetIteratorIntervals">SET_GROUP:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).TimeInterval">SET_GROUP.TimeInterval</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="##(SET_GROUP).YieldInterval">SET_GROUP.YieldInterval</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="##(SET_GROUP)._EventOnBirth">SET_GROUP:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP)._EventOnDeadOrCrash">SET_GROUP:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP)._FilterStart">SET_GROUP:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP)._Find">SET_GROUP:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_GROUP).ClassID">SET_GROUP.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="##(SET_GROUP).ClassName">SET_GROUP.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="##(SET_GROUP).ClassNameAndID">SET_GROUP.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="##(SET_GROUP).ClearState">SET_GROUP: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="##(SET_GROUP).CreateEventBirth">SET_GROUP: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="##(SET_GROUP).CreateEventCrash">SET_GROUP: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="##(SET_GROUP).CreateEventDead">SET_GROUP: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="##(SET_GROUP).CreateEventRemoveUnit">SET_GROUP: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="##(SET_GROUP).CreateEventTakeoff">SET_GROUP: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="##(SET_GROUP).E">SET_GROUP: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="##(SET_GROUP).EventDispatcher">SET_GROUP: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="##(SET_GROUP).EventRemoveAll">SET_GROUP: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="##(SET_GROUP).F">SET_GROUP: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="##(SET_GROUP).F2">SET_GROUP: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="##(SET_GROUP).F3">SET_GROUP: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="##(SET_GROUP).GetClassID">SET_GROUP: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="##(SET_GROUP).GetClassName">SET_GROUP: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="##(SET_GROUP).GetClassNameAndID">SET_GROUP: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="##(SET_GROUP).GetEventPriority">SET_GROUP: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="##(SET_GROUP).GetParent">SET_GROUP: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="##(SET_GROUP).GetState">SET_GROUP: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="##(SET_GROUP).HandleEvent">SET_GROUP:HandleEvent(Event, 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="##(SET_GROUP).I">SET_GROUP: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="##(SET_GROUP).Inherit">SET_GROUP: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="##(SET_GROUP).IsInstanceOf">SET_GROUP: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="##(SET_GROUP).IsTrace">SET_GROUP: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="##(SET_GROUP).New">SET_GROUP: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="##(SET_GROUP).OnEvent">SET_GROUP: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="##(SET_GROUP).OnEventBaseCaptured">SET_GROUP: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="##(SET_GROUP).OnEventBirth">SET_GROUP: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="##(SET_GROUP).OnEventCrash">SET_GROUP: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="##(SET_GROUP).OnEventDead">SET_GROUP: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="##(SET_GROUP).OnEventEjection">SET_GROUP: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="##(SET_GROUP).OnEventEngineShutdown">SET_GROUP: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="##(SET_GROUP).OnEventEngineStartup">SET_GROUP: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="##(SET_GROUP).OnEventHit">SET_GROUP: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="##(SET_GROUP).OnEventHumanFailure">SET_GROUP: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="##(SET_GROUP).OnEventLand">SET_GROUP: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_GROUP).OnEventMissionEnd">SET_GROUP: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="##(SET_GROUP).OnEventMissionStart">SET_GROUP: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="##(SET_GROUP).OnEventPilotDead">SET_GROUP: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="##(SET_GROUP).OnEventPlayerEnterUnit">SET_GROUP: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="##(SET_GROUP).OnEventPlayerLeaveUnit">SET_GROUP: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="##(SET_GROUP).OnEventRefueling">SET_GROUP: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="##(SET_GROUP).OnEventRefuelingStop">SET_GROUP: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="##(SET_GROUP).OnEventShootingEnd">SET_GROUP: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="##(SET_GROUP).OnEventShootingStart">SET_GROUP: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="##(SET_GROUP).OnEventShot">SET_GROUP: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="##(SET_GROUP).OnEventTakeoff">SET_GROUP: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="##(SET_GROUP).ScheduleOnce">SET_GROUP: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="##(SET_GROUP).ScheduleRepeat">SET_GROUP: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="##(SET_GROUP).ScheduleStop">SET_GROUP: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="##(SET_GROUP).Scheduler">SET_GROUP.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="##(SET_GROUP).SetEventPriority">SET_GROUP: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="##(SET_GROUP).SetState">SET_GROUP: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="##(SET_GROUP).T">SET_GROUP: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="##(SET_GROUP).T2">SET_GROUP: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="##(SET_GROUP).T3">SET_GROUP: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="##(SET_GROUP).TraceAll">SET_GROUP: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="##(SET_GROUP).TraceClass">SET_GROUP: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="##(SET_GROUP).TraceClassMethod">SET_GROUP: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="##(SET_GROUP).TraceLevel">SET_GROUP: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="##(SET_GROUP).TraceOnOff">SET_GROUP: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="##(SET_GROUP).UnHandleEvent">SET_GROUP:UnHandleEvent(Event)</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="##(SET_GROUP)._">SET_GROUP._</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="##(SET_GROUP)._F">SET_GROUP:_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="##(SET_GROUP)._T">SET_GROUP:_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="##(SET_GROUP).__">SET_GROUP.__</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="##(SET_GROUP).onEvent">SET_GROUP: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="#(SET_PLAYER)">Type <strong>SET_PLAYER</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_PLAYER)">SET_PLAYER</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_PLAYER</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="##(SET_PLAYER).AddClientsByName">SET_PLAYER:AddClientsByName(AddClientNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add CLIENT(s) to SET_PLAYER.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).AddInDatabase">SET_PLAYER:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterCategories">SET_PLAYER:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients out of categories joined by players.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterCoalitions">SET_PLAYER:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of coalitions joined by specific players.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterCountries">SET_PLAYER:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterPrefixes">SET_PLAYER:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined client prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterStart">SET_PLAYER:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterTypes">SET_PLAYER:FilterTypes(Types)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of clients of defined client types joined by players.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FindClient">SET_PLAYER:FindClient(PlayerName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Client based on the Player Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FindInDatabase">SET_PLAYER:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).ForEachPlayer">SET_PLAYER:ForEachPlayer(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_PLAYER and call an interator function for each <strong>alive</strong> CLIENT, providing the CLIENT and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).ForEachPlayerInZone">SET_PLAYER:ForEachPlayerInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_PLAYER and call an iterator function for each <strong>alive</strong> CLIENT presence completely in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).ForEachPlayerNotInZone">SET_PLAYER:ForEachPlayerNotInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_PLAYER and call an iterator function for each <strong>alive</strong> CLIENT presence not in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).IsIncludeObject">SET_PLAYER:IsIncludeObject(MClient)</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="##(SET_PLAYER).New">SET_PLAYER:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_PLAYER object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).RemoveClientsByName">SET_PLAYER:RemoveClientsByName(RemoveClientNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove CLIENT(s) from SET_PLAYER.</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 SET_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="##(SET_PLAYER).Add">SET_PLAYER:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).AddObject">SET_PLAYER:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).CallScheduler">SET_PLAYER.CallScheduler</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="##(SET_PLAYER).Count">SET_PLAYER:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).Database">SET_PLAYER.Database</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="##(SET_PLAYER).Filter">SET_PLAYER.Filter</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="##(SET_PLAYER).FilterCrashes">SET_PLAYER:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterDeads">SET_PLAYER:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterOnce">SET_PLAYER:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FilterStop">SET_PLAYER:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).FindNearestObjectFromPointVec2">SET_PLAYER:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).Flush">SET_PLAYER:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).ForEach">SET_PLAYER:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).Get">SET_PLAYER:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetFirst">SET_PLAYER:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetLast">SET_PLAYER:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetObjectNames">SET_PLAYER:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetRandom">SET_PLAYER:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetSet">SET_PLAYER:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetSetNames">SET_PLAYER:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).GetSetObjects">SET_PLAYER:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).IsIncludeObject">SET_PLAYER:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).List">SET_PLAYER.List</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="##(SET_PLAYER).New">SET_PLAYER:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).OnAfterAdded">SET_PLAYER:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).OnAfterRemoved">SET_PLAYER:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).Remove">SET_PLAYER:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).Set">SET_PLAYER.Set</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="##(SET_PLAYER).SetDatabase">SET_PLAYER:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).SetIteratorIntervals">SET_PLAYER:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).TimeInterval">SET_PLAYER.TimeInterval</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="##(SET_PLAYER).YieldInterval">SET_PLAYER.YieldInterval</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="##(SET_PLAYER)._EventOnBirth">SET_PLAYER:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER)._EventOnDeadOrCrash">SET_PLAYER:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER)._FilterStart">SET_PLAYER:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER)._Find">SET_PLAYER:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_PLAYER).ClassID">SET_PLAYER.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="##(SET_PLAYER).ClassName">SET_PLAYER.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="##(SET_PLAYER).ClassNameAndID">SET_PLAYER.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="##(SET_PLAYER).ClearState">SET_PLAYER: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="##(SET_PLAYER).CreateEventBirth">SET_PLAYER: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="##(SET_PLAYER).CreateEventCrash">SET_PLAYER: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="##(SET_PLAYER).CreateEventDead">SET_PLAYER: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="##(SET_PLAYER).CreateEventRemoveUnit">SET_PLAYER: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="##(SET_PLAYER).CreateEventTakeoff">SET_PLAYER: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="##(SET_PLAYER).E">SET_PLAYER: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="##(SET_PLAYER).EventDispatcher">SET_PLAYER: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="##(SET_PLAYER).EventRemoveAll">SET_PLAYER: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="##(SET_PLAYER).F">SET_PLAYER: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="##(SET_PLAYER).F2">SET_PLAYER: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="##(SET_PLAYER).F3">SET_PLAYER: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="##(SET_PLAYER).GetClassID">SET_PLAYER: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="##(SET_PLAYER).GetClassName">SET_PLAYER: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="##(SET_PLAYER).GetClassNameAndID">SET_PLAYER: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="##(SET_PLAYER).GetEventPriority">SET_PLAYER: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="##(SET_PLAYER).GetParent">SET_PLAYER: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="##(SET_PLAYER).GetState">SET_PLAYER: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="##(SET_PLAYER).HandleEvent">SET_PLAYER:HandleEvent(Event, 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="##(SET_PLAYER).I">SET_PLAYER: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="##(SET_PLAYER).Inherit">SET_PLAYER: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="##(SET_PLAYER).IsInstanceOf">SET_PLAYER: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="##(SET_PLAYER).IsTrace">SET_PLAYER: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="##(SET_PLAYER).New">SET_PLAYER: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="##(SET_PLAYER).OnEvent">SET_PLAYER: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="##(SET_PLAYER).OnEventBaseCaptured">SET_PLAYER: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="##(SET_PLAYER).OnEventBirth">SET_PLAYER: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="##(SET_PLAYER).OnEventCrash">SET_PLAYER: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="##(SET_PLAYER).OnEventDead">SET_PLAYER: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="##(SET_PLAYER).OnEventEjection">SET_PLAYER: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="##(SET_PLAYER).OnEventEngineShutdown">SET_PLAYER: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="##(SET_PLAYER).OnEventEngineStartup">SET_PLAYER: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="##(SET_PLAYER).OnEventHit">SET_PLAYER: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="##(SET_PLAYER).OnEventHumanFailure">SET_PLAYER: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="##(SET_PLAYER).OnEventLand">SET_PLAYER: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_PLAYER).OnEventMissionEnd">SET_PLAYER: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="##(SET_PLAYER).OnEventMissionStart">SET_PLAYER: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="##(SET_PLAYER).OnEventPilotDead">SET_PLAYER: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="##(SET_PLAYER).OnEventPlayerEnterUnit">SET_PLAYER: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="##(SET_PLAYER).OnEventPlayerLeaveUnit">SET_PLAYER: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="##(SET_PLAYER).OnEventRefueling">SET_PLAYER: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="##(SET_PLAYER).OnEventRefuelingStop">SET_PLAYER: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="##(SET_PLAYER).OnEventShootingEnd">SET_PLAYER: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="##(SET_PLAYER).OnEventShootingStart">SET_PLAYER: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="##(SET_PLAYER).OnEventShot">SET_PLAYER: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="##(SET_PLAYER).OnEventTakeoff">SET_PLAYER: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="##(SET_PLAYER).ScheduleOnce">SET_PLAYER: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="##(SET_PLAYER).ScheduleRepeat">SET_PLAYER: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="##(SET_PLAYER).ScheduleStop">SET_PLAYER: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="##(SET_PLAYER).Scheduler">SET_PLAYER.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="##(SET_PLAYER).SetEventPriority">SET_PLAYER: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="##(SET_PLAYER).SetState">SET_PLAYER: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="##(SET_PLAYER).T">SET_PLAYER: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="##(SET_PLAYER).T2">SET_PLAYER: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="##(SET_PLAYER).T3">SET_PLAYER: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="##(SET_PLAYER).TraceAll">SET_PLAYER: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="##(SET_PLAYER).TraceClass">SET_PLAYER: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="##(SET_PLAYER).TraceClassMethod">SET_PLAYER: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="##(SET_PLAYER).TraceLevel">SET_PLAYER: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="##(SET_PLAYER).TraceOnOff">SET_PLAYER: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="##(SET_PLAYER).UnHandleEvent">SET_PLAYER:UnHandleEvent(Event)</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="##(SET_PLAYER)._">SET_PLAYER._</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="##(SET_PLAYER)._F">SET_PLAYER:_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="##(SET_PLAYER)._T">SET_PLAYER:_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="##(SET_PLAYER).__">SET_PLAYER.__</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="##(SET_PLAYER).onEvent">SET_PLAYER: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="#(SET_STATIC)">Type <strong>SET_STATIC</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_STATIC)">SET_STATIC</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_STATIC</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="##(SET_STATIC).AddInDatabase">SET_STATIC:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).AddStatic">SET_STATIC:AddStatic(AddStatic)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add STATIC(s) to SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).AddStaticsByName">SET_STATIC:AddStaticsByName(AddStaticNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add STATIC(s) to SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).CalculateThreatLevelA2G">SET_STATIC:CalculateThreatLevelA2G()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the maxium A2G threat level of the SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterCategories">SET_STATIC:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units out of categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterCoalitions">SET_STATIC:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterCountries">SET_STATIC:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterPrefixes">SET_STATIC:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined unit prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterStart">SET_STATIC:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterTypes">SET_STATIC:FilterTypes(Types)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined unit types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FindInDatabase">SET_STATIC:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FindStatic">SET_STATIC:FindStatic(StaticName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Static based on the Static Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).ForEachStatic">SET_STATIC:ForEachStatic(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_STATIC and call an interator function for each <strong>alive</strong> STATIC, providing the STATIC and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).ForEachStaticCompletelyInZone">SET_STATIC:ForEachStaticCompletelyInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_STATIC and call an iterator function for each <strong>alive</strong> STATIC presence completely in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).ForEachStaticInZone">SET_STATIC:ForEachStaticInZone(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if minimal one element of the SET_STATIC is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).ForEachStaticNotInZone">SET_STATIC:ForEachStaticNotInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_STATIC and call an iterator function for each <strong>alive</strong> STATIC presence not in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetCoordinate">SET_STATIC:GetCoordinate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the center coordinate of the SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetFirst">SET_STATIC:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the first unit from the set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetHeading">SET_STATIC:GetHeading()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the average heading of the SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetStaticTypes">SET_STATIC:GetStaticTypes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns map of unit types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetStaticTypesText">SET_STATIC:GetStaticTypesText()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a comma separated string of the unit types with a count in the <a href="Set.html">Set</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetTypeNames">SET_STATIC:GetTypeNames(Delimiter)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieve the type names of the <a href="Static.html">Static</a>s in the SET, delimited by an optional delimiter.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetVelocity">SET_STATIC:GetVelocity()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the maximum velocity of the SET_STATIC.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).IsIncludeObject">SET_STATIC:IsIncludeObject(MStatic)</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="##(SET_STATIC).IsNotInZone">SET_STATIC:IsNotInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if no element of the SET_STATIC is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).IsPatriallyInZone">SET_STATIC:IsPatriallyInZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if minimal one element of the SET_STATIC is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).New">SET_STATIC:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_STATIC object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).RemoveStaticsByName">SET_STATIC:RemoveStaticsByName(RemoveStaticNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove STATIC(s) from SET_STATIC.</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 SET_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="##(SET_STATIC).Add">SET_STATIC:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).AddObject">SET_STATIC:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).CallScheduler">SET_STATIC.CallScheduler</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="##(SET_STATIC).Count">SET_STATIC:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).Database">SET_STATIC.Database</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="##(SET_STATIC).Filter">SET_STATIC.Filter</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="##(SET_STATIC).FilterCrashes">SET_STATIC:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterDeads">SET_STATIC:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterOnce">SET_STATIC:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FilterStop">SET_STATIC:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).FindNearestObjectFromPointVec2">SET_STATIC:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).Flush">SET_STATIC:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).ForEach">SET_STATIC:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).Get">SET_STATIC:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetFirst">SET_STATIC:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetLast">SET_STATIC:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetObjectNames">SET_STATIC:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetRandom">SET_STATIC:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetSet">SET_STATIC:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetSetNames">SET_STATIC:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).GetSetObjects">SET_STATIC:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).IsIncludeObject">SET_STATIC:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).List">SET_STATIC.List</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="##(SET_STATIC).New">SET_STATIC:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).OnAfterAdded">SET_STATIC:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).OnAfterRemoved">SET_STATIC:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).Remove">SET_STATIC:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).Set">SET_STATIC.Set</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="##(SET_STATIC).SetDatabase">SET_STATIC:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).SetIteratorIntervals">SET_STATIC:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).TimeInterval">SET_STATIC.TimeInterval</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="##(SET_STATIC).YieldInterval">SET_STATIC.YieldInterval</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="##(SET_STATIC)._EventOnBirth">SET_STATIC:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC)._EventOnDeadOrCrash">SET_STATIC:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC)._FilterStart">SET_STATIC:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC)._Find">SET_STATIC:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_STATIC).ClassID">SET_STATIC.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="##(SET_STATIC).ClassName">SET_STATIC.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="##(SET_STATIC).ClassNameAndID">SET_STATIC.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="##(SET_STATIC).ClearState">SET_STATIC: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="##(SET_STATIC).CreateEventBirth">SET_STATIC: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="##(SET_STATIC).CreateEventCrash">SET_STATIC: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="##(SET_STATIC).CreateEventDead">SET_STATIC: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="##(SET_STATIC).CreateEventRemoveUnit">SET_STATIC: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="##(SET_STATIC).CreateEventTakeoff">SET_STATIC: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="##(SET_STATIC).E">SET_STATIC: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="##(SET_STATIC).EventDispatcher">SET_STATIC: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="##(SET_STATIC).EventRemoveAll">SET_STATIC: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="##(SET_STATIC).F">SET_STATIC: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="##(SET_STATIC).F2">SET_STATIC: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="##(SET_STATIC).F3">SET_STATIC: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="##(SET_STATIC).GetClassID">SET_STATIC: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="##(SET_STATIC).GetClassName">SET_STATIC: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="##(SET_STATIC).GetClassNameAndID">SET_STATIC: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="##(SET_STATIC).GetEventPriority">SET_STATIC: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="##(SET_STATIC).GetParent">SET_STATIC: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="##(SET_STATIC).GetState">SET_STATIC: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="##(SET_STATIC).HandleEvent">SET_STATIC:HandleEvent(Event, 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="##(SET_STATIC).I">SET_STATIC: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="##(SET_STATIC).Inherit">SET_STATIC: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="##(SET_STATIC).IsInstanceOf">SET_STATIC: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="##(SET_STATIC).IsTrace">SET_STATIC: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="##(SET_STATIC).New">SET_STATIC: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="##(SET_STATIC).OnEvent">SET_STATIC: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="##(SET_STATIC).OnEventBaseCaptured">SET_STATIC: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="##(SET_STATIC).OnEventBirth">SET_STATIC: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="##(SET_STATIC).OnEventCrash">SET_STATIC: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="##(SET_STATIC).OnEventDead">SET_STATIC: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="##(SET_STATIC).OnEventEjection">SET_STATIC: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="##(SET_STATIC).OnEventEngineShutdown">SET_STATIC: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="##(SET_STATIC).OnEventEngineStartup">SET_STATIC: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="##(SET_STATIC).OnEventHit">SET_STATIC: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="##(SET_STATIC).OnEventHumanFailure">SET_STATIC: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="##(SET_STATIC).OnEventLand">SET_STATIC: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_STATIC).OnEventMissionEnd">SET_STATIC: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="##(SET_STATIC).OnEventMissionStart">SET_STATIC: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="##(SET_STATIC).OnEventPilotDead">SET_STATIC: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="##(SET_STATIC).OnEventPlayerEnterUnit">SET_STATIC: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="##(SET_STATIC).OnEventPlayerLeaveUnit">SET_STATIC: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="##(SET_STATIC).OnEventRefueling">SET_STATIC: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="##(SET_STATIC).OnEventRefuelingStop">SET_STATIC: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="##(SET_STATIC).OnEventShootingEnd">SET_STATIC: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="##(SET_STATIC).OnEventShootingStart">SET_STATIC: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="##(SET_STATIC).OnEventShot">SET_STATIC: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="##(SET_STATIC).OnEventTakeoff">SET_STATIC: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="##(SET_STATIC).ScheduleOnce">SET_STATIC: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="##(SET_STATIC).ScheduleRepeat">SET_STATIC: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="##(SET_STATIC).ScheduleStop">SET_STATIC: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="##(SET_STATIC).Scheduler">SET_STATIC.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="##(SET_STATIC).SetEventPriority">SET_STATIC: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="##(SET_STATIC).SetState">SET_STATIC: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="##(SET_STATIC).T">SET_STATIC: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="##(SET_STATIC).T2">SET_STATIC: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="##(SET_STATIC).T3">SET_STATIC: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="##(SET_STATIC).TraceAll">SET_STATIC: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="##(SET_STATIC).TraceClass">SET_STATIC: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="##(SET_STATIC).TraceClassMethod">SET_STATIC: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="##(SET_STATIC).TraceLevel">SET_STATIC: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="##(SET_STATIC).TraceOnOff">SET_STATIC: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="##(SET_STATIC).UnHandleEvent">SET_STATIC:UnHandleEvent(Event)</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="##(SET_STATIC)._">SET_STATIC._</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="##(SET_STATIC)._F">SET_STATIC:_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="##(SET_STATIC)._T">SET_STATIC:_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="##(SET_STATIC).__">SET_STATIC.__</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="##(SET_STATIC).onEvent">SET_STATIC: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="#(SET_UNIT)">Type <strong>SET_UNIT</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_UNIT)">SET_UNIT</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_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="##(SET_UNIT).AddInDatabase">SET_UNIT:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).AddUnit">SET_UNIT:AddUnit(Unit)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add UNIT(s) to SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).AddUnitsByName">SET_UNIT:AddUnitsByName(AddUnitNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add UNIT(s) to SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).CalculateThreatLevelA2G">SET_UNIT:CalculateThreatLevelA2G()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Calculate the maxium A2G threat level of the SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterActive">SET_UNIT:FilterActive(Active)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units that are only active.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterCategories">SET_UNIT:FilterCategories(Categories)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units out of categories.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterCoalitions">SET_UNIT:FilterCoalitions(Coalitions)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of coalitions.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterCountries">SET_UNIT:FilterCountries(Countries)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined countries.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterHasRadar">SET_UNIT:FilterHasRadar(RadarTypes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units having a radar of give types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterHasSEAD">SET_UNIT:FilterHasSEAD()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of SEADable units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterPrefixes">SET_UNIT:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined unit prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterStart">SET_UNIT:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterTypes">SET_UNIT:FilterTypes(Types)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of units of defined unit types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FindInDatabase">SET_UNIT:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FindUnit">SET_UNIT:FindUnit(UnitName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Unit based on the Unit Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEachUnit">SET_UNIT:ForEachUnit(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_UNIT and call an interator function for each <strong>alive</strong> UNIT, providing the UNIT and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEachUnitCompletelyInZone">SET_UNIT:ForEachUnitCompletelyInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT presence completely in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEachUnitInZone">SET_UNIT:ForEachUnitInZone(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if minimal one element of the SET_UNIT is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEachUnitNotInZone">SET_UNIT:ForEachUnitNotInZone(ZoneObject, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT presence not in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEachUnitPerThreatLevel">SET_UNIT:ForEachUnitPerThreatLevel(FromThreatLevel, ToThreatLevel, IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_UNIT <strong>sorted *per Threat Level</strong> and call an interator function for each <strong>alive</strong> UNIT, providing the UNIT and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetCoordinate">SET_UNIT:GetCoordinate()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the center coordinate of the SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetFirst">SET_UNIT:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the first unit from the set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetHeading">SET_UNIT:GetHeading()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the average heading of the SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetTypeNames">SET_UNIT:GetTypeNames(Delimiter)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieve the type names of the <a href="Wrapper.Unit.html">Wrapper.Unit</a>s in the SET, delimited by an optional delimiter.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetUnitThreatLevels">SET_UNIT:GetUnitThreatLevels()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns map of unit threat levels.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetUnitTypes">SET_UNIT:GetUnitTypes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns map of unit types.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetUnitTypesText">SET_UNIT:GetUnitTypesText()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns a comma separated string of the unit types with a count in the <a href="Set.html">Set</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetVelocity">SET_UNIT:GetVelocity()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get the maximum velocity of the SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).HasFriendlyUnits">SET_UNIT:HasFriendlyUnits(FriendlyCoalition)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the <a href="Set.html">Set</a> has friendly ground units.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).HasGroundUnits">SET_UNIT:HasGroundUnits()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the <a href="Set.html">Set</a> has ground targets.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).HasRadar">SET_UNIT:HasRadar(RadarType)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the <a href="Set.html">Set</a> has targets having a radar (of a given type).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).HasSEAD">SET_UNIT:HasSEAD()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Returns if the <a href="Set.html">Set</a> has targets that can be SEADed.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).IsIncludeObject">SET_UNIT:IsIncludeObject(MUnit)</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="##(SET_UNIT).IsNotInZone">SET_UNIT:IsNotInZone(ZoneObject, Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if no element of the SET_UNIT is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).IsPartiallyInZone">SET_UNIT:IsPartiallyInZone(ZoneTest)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Check if minimal one element of the SET_UNIT is in the Zone.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).New">SET_UNIT:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_UNIT object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).RemoveUnitsByName">SET_UNIT:RemoveUnitsByName(RemoveUnitNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove UNIT(s) from SET_UNIT.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).SetCargoBayWeightLimit">SET_UNIT:SetCargoBayWeightLimit()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_UNIT and set for each unit the default cargo bay weight limit.</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 SET_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="##(SET_UNIT).Add">SET_UNIT:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).AddObject">SET_UNIT:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).CallScheduler">SET_UNIT.CallScheduler</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="##(SET_UNIT).Count">SET_UNIT:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).Database">SET_UNIT.Database</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="##(SET_UNIT).Filter">SET_UNIT.Filter</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="##(SET_UNIT).FilterCrashes">SET_UNIT:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterDeads">SET_UNIT:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterOnce">SET_UNIT:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FilterStop">SET_UNIT:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).FindNearestObjectFromPointVec2">SET_UNIT:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).Flush">SET_UNIT:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).ForEach">SET_UNIT:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).Get">SET_UNIT:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetFirst">SET_UNIT:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetLast">SET_UNIT:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetObjectNames">SET_UNIT:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetRandom">SET_UNIT:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetSet">SET_UNIT:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetSetNames">SET_UNIT:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).GetSetObjects">SET_UNIT:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).IsIncludeObject">SET_UNIT:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).List">SET_UNIT.List</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="##(SET_UNIT).New">SET_UNIT:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).OnAfterAdded">SET_UNIT:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).OnAfterRemoved">SET_UNIT:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).Remove">SET_UNIT:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).Set">SET_UNIT.Set</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="##(SET_UNIT).SetDatabase">SET_UNIT:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).SetIteratorIntervals">SET_UNIT:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).TimeInterval">SET_UNIT.TimeInterval</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="##(SET_UNIT).YieldInterval">SET_UNIT.YieldInterval</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="##(SET_UNIT)._EventOnBirth">SET_UNIT:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT)._EventOnDeadOrCrash">SET_UNIT:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT)._FilterStart">SET_UNIT:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT)._Find">SET_UNIT:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_UNIT).ClassID">SET_UNIT.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="##(SET_UNIT).ClassName">SET_UNIT.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="##(SET_UNIT).ClassNameAndID">SET_UNIT.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="##(SET_UNIT).ClearState">SET_UNIT: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="##(SET_UNIT).CreateEventBirth">SET_UNIT: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="##(SET_UNIT).CreateEventCrash">SET_UNIT: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="##(SET_UNIT).CreateEventDead">SET_UNIT: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="##(SET_UNIT).CreateEventRemoveUnit">SET_UNIT: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="##(SET_UNIT).CreateEventTakeoff">SET_UNIT: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="##(SET_UNIT).E">SET_UNIT: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="##(SET_UNIT).EventDispatcher">SET_UNIT: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="##(SET_UNIT).EventRemoveAll">SET_UNIT: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="##(SET_UNIT).F">SET_UNIT: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="##(SET_UNIT).F2">SET_UNIT: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="##(SET_UNIT).F3">SET_UNIT: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="##(SET_UNIT).GetClassID">SET_UNIT: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="##(SET_UNIT).GetClassName">SET_UNIT: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="##(SET_UNIT).GetClassNameAndID">SET_UNIT: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="##(SET_UNIT).GetEventPriority">SET_UNIT: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="##(SET_UNIT).GetParent">SET_UNIT: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="##(SET_UNIT).GetState">SET_UNIT: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="##(SET_UNIT).HandleEvent">SET_UNIT:HandleEvent(Event, 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="##(SET_UNIT).I">SET_UNIT: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="##(SET_UNIT).Inherit">SET_UNIT: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="##(SET_UNIT).IsInstanceOf">SET_UNIT: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="##(SET_UNIT).IsTrace">SET_UNIT: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="##(SET_UNIT).New">SET_UNIT: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="##(SET_UNIT).OnEvent">SET_UNIT: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="##(SET_UNIT).OnEventBaseCaptured">SET_UNIT: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="##(SET_UNIT).OnEventBirth">SET_UNIT: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="##(SET_UNIT).OnEventCrash">SET_UNIT: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="##(SET_UNIT).OnEventDead">SET_UNIT: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="##(SET_UNIT).OnEventEjection">SET_UNIT: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="##(SET_UNIT).OnEventEngineShutdown">SET_UNIT: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="##(SET_UNIT).OnEventEngineStartup">SET_UNIT: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="##(SET_UNIT).OnEventHit">SET_UNIT: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="##(SET_UNIT).OnEventHumanFailure">SET_UNIT: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="##(SET_UNIT).OnEventLand">SET_UNIT: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_UNIT).OnEventMissionEnd">SET_UNIT: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="##(SET_UNIT).OnEventMissionStart">SET_UNIT: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="##(SET_UNIT).OnEventPilotDead">SET_UNIT: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="##(SET_UNIT).OnEventPlayerEnterUnit">SET_UNIT: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="##(SET_UNIT).OnEventPlayerLeaveUnit">SET_UNIT: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="##(SET_UNIT).OnEventRefueling">SET_UNIT: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="##(SET_UNIT).OnEventRefuelingStop">SET_UNIT: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="##(SET_UNIT).OnEventShootingEnd">SET_UNIT: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="##(SET_UNIT).OnEventShootingStart">SET_UNIT: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="##(SET_UNIT).OnEventShot">SET_UNIT: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="##(SET_UNIT).OnEventTakeoff">SET_UNIT: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="##(SET_UNIT).ScheduleOnce">SET_UNIT: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="##(SET_UNIT).ScheduleRepeat">SET_UNIT: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="##(SET_UNIT).ScheduleStop">SET_UNIT: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="##(SET_UNIT).Scheduler">SET_UNIT.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="##(SET_UNIT).SetEventPriority">SET_UNIT: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="##(SET_UNIT).SetState">SET_UNIT: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="##(SET_UNIT).T">SET_UNIT: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="##(SET_UNIT).T2">SET_UNIT: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="##(SET_UNIT).T3">SET_UNIT: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="##(SET_UNIT).TraceAll">SET_UNIT: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="##(SET_UNIT).TraceClass">SET_UNIT: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="##(SET_UNIT).TraceClassMethod">SET_UNIT: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="##(SET_UNIT).TraceLevel">SET_UNIT: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="##(SET_UNIT).TraceOnOff">SET_UNIT: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="##(SET_UNIT).UnHandleEvent">SET_UNIT:UnHandleEvent(Event)</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="##(SET_UNIT)._">SET_UNIT._</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="##(SET_UNIT)._F">SET_UNIT:_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="##(SET_UNIT)._T">SET_UNIT:_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="##(SET_UNIT).__">SET_UNIT.__</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="##(SET_UNIT).onEvent">SET_UNIT: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="#(SET_ZONE)">Type <strong>SET_ZONE</strong></a></h2></div>
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
<strong><a href="##(SET_ZONE)">SET_ZONE</a></strong>
, extends <strong><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</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 SET_ZONE</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="##(SET_ZONE).AddInDatabase">SET_ZONE:AddInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).AddZone">SET_ZONE:AddZone(Zone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add ZONEs to SET_ZONE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).AddZonesByName">SET_ZONE:AddZonesByName(AddZoneNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add ZONEs by a search name to SET_ZONE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterPrefixes">SET_ZONE:FilterPrefixes(Prefixes)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Builds a set of zones of defined zone prefixes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterStart">SET_ZONE:FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterStop">SET_ZONE:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FindInDatabase">SET_ZONE:FindInDatabase(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the Database to check on any event that Object exists in the Database.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FindZone">SET_ZONE:FindZone(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a Zone based on the Zone Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).ForEachZone">SET_ZONE:ForEachZone(IteratorFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_ZONE and call an interator function for each ZONE, providing the ZONE and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetRandomZone">SET_ZONE:GetRandomZone()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Get a random zone from the set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).IsCoordinateInZone">SET_ZONE:IsCoordinateInZone(Coordinate)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Validate if a coordinate is in one of the zones in the set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).IsIncludeObject">SET_ZONE:IsIncludeObject(MZone)</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="##(SET_ZONE).New">SET_ZONE:New()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_ZONE object, building a set of zones.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).OnEventDeleteZone">SET_ZONE:OnEventDeleteZone(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).OnEventNewZone">SET_ZONE:OnEventNewZone(EventData)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnEventNewZone event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).RemoveZonesByName">SET_ZONE:RemoveZonesByName(RemoveZoneNames)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Remove ZONEs from SET_ZONE.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).SetZoneProbability">SET_ZONE:SetZoneProbability(ZoneName, ZoneProbability)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Set a zone probability.</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 SET_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="##(SET_ZONE).Add">SET_ZONE:Add(ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).AddObject">SET_ZONE:AddObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).CallScheduler">SET_ZONE.CallScheduler</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="##(SET_ZONE).Count">SET_ZONE:Count()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).Database">SET_ZONE.Database</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="##(SET_ZONE).Filter">SET_ZONE.Filter</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="##(SET_ZONE).FilterCrashes">SET_ZONE:FilterCrashes()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Crash events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterDeads">SET_ZONE:FilterDeads()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering of the Dead events for the collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterOnce">SET_ZONE:FilterOnce()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Filters for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FilterStop">SET_ZONE:FilterStop()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Stops the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).FindNearestObjectFromPointVec2">SET_ZONE:FindNearestObjectFromPointVec2(PointVec2)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).Flush">SET_ZONE:Flush(MasterObject)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Flushes the current SET_BASE contents in the log ...</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).ForEach">SET_ZONE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).Get">SET_ZONE:Get(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetFirst">SET_ZONE:GetFirst()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetLast">SET_ZONE:GetLast()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetObjectNames">SET_ZONE:GetObjectNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a string with all the object names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetRandom">SET_ZONE:GetRandom()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetSet">SET_ZONE:GetSet()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetSetNames">SET_ZONE:GetSetNames()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Names of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).GetSetObjects">SET_ZONE:GetSetObjects()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Gets a list of the Objects in the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).IsIncludeObject">SET_ZONE:IsIncludeObject(Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Decides whether to include the Object</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).List">SET_ZONE.List</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="##(SET_ZONE).New">SET_ZONE:New(Database)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).OnAfterAdded">SET_ZONE:OnAfterAdded(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Added Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).OnAfterRemoved">SET_ZONE:OnAfterRemoved(From, Event, To, ObjectName, Object)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removed Handler OnAfter for SET_BASE</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).Remove">SET_ZONE:Remove(ObjectName, NoTriggerEvent)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).Set">SET_ZONE.Set</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="##(SET_ZONE).SetDatabase">SET_ZONE:SetDatabase(BaseSet)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).SetIteratorIntervals">SET_ZONE:SetIteratorIntervals(YieldInterval, TimeInterval)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).TimeInterval">SET_ZONE.TimeInterval</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="##(SET_ZONE).YieldInterval">SET_ZONE.YieldInterval</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="##(SET_ZONE)._EventOnBirth">SET_ZONE:_EventOnBirth(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnBirth event for the Set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE)._EventOnDeadOrCrash">SET_ZONE:_EventOnDeadOrCrash(Event)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Handles the OnDead or OnCrash event for alive units set.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE)._FilterStart">SET_ZONE:_FilterStart()</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Starts the filtering for the defined collection.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE)._Find">SET_ZONE:_Find(ObjectName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="##(SET_ZONE).ClassID">SET_ZONE.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="##(SET_ZONE).ClassName">SET_ZONE.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="##(SET_ZONE).ClassNameAndID">SET_ZONE.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="##(SET_ZONE).ClearState">SET_ZONE: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="##(SET_ZONE).CreateEventBirth">SET_ZONE: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="##(SET_ZONE).CreateEventCrash">SET_ZONE: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="##(SET_ZONE).CreateEventDead">SET_ZONE: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="##(SET_ZONE).CreateEventRemoveUnit">SET_ZONE: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="##(SET_ZONE).CreateEventTakeoff">SET_ZONE: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="##(SET_ZONE).E">SET_ZONE: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="##(SET_ZONE).EventDispatcher">SET_ZONE: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="##(SET_ZONE).EventRemoveAll">SET_ZONE: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="##(SET_ZONE).F">SET_ZONE: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="##(SET_ZONE).F2">SET_ZONE: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="##(SET_ZONE).F3">SET_ZONE: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="##(SET_ZONE).GetClassID">SET_ZONE: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="##(SET_ZONE).GetClassName">SET_ZONE: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="##(SET_ZONE).GetClassNameAndID">SET_ZONE: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="##(SET_ZONE).GetEventPriority">SET_ZONE: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="##(SET_ZONE).GetParent">SET_ZONE: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="##(SET_ZONE).GetState">SET_ZONE: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="##(SET_ZONE).HandleEvent">SET_ZONE:HandleEvent(Event, 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="##(SET_ZONE).I">SET_ZONE: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="##(SET_ZONE).Inherit">SET_ZONE: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="##(SET_ZONE).IsInstanceOf">SET_ZONE: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="##(SET_ZONE).IsTrace">SET_ZONE: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="##(SET_ZONE).New">SET_ZONE: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="##(SET_ZONE).OnEvent">SET_ZONE: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="##(SET_ZONE).OnEventBaseCaptured">SET_ZONE: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="##(SET_ZONE).OnEventBirth">SET_ZONE: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="##(SET_ZONE).OnEventCrash">SET_ZONE: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="##(SET_ZONE).OnEventDead">SET_ZONE: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="##(SET_ZONE).OnEventEjection">SET_ZONE: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="##(SET_ZONE).OnEventEngineShutdown">SET_ZONE: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="##(SET_ZONE).OnEventEngineStartup">SET_ZONE: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="##(SET_ZONE).OnEventHit">SET_ZONE: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="##(SET_ZONE).OnEventHumanFailure">SET_ZONE: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="##(SET_ZONE).OnEventLand">SET_ZONE: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
place: Object that the unit landed on.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SET_ZONE).OnEventMissionEnd">SET_ZONE: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="##(SET_ZONE).OnEventMissionStart">SET_ZONE: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="##(SET_ZONE).OnEventPilotDead">SET_ZONE: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="##(SET_ZONE).OnEventPlayerEnterUnit">SET_ZONE: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="##(SET_ZONE).OnEventPlayerLeaveUnit">SET_ZONE: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="##(SET_ZONE).OnEventRefueling">SET_ZONE: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="##(SET_ZONE).OnEventRefuelingStop">SET_ZONE: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="##(SET_ZONE).OnEventShootingEnd">SET_ZONE: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="##(SET_ZONE).OnEventShootingStart">SET_ZONE: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="##(SET_ZONE).OnEventShot">SET_ZONE: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="##(SET_ZONE).OnEventTakeoff">SET_ZONE: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="##(SET_ZONE).ScheduleOnce">SET_ZONE: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="##(SET_ZONE).ScheduleRepeat">SET_ZONE: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="##(SET_ZONE).ScheduleStop">SET_ZONE: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="##(SET_ZONE).Scheduler">SET_ZONE.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="##(SET_ZONE).SetEventPriority">SET_ZONE: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="##(SET_ZONE).SetState">SET_ZONE: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="##(SET_ZONE).T">SET_ZONE: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="##(SET_ZONE).T2">SET_ZONE: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="##(SET_ZONE).T3">SET_ZONE: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="##(SET_ZONE).TraceAll">SET_ZONE: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="##(SET_ZONE).TraceClass">SET_ZONE: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="##(SET_ZONE).TraceClassMethod">SET_ZONE: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="##(SET_ZONE).TraceLevel">SET_ZONE: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="##(SET_ZONE).TraceOnOff">SET_ZONE: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="##(SET_ZONE).UnHandleEvent">SET_ZONE:UnHandleEvent(Event)</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="##(SET_ZONE)._">SET_ZONE._</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="##(SET_ZONE)._F">SET_ZONE:_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="##(SET_ZONE)._T">SET_ZONE:_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="##(SET_ZONE).__">SET_ZONE.__</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="##(SET_ZONE).onEvent">SET_ZONE: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="#(Core.Set)" >Type <strong>Core.Set</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##SET_AIRBASE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_AIRBASE)">Type <strong>SET_AIRBASE</strong></a></h2></div>
<div id= "#Types##SET_AIRBASE" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_AIRBASE).AddAirbase" ><strong>SET_AIRBASE:AddAirbase(airbase)</strong></a></h2>
</div>
<p>Add an AIRBASE object to SET_AIRBASE.</p>
<div id= "#Functions##AddAirbase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
<strong><strong>airbase</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Airbase that should be added to the set.</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>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="#(SET_AIRBASE).AddAirbasesByName" ><strong>SET_AIRBASE:AddAirbasesByName(AddAirbaseNames)</strong></a></h2>
</div>
<p>Add AIRBASEs to SET_AIRBASE.</p>
<div id= "#Functions##AddAirbasesByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>AddAirbaseNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of AIRBASE names.</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>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="#(SET_AIRBASE).AddInDatabase" ><strong>SET_AIRBASE:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the AIRBASE</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The AIRBASE</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).FilterCategories" ><strong>SET_AIRBASE:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of airbases out of categories.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "airdrome", "helipad", "ship".</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).FilterCoalitions" ><strong>SET_AIRBASE:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of airbases of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).FilterStart" ><strong>SET_AIRBASE:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).FindAirbase" ><strong>SET_AIRBASE:FindAirbase(AirbaseName)</strong></a></h2>
</div>
<p>Finds a Airbase based on the Airbase Name.</p>
<div id= "#Functions##FindAirbase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>AirbaseName</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>The found Airbase.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).FindAirbaseInRange" ><strong>SET_AIRBASE:FindAirbaseInRange(Coordinate, Range)</strong></a></h2>
</div>
<p>Finds an Airbase in range of a coordinate.</p>
<div id= "#Functions##FindAirbaseInRange" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</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></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></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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>The found Airbase.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).FindInDatabase" ><strong>SET_AIRBASE:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the AIRBASE</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The AIRBASE</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).FindNearestAirbaseFromPointVec2" ><strong>SET_AIRBASE:FindNearestAirbaseFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_AIRBASE while identifying the nearest <a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a> from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestAirbaseFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest <a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</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="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest <a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</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="#(SET_AIRBASE).ForEachAirbase" ><strong>SET_AIRBASE:ForEachAirbase(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_AIRBASE and call an interator function for each AIRBASE, providing the AIRBASE and optional parameters.</p>
<div id= "#Functions##ForEachAirbase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive AIRBASE in the SET_AIRBASE. The function needs to accept a AIRBASE parameter.</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).GetRandomAirbase" ><strong>SET_AIRBASE:GetRandomAirbase()</strong></a></h2>
</div>
<p>Finds a random Airbase in the set.</p>
<div id= "#Functions##GetRandomAirbase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>The found Airbase.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).IsIncludeObject" ><strong>SET_AIRBASE:IsIncludeObject(MAirbase)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
<strong><strong>MAirbase</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).New" ><strong>SET_AIRBASE:New()</strong></a></h2>
</div>
<p>Creates a new SET_AIRBASE object, building a set of airbases belonging to a coalitions and categories.</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>SET_AIRBASE</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="##(SET_AIRBASE)">#SET_AIRBASE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_AIRBASE Object. The DatabaseSet will contain a reference to all Airbases.
DatabaseSet = SET_AIRBASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).OnEventBaseCaptured" ><strong>SET_AIRBASE:OnEventBaseCaptured(EventData)</strong></a></h2>
</div>
<p>Starts the filtering.</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>SET_AIRBASE</p>
</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##(EVENT)">Core.Event#EVENT</a>
<strong><strong>EventData</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="##(SET_AIRBASE)">#SET_AIRBASE</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="#(SET_AIRBASE).RemoveAirbasesByName" ><strong>SET_AIRBASE:RemoveAirbasesByName(RemoveAirbaseNames)</strong></a></h2>
</div>
<p>Remove AIRBASEs from SET_AIRBASE.</p>
<div id= "#Functions##RemoveAirbasesByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_AIRBASE</p>
</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
<strong><strong>RemoveAirbaseNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of AIRBASE names.</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>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_AIRBASE).Add" ><strong>SET_AIRBASE:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_AIRBASE).AddObject" ><strong>SET_AIRBASE:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_AIRBASE).Count" ><strong>SET_AIRBASE:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).FilterCrashes" ><strong>SET_AIRBASE:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).FilterDeads" ><strong>SET_AIRBASE:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).FilterOnce" ><strong>SET_AIRBASE:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).FilterStop" ><strong>SET_AIRBASE:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).FindNearestObjectFromPointVec2" ><strong>SET_AIRBASE:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_AIRBASE).Flush" ><strong>SET_AIRBASE:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).ForEach" ><strong>SET_AIRBASE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).Get" ><strong>SET_AIRBASE:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_AIRBASE).GetFirst" ><strong>SET_AIRBASE:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_AIRBASE).GetLast" ><strong>SET_AIRBASE:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_AIRBASE).GetObjectNames" ><strong>SET_AIRBASE:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).GetRandom" ><strong>SET_AIRBASE:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_AIRBASE).GetSet" ><strong>SET_AIRBASE:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).GetSetNames" ><strong>SET_AIRBASE:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).GetSetObjects" ><strong>SET_AIRBASE:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).IsIncludeObject" ><strong>SET_AIRBASE:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).New" ><strong>SET_AIRBASE:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).OnAfterAdded" ><strong>SET_AIRBASE:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).OnAfterRemoved" ><strong>SET_AIRBASE:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).Remove" ><strong>SET_AIRBASE:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_AIRBASE).SetDatabase" ><strong>SET_AIRBASE:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_AIRBASE).SetIteratorIntervals" ><strong>SET_AIRBASE:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_AIRBASE)._EventOnBirth" ><strong>SET_AIRBASE:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE)._EventOnDeadOrCrash" ><strong>SET_AIRBASE:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE)._FilterStart" ><strong>SET_AIRBASE:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_AIRBASE)._Find" ><strong>SET_AIRBASE:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_AIRBASE).ClearState" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).CreateEventBirth" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).CreateEventCrash" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).CreateEventDead" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).CreateEventRemoveUnit" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).CreateEventTakeoff" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).E" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).EventDispatcher" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).EventRemoveAll" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).F" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).F2" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).F3" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).GetClassID" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).GetClassName" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).GetClassNameAndID" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).GetEventPriority" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).GetParent" ><strong>SET_AIRBASE: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>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>
<strong><strong>FromClass</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="##(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="#(SET_AIRBASE).GetState" ><strong>SET_AIRBASE: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, nillified 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="#(SET_AIRBASE).HandleEvent" ><strong>SET_AIRBASE:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_AIRBASE).I" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).Inherit" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).IsInstanceOf" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).IsTrace" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).New" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEvent" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventBaseCaptured" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventBirth" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventCrash" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventDead" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventEjection" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventEngineShutdown" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventEngineStartup" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventHit" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventHumanFailure" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventLand" ><strong>SET_AIRBASE:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_AIRBASE).OnEventMissionEnd" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventMissionStart" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventPilotDead" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventPlayerEnterUnit" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventPlayerLeaveUnit" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventRefueling" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventRefuelingStop" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).OnEventShootingEnd" ><strong>SET_AIRBASE: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 shooing. </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="#(SET_AIRBASE).OnEventShootingStart" ><strong>SET_AIRBASE:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_AIRBASE).OnEventShot" ><strong>SET_AIRBASE:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_AIRBASE).OnEventTakeoff" ><strong>SET_AIRBASE: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_AIRBASE).ScheduleOnce" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).ScheduleRepeat" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).ScheduleStop" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).SetEventPriority" ><strong>SET_AIRBASE: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">
</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="#(SET_AIRBASE).SetState" ><strong>SET_AIRBASE: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, nillified 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="#(SET_AIRBASE).T" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).T2" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).T3" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).TraceAll" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).TraceClass" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).TraceClassMethod" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).TraceLevel" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).TraceOnOff" ><strong>SET_AIRBASE: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="#(SET_AIRBASE).UnHandleEvent" ><strong>SET_AIRBASE:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_AIRBASE)._F" ><strong>SET_AIRBASE:_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="#(SET_AIRBASE)._T" ><strong>SET_AIRBASE:_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="#(SET_AIRBASE).onEvent" ><strong>SET_AIRBASE:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_BASE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_BASE)">Type <strong>SET_BASE</strong></a></h2></div>
<div id= "#Types##SET_BASE" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Scheduler.html##(SCHEDULER)">Core.Scheduler#SCHEDULER</a>
<a id="#(SET_BASE).CallScheduler" ><strong>SET_BASE.CallScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).Database" ><strong>SET_BASE.Database</strong></a>
<p> Now base the new Set on the BaseSet</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).Filter" ><strong>SET_BASE.Filter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).List" ><strong>SET_BASE.List</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).Set" ><strong>SET_BASE.Set</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).TimeInterval" ><strong>SET_BASE.TimeInterval</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).YieldInterval" ><strong>SET_BASE.YieldInterval</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="#(SET_BASE).Add" ><strong>SET_BASE:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_BASE).AddObject" ><strong>SET_BASE:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_BASE).Count" ><strong>SET_BASE:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).FilterCrashes" ><strong>SET_BASE:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).FilterDeads" ><strong>SET_BASE:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).FilterOnce" ><strong>SET_BASE:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).FilterStop" ><strong>SET_BASE:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).FindNearestObjectFromPointVec2" ><strong>SET_BASE:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_BASE).Flush" ><strong>SET_BASE:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).ForEach" ><strong>SET_BASE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_BASE).Get" ><strong>SET_BASE:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_BASE).GetFirst" ><strong>SET_BASE:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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.Base.html##(BASE)">Core.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="#(SET_BASE).GetLast" ><strong>SET_BASE:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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.Base.html##(BASE)">Core.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="#(SET_BASE).GetObjectNames" ><strong>SET_BASE:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).GetRandom" ><strong>SET_BASE:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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.Base.html##(BASE)">Core.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="#(SET_BASE).GetSet" ><strong>SET_BASE:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).GetSetNames" ><strong>SET_BASE:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).GetSetObjects" ><strong>SET_BASE:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE).IsIncludeObject" ><strong>SET_BASE:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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>Object</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="##(SET_BASE)">#SET_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="#(SET_BASE).New" ><strong>SET_BASE:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_BASE</p>
</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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).OnAfterAdded" ><strong>SET_BASE:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).OnAfterRemoved" ><strong>SET_BASE:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</div>
<h2><strong>Parameters:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).Remove" ><strong>SET_BASE:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_BASE).SetDatabase" ><strong>SET_BASE:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_BASE).SetIteratorIntervals" ><strong>SET_BASE:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_BASE)._EventOnBirth" ><strong>SET_BASE:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE)._EventOnDeadOrCrash" ><strong>SET_BASE:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</p>
</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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE)._FilterStart" ><strong>SET_BASE:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_BASE</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="##(SET_BASE)">#SET_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="#(SET_BASE)._Find" ><strong>SET_BASE:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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>SET_BASE</p>
</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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Scheduler.html##(SCHEDULER)">Core.Scheduler#SCHEDULER</a>
<a id="#(SET_BASE).CallScheduler" ><strong>SET_BASE.CallScheduler</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).Database" ><strong>SET_BASE.Database</strong></a>
<p> Now base the new Set on the BaseSet</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).Filter" ><strong>SET_BASE.Filter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).List" ><strong>SET_BASE.List</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(SET_BASE).Set" ><strong>SET_BASE.Set</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).TimeInterval" ><strong>SET_BASE.TimeInterval</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(SET_BASE).YieldInterval" ><strong>SET_BASE.YieldInterval</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="#(SET_BASE).ClearState" ><strong>SET_BASE: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="#(SET_BASE).CreateEventBirth" ><strong>SET_BASE: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="#(SET_BASE).CreateEventCrash" ><strong>SET_BASE: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="#(SET_BASE).CreateEventDead" ><strong>SET_BASE: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="#(SET_BASE).CreateEventRemoveUnit" ><strong>SET_BASE: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="#(SET_BASE).CreateEventTakeoff" ><strong>SET_BASE: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="#(SET_BASE).E" ><strong>SET_BASE: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="#(SET_BASE).EventDispatcher" ><strong>SET_BASE: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="#(SET_BASE).EventRemoveAll" ><strong>SET_BASE: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="#(SET_BASE).F" ><strong>SET_BASE: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="#(SET_BASE).F2" ><strong>SET_BASE: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="#(SET_BASE).F3" ><strong>SET_BASE: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="#(SET_BASE).GetClassID" ><strong>SET_BASE: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="#(SET_BASE).GetClassName" ><strong>SET_BASE: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="#(SET_BASE).GetClassNameAndID" ><strong>SET_BASE: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="#(SET_BASE).GetEventPriority" ><strong>SET_BASE: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="#(SET_BASE).GetParent" ><strong>SET_BASE: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>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>
<strong><strong>FromClass</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="##(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="#(SET_BASE).GetState" ><strong>SET_BASE: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, nillified 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="#(SET_BASE).HandleEvent" ><strong>SET_BASE:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_BASE).I" ><strong>SET_BASE: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="#(SET_BASE).Inherit" ><strong>SET_BASE: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="#(SET_BASE).IsInstanceOf" ><strong>SET_BASE: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="#(SET_BASE).IsTrace" ><strong>SET_BASE: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="#(SET_BASE).New" ><strong>SET_BASE: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="#(SET_BASE).OnEvent" ><strong>SET_BASE: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="#(SET_BASE).OnEventBaseCaptured" ><strong>SET_BASE: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="#(SET_BASE).OnEventBirth" ><strong>SET_BASE: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="#(SET_BASE).OnEventCrash" ><strong>SET_BASE: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="#(SET_BASE).OnEventDead" ><strong>SET_BASE: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="#(SET_BASE).OnEventEjection" ><strong>SET_BASE: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="#(SET_BASE).OnEventEngineShutdown" ><strong>SET_BASE: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="#(SET_BASE).OnEventEngineStartup" ><strong>SET_BASE: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="#(SET_BASE).OnEventHit" ><strong>SET_BASE: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="#(SET_BASE).OnEventHumanFailure" ><strong>SET_BASE: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="#(SET_BASE).OnEventLand" ><strong>SET_BASE:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_BASE).OnEventMissionEnd" ><strong>SET_BASE: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="#(SET_BASE).OnEventMissionStart" ><strong>SET_BASE: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="#(SET_BASE).OnEventPilotDead" ><strong>SET_BASE: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="#(SET_BASE).OnEventPlayerEnterUnit" ><strong>SET_BASE: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="#(SET_BASE).OnEventPlayerLeaveUnit" ><strong>SET_BASE: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="#(SET_BASE).OnEventRefueling" ><strong>SET_BASE: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="#(SET_BASE).OnEventRefuelingStop" ><strong>SET_BASE: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="#(SET_BASE).OnEventShootingEnd" ><strong>SET_BASE: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 shooing. </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="#(SET_BASE).OnEventShootingStart" ><strong>SET_BASE:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_BASE).OnEventShot" ><strong>SET_BASE:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_BASE).OnEventTakeoff" ><strong>SET_BASE: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_BASE).ScheduleOnce" ><strong>SET_BASE: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="#(SET_BASE).ScheduleRepeat" ><strong>SET_BASE: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="#(SET_BASE).ScheduleStop" ><strong>SET_BASE: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="#(SET_BASE).SetEventPriority" ><strong>SET_BASE: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">
</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="#(SET_BASE).SetState" ><strong>SET_BASE: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, nillified 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="#(SET_BASE).T" ><strong>SET_BASE: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="#(SET_BASE).T2" ><strong>SET_BASE: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="#(SET_BASE).T3" ><strong>SET_BASE: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="#(SET_BASE).TraceAll" ><strong>SET_BASE: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="#(SET_BASE).TraceClass" ><strong>SET_BASE: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="#(SET_BASE).TraceClassMethod" ><strong>SET_BASE: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="#(SET_BASE).TraceLevel" ><strong>SET_BASE: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="#(SET_BASE).TraceOnOff" ><strong>SET_BASE: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="#(SET_BASE).UnHandleEvent" ><strong>SET_BASE:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_BASE)._F" ><strong>SET_BASE:_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="#(SET_BASE)._T" ><strong>SET_BASE:_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="#(SET_BASE).onEvent" ><strong>SET_BASE:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_CARGO')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_CARGO)">Type <strong>SET_CARGO</strong></a></h2></div>
<div id= "#Types##SET_CARGO" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CARGO).AddCargo" ><strong>SET_CARGO:AddCargo(Cargo)</strong></a></h2>
</div>
<p>(R2.1) Add CARGO to SET_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>SET_CARGO</p>
</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="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>
<strong><strong>Cargo</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single cargo.</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>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="#(SET_CARGO).AddCargosByName" ><strong>SET_CARGO:AddCargosByName(AddCargoNames)</strong></a></h2>
</div>
<p>(R2.1) Add CARGOs to SET_CARGO.</p>
<div id= "#Functions##AddCargosByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>AddCargoNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CARGO names.</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>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="#(SET_CARGO).AddInDatabase" ><strong>SET_CARGO:AddInDatabase(Event)</strong></a></h2>
</div>
<p>(R2.1) Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CARGO</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The CARGO</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).FilterCoalitions" ><strong>SET_CARGO:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>(R2.1) Builds a set of cargos of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FilterCountries" ><strong>SET_CARGO:FilterCountries(Countries)</strong></a></h2>
</div>
<p>(R2.1) Builds a set of cargos of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FilterPrefixes" ><strong>SET_CARGO:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>(R2.1) Builds a set of cargos of defined cargo prefixes.</p>
<p>All the cargos starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the cargo name starts with.</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FilterStart" ><strong>SET_CARGO:FilterStart()</strong></a></h2>
</div>
<p>(R2.1) Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FilterStop" ><strong>SET_CARGO:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FilterTypes" ><strong>SET_CARGO:FilterTypes(Types)</strong></a></h2>
</div>
<p>(R2.1) Builds a set of cargos of defined cargo types.</p>
<p>Possible current types are those types known within DCS world.</p>
<div id= "#Functions##FilterTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Types</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those type strings known within DCS world.</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).FindCargo" ><strong>SET_CARGO:FindCargo(CargoName)</strong></a></h2>
</div>
<p>(R2.1) Finds a Cargo based on the Cargo Name.</p>
<div id= "#Functions##FindCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>CargoName</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.Cargo.html##(CARGO)">Wrapper.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The found 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="#(SET_CARGO).FindInDatabase" ><strong>SET_CARGO:FindInDatabase(Event)</strong></a></h2>
</div>
<p>(R2.1) Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CARGO</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The CARGO</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).FindNearestCargoFromPointVec2" ><strong>SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>(R2.1) Iterate the SET_CARGO while identifying the nearest <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestCargoFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="Wrapper.Cargo.html##(CARGO)">Wrapper.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The closest <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="#(SET_CARGO).FirstCargoDeployed" ><strong>SET_CARGO:FirstCargoDeployed()</strong></a></h2>
</div>
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is Deployed.</p>
<div id= "#Functions##FirstCargoDeployed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="#(SET_CARGO).FirstCargoLoaded" ><strong>SET_CARGO:FirstCargoLoaded()</strong></a></h2>
</div>
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is Loaded.</p>
<div id= "#Functions##FirstCargoLoaded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="#(SET_CARGO).FirstCargoUnLoaded" ><strong>SET_CARGO:FirstCargoUnLoaded()</strong></a></h2>
</div>
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is UnLoaded.</p>
<div id= "#Functions##FirstCargoUnLoaded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="#(SET_CARGO).FirstCargoUnLoadedAndNotDeployed" ><strong>SET_CARGO:FirstCargoUnLoadedAndNotDeployed()</strong></a></h2>
</div>
<p>Iterate the SET_CARGO while identifying the first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a> that is UnLoaded and not Deployed.</p>
<div id= "#Functions##FirstCargoUnLoadedAndNotDeployed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</a>:</p>
</div>
<div class="w3-half">
<p>The first <a href="Cargo.Cargo.html##(CARGO)">Cargo.Cargo#CARGO</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="#(SET_CARGO).FirstCargoWithState" ><strong>SET_CARGO:FirstCargoWithState(State)</strong></a></h2>
</div>
<div id= "#Functions##FirstCargoWithState" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>State</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="#(SET_CARGO).FirstCargoWithStateAndNotDeployed" ><strong>SET_CARGO:FirstCargoWithStateAndNotDeployed(State)</strong></a></h2>
</div>
<div id= "#Functions##FirstCargoWithStateAndNotDeployed" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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>State</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="#(SET_CARGO).ForEachCargo" ><strong>SET_CARGO:ForEachCargo(IteratorFunction, ...)</strong></a></h2>
</div>
<p>(R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.</p>
<div id= "#Functions##ForEachCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CARGO in the SET_CARGO. The function needs to accept a CARGO parameter.</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).IsIncludeObject" ><strong>SET_CARGO:IsIncludeObject(MCargo)</strong></a></h2>
</div>
<p>(R2.1) </p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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="AI.AI_Cargo.html##(AI_CARGO)">AI.AI_Cargo#AI_CARGO</a>
<strong><strong>MCargo</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="##(SET_CARGO)">#SET_CARGO</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="#(SET_CARGO).New" ><strong>SET_CARGO:New()</strong></a></h2>
</div>
<p>Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.</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>SET_CARGO</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="##(SET_CARGO)">#SET_CARGO</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_CARGO Object. The DatabaseSet will contain a reference to all Cargos.
DatabaseSet = SET_CARGO:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).OnEventDeleteCargo" ><strong>SET_CARGO:OnEventDeleteCargo(EventData)</strong></a></h2>
</div>
<p>(R2.1) Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##OnEventDeleteCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).OnEventNewCargo" ><strong>SET_CARGO:OnEventNewCargo(EventData)</strong></a></h2>
</div>
<p>(R2.1) Handles the OnEventNewCargo event for the Set.</p>
<div id= "#Functions##OnEventNewCargo" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).RemoveCargosByName" ><strong>SET_CARGO:RemoveCargosByName(RemoveCargoNames)</strong></a></h2>
</div>
<p>(R2.1) Remove CARGOs from SET_CARGO.</p>
<div id= "#Functions##RemoveCargosByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_CARGO</p>
</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.Cargo.html##(CARGO)">Wrapper.Cargo#CARGO</a>
<strong><strong>RemoveCargoNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CARGO names.</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>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CARGO).Add" ><strong>SET_CARGO:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_CARGO).AddObject" ><strong>SET_CARGO:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_CARGO).Count" ><strong>SET_CARGO:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).FilterCrashes" ><strong>SET_CARGO:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).FilterDeads" ><strong>SET_CARGO:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).FilterOnce" ><strong>SET_CARGO:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).FilterStop" ><strong>SET_CARGO:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).FindNearestObjectFromPointVec2" ><strong>SET_CARGO:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_CARGO).Flush" ><strong>SET_CARGO:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).ForEach" ><strong>SET_CARGO:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_CARGO).Get" ><strong>SET_CARGO:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_CARGO).GetFirst" ><strong>SET_CARGO:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CARGO).GetLast" ><strong>SET_CARGO:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CARGO).GetObjectNames" ><strong>SET_CARGO:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).GetRandom" ><strong>SET_CARGO:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CARGO).GetSet" ><strong>SET_CARGO:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).GetSetNames" ><strong>SET_CARGO:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).GetSetObjects" ><strong>SET_CARGO:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO).IsIncludeObject" ><strong>SET_CARGO:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_CARGO).New" ><strong>SET_CARGO:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).OnAfterAdded" ><strong>SET_CARGO:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).OnAfterRemoved" ><strong>SET_CARGO:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).Remove" ><strong>SET_CARGO:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_CARGO).SetDatabase" ><strong>SET_CARGO:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_CARGO).SetIteratorIntervals" ><strong>SET_CARGO:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_CARGO)._EventOnBirth" ><strong>SET_CARGO:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO)._EventOnDeadOrCrash" ><strong>SET_CARGO:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO)._FilterStart" ><strong>SET_CARGO:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CARGO)._Find" ><strong>SET_CARGO:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CARGO).ClearState" ><strong>SET_CARGO: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="#(SET_CARGO).CreateEventBirth" ><strong>SET_CARGO: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="#(SET_CARGO).CreateEventCrash" ><strong>SET_CARGO: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="#(SET_CARGO).CreateEventDead" ><strong>SET_CARGO: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="#(SET_CARGO).CreateEventRemoveUnit" ><strong>SET_CARGO: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="#(SET_CARGO).CreateEventTakeoff" ><strong>SET_CARGO: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="#(SET_CARGO).E" ><strong>SET_CARGO: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="#(SET_CARGO).EventDispatcher" ><strong>SET_CARGO: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="#(SET_CARGO).EventRemoveAll" ><strong>SET_CARGO: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="#(SET_CARGO).F" ><strong>SET_CARGO: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="#(SET_CARGO).F2" ><strong>SET_CARGO: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="#(SET_CARGO).F3" ><strong>SET_CARGO: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="#(SET_CARGO).GetClassID" ><strong>SET_CARGO: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="#(SET_CARGO).GetClassName" ><strong>SET_CARGO: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="#(SET_CARGO).GetClassNameAndID" ><strong>SET_CARGO: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="#(SET_CARGO).GetEventPriority" ><strong>SET_CARGO: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="#(SET_CARGO).GetParent" ><strong>SET_CARGO: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>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>
<strong><strong>FromClass</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="##(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="#(SET_CARGO).GetState" ><strong>SET_CARGO: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, nillified 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="#(SET_CARGO).HandleEvent" ><strong>SET_CARGO:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_CARGO).I" ><strong>SET_CARGO: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="#(SET_CARGO).Inherit" ><strong>SET_CARGO: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="#(SET_CARGO).IsInstanceOf" ><strong>SET_CARGO: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="#(SET_CARGO).IsTrace" ><strong>SET_CARGO: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="#(SET_CARGO).New" ><strong>SET_CARGO: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="#(SET_CARGO).OnEvent" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventBaseCaptured" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventBirth" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventCrash" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventDead" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventEjection" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventEngineShutdown" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventEngineStartup" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventHit" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventHumanFailure" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventLand" ><strong>SET_CARGO:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_CARGO).OnEventMissionEnd" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventMissionStart" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventPilotDead" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventPlayerEnterUnit" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventPlayerLeaveUnit" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventRefueling" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventRefuelingStop" ><strong>SET_CARGO: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="#(SET_CARGO).OnEventShootingEnd" ><strong>SET_CARGO: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 shooing. </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="#(SET_CARGO).OnEventShootingStart" ><strong>SET_CARGO:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_CARGO).OnEventShot" ><strong>SET_CARGO:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_CARGO).OnEventTakeoff" ><strong>SET_CARGO: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CARGO).ScheduleOnce" ><strong>SET_CARGO: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="#(SET_CARGO).ScheduleRepeat" ><strong>SET_CARGO: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="#(SET_CARGO).ScheduleStop" ><strong>SET_CARGO: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="#(SET_CARGO).SetEventPriority" ><strong>SET_CARGO: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">
</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="#(SET_CARGO).SetState" ><strong>SET_CARGO: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, nillified 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="#(SET_CARGO).T" ><strong>SET_CARGO: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="#(SET_CARGO).T2" ><strong>SET_CARGO: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="#(SET_CARGO).T3" ><strong>SET_CARGO: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="#(SET_CARGO).TraceAll" ><strong>SET_CARGO: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="#(SET_CARGO).TraceClass" ><strong>SET_CARGO: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="#(SET_CARGO).TraceClassMethod" ><strong>SET_CARGO: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="#(SET_CARGO).TraceLevel" ><strong>SET_CARGO: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="#(SET_CARGO).TraceOnOff" ><strong>SET_CARGO: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="#(SET_CARGO).UnHandleEvent" ><strong>SET_CARGO:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_CARGO)._F" ><strong>SET_CARGO:_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="#(SET_CARGO)._T" ><strong>SET_CARGO:_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="#(SET_CARGO).onEvent" ><strong>SET_CARGO:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_CLIENT')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_CLIENT)">Type <strong>SET_CLIENT</strong></a></h2></div>
<div id= "#Types##SET_CLIENT" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CLIENT).AddClientsByName" ><strong>SET_CLIENT:AddClientsByName(AddClientNames)</strong></a></h2>
</div>
<p>Add CLIENT(s) to SET_CLIENT.</p>
<div id= "#Functions##AddClientsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>AddClientNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CLIENT names.</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>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="#(SET_CLIENT).AddInDatabase" ><strong>SET_CLIENT:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CLIENT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_CLIENT).FilterActive" ><strong>SET_CLIENT:FilterActive(Active)</strong></a></h2>
</div>
<p>Builds a set of clients that are only active.</p>
<p>Only the clients that are active will be included within the set.</p>
<div id= "#Functions##FilterActive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>
#boolean
<strong><strong>Active</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Include only active clients to the set.
Include inactive clients if you provide 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="##(SET_CLIENT)">#SET_CLIENT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Include only active clients to the set.
ClientSet = SET_CLIENT:New():FilterActive():FilterStart()
-- Include only active clients to the set of the blue coalition, and filter one time.
ClientSet = SET_CLIENT:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
-- Include only active clients to the set of the blue coalition, and filter one time.
-- Later, reset to include back inactive clients to the set.
ClientSet = SET_CLIENT:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
... logic ...
ClientSet = SET_CLIENT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterOnce()
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).FilterCategories" ><strong>SET_CLIENT:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of clients out of categories.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "plane", "helicopter", "ground", "ship".</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FilterCoalitions" ><strong>SET_CLIENT:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of clients of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FilterCountries" ><strong>SET_CLIENT:FilterCountries(Countries)</strong></a></h2>
</div>
<p>Builds a set of clients of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FilterPrefixes" ><strong>SET_CLIENT:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of clients of defined client prefixes.</p>
<p>All the clients starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the client name starts with.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FilterStart" ><strong>SET_CLIENT:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FilterTypes" ><strong>SET_CLIENT:FilterTypes(Types)</strong></a></h2>
</div>
<p>Builds a set of clients of defined client types.</p>
<p>Possible current types are those types known within DCS world.</p>
<div id= "#Functions##FilterTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>Types</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those type strings known within DCS world.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).FindClient" ><strong>SET_CLIENT:FindClient(ClientName)</strong></a></h2>
</div>
<p>Finds a Client based on the Client Name.</p>
<div id= "#Functions##FindClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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></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.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>:</p>
</div>
<div class="w3-half">
<p>The found 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="#(SET_CLIENT).FindInDatabase" ><strong>SET_CLIENT:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CLIENT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_CLIENT).ForEachClient" ><strong>SET_CLIENT:ForEachClient(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_CLIENT and call an interator function for each <strong>alive</strong> CLIENT, providing the CLIENT and optional parameters.</p>
<div id= "#Functions##ForEachClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_CLIENT. The function needs to accept a CLIENT parameter.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).ForEachClientInZone" ><strong>SET_CLIENT:ForEachClientInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_CLIENT and call an iterator function for each <strong>alive</strong> CLIENT presence completely in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachClientInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
<strong><strong>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_CLIENT. The function needs to accept a CLIENT parameter.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).ForEachClientNotInZone" ><strong>SET_CLIENT:ForEachClientNotInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_CLIENT and call an iterator function for each <strong>alive</strong> CLIENT presence not in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachClientNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
<strong><strong>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_CLIENT. The function needs to accept a CLIENT parameter.</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).IsIncludeObject" ><strong>SET_CLIENT:IsIncludeObject(MClient)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>MClient</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="##(SET_CLIENT)">#SET_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="#(SET_CLIENT).New" ><strong>SET_CLIENT:New()</strong></a></h2>
</div>
<p>Creates a new SET_CLIENT object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_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="##(SET_CLIENT)">#SET_CLIENT</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_CLIENT Object. This DBObject will contain a reference to all Clients.
DBObject = SET_CLIENT:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).RemoveClientsByName" ><strong>SET_CLIENT:RemoveClientsByName(RemoveClientNames)</strong></a></h2>
</div>
<p>Remove CLIENT(s) from SET_CLIENT.</p>
<div id= "#Functions##RemoveClientsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_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>
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>RemoveClientNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CLIENT names.</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>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CLIENT).Add" ><strong>SET_CLIENT:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_CLIENT).AddObject" ><strong>SET_CLIENT:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_CLIENT).Count" ><strong>SET_CLIENT:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).FilterCrashes" ><strong>SET_CLIENT:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).FilterDeads" ><strong>SET_CLIENT:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).FilterOnce" ><strong>SET_CLIENT:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).FilterStop" ><strong>SET_CLIENT:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).FindNearestObjectFromPointVec2" ><strong>SET_CLIENT:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_CLIENT).Flush" ><strong>SET_CLIENT:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).ForEach" ><strong>SET_CLIENT:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_CLIENT).Get" ><strong>SET_CLIENT:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_CLIENT).GetFirst" ><strong>SET_CLIENT:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CLIENT).GetLast" ><strong>SET_CLIENT:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CLIENT).GetObjectNames" ><strong>SET_CLIENT:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).GetRandom" ><strong>SET_CLIENT:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_CLIENT).GetSet" ><strong>SET_CLIENT:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).GetSetNames" ><strong>SET_CLIENT:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).GetSetObjects" ><strong>SET_CLIENT:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT).IsIncludeObject" ><strong>SET_CLIENT:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_CLIENT).New" ><strong>SET_CLIENT:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).OnAfterAdded" ><strong>SET_CLIENT:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).OnAfterRemoved" ><strong>SET_CLIENT:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).Remove" ><strong>SET_CLIENT:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_CLIENT).SetDatabase" ><strong>SET_CLIENT:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_CLIENT).SetIteratorIntervals" ><strong>SET_CLIENT:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_CLIENT)._EventOnBirth" ><strong>SET_CLIENT:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT)._EventOnDeadOrCrash" ><strong>SET_CLIENT:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT)._FilterStart" ><strong>SET_CLIENT:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_CLIENT)._Find" ><strong>SET_CLIENT:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_CLIENT).ClearState" ><strong>SET_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="#(SET_CLIENT).CreateEventBirth" ><strong>SET_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="#(SET_CLIENT).CreateEventCrash" ><strong>SET_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="#(SET_CLIENT).CreateEventDead" ><strong>SET_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="#(SET_CLIENT).CreateEventRemoveUnit" ><strong>SET_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="#(SET_CLIENT).CreateEventTakeoff" ><strong>SET_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="#(SET_CLIENT).E" ><strong>SET_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="#(SET_CLIENT).EventDispatcher" ><strong>SET_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="#(SET_CLIENT).EventRemoveAll" ><strong>SET_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="#(SET_CLIENT).F" ><strong>SET_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="#(SET_CLIENT).F2" ><strong>SET_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="#(SET_CLIENT).F3" ><strong>SET_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="#(SET_CLIENT).GetClassID" ><strong>SET_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="#(SET_CLIENT).GetClassName" ><strong>SET_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="#(SET_CLIENT).GetClassNameAndID" ><strong>SET_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="#(SET_CLIENT).GetEventPriority" ><strong>SET_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="#(SET_CLIENT).GetParent" ><strong>SET_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>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>
<strong><strong>FromClass</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="##(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="#(SET_CLIENT).GetState" ><strong>SET_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, nillified 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="#(SET_CLIENT).HandleEvent" ><strong>SET_CLIENT:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_CLIENT).I" ><strong>SET_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="#(SET_CLIENT).Inherit" ><strong>SET_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="#(SET_CLIENT).IsInstanceOf" ><strong>SET_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="#(SET_CLIENT).IsTrace" ><strong>SET_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="#(SET_CLIENT).New" ><strong>SET_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="#(SET_CLIENT).OnEvent" ><strong>SET_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="#(SET_CLIENT).OnEventBaseCaptured" ><strong>SET_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="#(SET_CLIENT).OnEventBirth" ><strong>SET_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="#(SET_CLIENT).OnEventCrash" ><strong>SET_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="#(SET_CLIENT).OnEventDead" ><strong>SET_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="#(SET_CLIENT).OnEventEjection" ><strong>SET_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="#(SET_CLIENT).OnEventEngineShutdown" ><strong>SET_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="#(SET_CLIENT).OnEventEngineStartup" ><strong>SET_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="#(SET_CLIENT).OnEventHit" ><strong>SET_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="#(SET_CLIENT).OnEventHumanFailure" ><strong>SET_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="#(SET_CLIENT).OnEventLand" ><strong>SET_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
place: Object that the unit landed on.</p>
<p>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="#(SET_CLIENT).OnEventMissionEnd" ><strong>SET_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="#(SET_CLIENT).OnEventMissionStart" ><strong>SET_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="#(SET_CLIENT).OnEventPilotDead" ><strong>SET_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="#(SET_CLIENT).OnEventPlayerEnterUnit" ><strong>SET_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="#(SET_CLIENT).OnEventPlayerLeaveUnit" ><strong>SET_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="#(SET_CLIENT).OnEventRefueling" ><strong>SET_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="#(SET_CLIENT).OnEventRefuelingStop" ><strong>SET_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="#(SET_CLIENT).OnEventShootingEnd" ><strong>SET_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 shooing. </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="#(SET_CLIENT).OnEventShootingStart" ><strong>SET_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), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_CLIENT).OnEventShot" ><strong>SET_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 autocannon 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="#(SET_CLIENT).OnEventTakeoff" ><strong>SET_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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_CLIENT).ScheduleOnce" ><strong>SET_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="#(SET_CLIENT).ScheduleRepeat" ><strong>SET_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="#(SET_CLIENT).ScheduleStop" ><strong>SET_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="#(SET_CLIENT).SetEventPriority" ><strong>SET_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">
</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="#(SET_CLIENT).SetState" ><strong>SET_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, nillified 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="#(SET_CLIENT).T" ><strong>SET_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="#(SET_CLIENT).T2" ><strong>SET_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="#(SET_CLIENT).T3" ><strong>SET_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="#(SET_CLIENT).TraceAll" ><strong>SET_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="#(SET_CLIENT).TraceClass" ><strong>SET_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="#(SET_CLIENT).TraceClassMethod" ><strong>SET_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="#(SET_CLIENT).TraceLevel" ><strong>SET_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="#(SET_CLIENT).TraceOnOff" ><strong>SET_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="#(SET_CLIENT).UnHandleEvent" ><strong>SET_CLIENT:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_CLIENT)._F" ><strong>SET_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="#(SET_CLIENT)._T" ><strong>SET_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="#(SET_CLIENT).onEvent" ><strong>SET_CLIENT:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_GROUP')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_GROUP)">Type <strong>SET_GROUP</strong></a></h2></div>
<div id= "#Types##SET_GROUP" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_GROUP).AddGroup" ><strong>SET_GROUP:AddGroup(group)</strong></a></h2>
</div>
<p>Add a GROUP to SET_GROUP.</p>
<p>Note that for each unit in the group that is set, a default cargo bay limit is initialized.</p>
<div id= "#Functions##AddGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>group</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The group which should be added to the set.</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>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="#(SET_GROUP).AddGroupsByName" ><strong>SET_GROUP:AddGroupsByName(AddGroupNames)</strong></a></h2>
</div>
<p>Add GROUP(s) to SET_GROUP.</p>
<div id= "#Functions##AddGroupsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>AddGroupNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of GROUP names.</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>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="#(SET_GROUP).AddInDatabase" ><strong>SET_GROUP:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the GROUP</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The GROUP</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).AllCompletelyInZone" ><strong>SET_GROUP:AllCompletelyInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and return true if all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completely in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
<div id= "#Functions##AllCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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 all the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> are completly in the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
if MySetGroup:AllCompletelyInZone(MyZone) then
MESSAGE:New("All the SET's GROUP are in zone !", 10):ToAll()
else
MESSAGE:New("Some or all SET's GROUP are outside zone !", 10):ToAll()
end</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).AnyCompletelyInZone" ><strong>SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and return true if at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completely inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a></p>
<div id= "#Functions##AnyCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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 at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is completly inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
if MySetGroup:AnyCompletelyInZone(MyZone) then
MESSAGE:New("At least one GROUP is completely in zone !", 10):ToAll()
else
MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
end</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).AnyInZone" ><strong>SET_GROUP:AnyInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and return true if at least one <a href="##(UNIT)">#UNIT</a> of one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a></p>
<div id= "#Functions##AnyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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 at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is partly or completly inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
if MySetGroup:AnyPartlyInZone(MyZone) then
MESSAGE:New("At least one GROUP has at least one UNIT in zone !", 10):ToAll()
else
MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
end</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).AnyPartlyInZone" ><strong>SET_GROUP:AnyPartlyInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and return true if at least one <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is partly in <a href="ZONE.html">ZONE</a>.</p>
<p>Will return false if a <a href="GROUP.html">GROUP</a> is fully in the <a href="ZONE.html">ZONE</a></p>
<div id= "#Functions##AnyPartlyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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 at least one of the <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is partly or completly inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>, false otherwise.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
if MySetGroup:AnyPartlyInZone(MyZone) then
MESSAGE:New("At least one GROUP is partially in the zone, but none are fully in it !", 10):ToAll()
else
MESSAGE:New("No GROUP are in zone, or one (or more) GROUP is completely in it !", 10):ToAll()
end</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).CountInZone" ><strong>SET_GROUP:CountInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and count how many GROUPs are completely in the Zone
That could easily be done with SET_GROUP:ForEachGroupCompletelyInZone(), but this function
provides an easy to use shortcut...</p>
<div id= "#Functions##CountInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>the number of GROUPs completely in the Zone</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
MESSAGE:New("There are " .. MySetGroup:CountInZone(MyZone) .. " GROUPs in the Zone !", 10):ToAll()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).CountUnitInZone" ><strong>SET_GROUP:CountUnitInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and count how many UNITs are completely in the Zone</p>
<div id= "#Functions##CountUnitInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>the number of GROUPs completely in the Zone</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
MESSAGE:New("There are " .. MySetGroup:CountUnitInZone(MyZone) .. " UNITs in the Zone !", 10):ToAll()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).FilterActive" ><strong>SET_GROUP:FilterActive(Active)</strong></a></h2>
</div>
<p>Builds a set of groups that are only active.</p>
<p>Only the groups that are active will be included within the set.</p>
<div id= "#Functions##FilterActive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Active</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Include only active groups to the set.
Include inactive groups if you provide 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="##(SET_GROUP)">#SET_GROUP</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Include only active groups to the set.
GroupSet = SET_GROUP:New():FilterActive():FilterStart()
-- Include only active groups to the set of the blue coalition, and filter one time.
GroupSet = SET_GROUP:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
-- Include only active groups to the set of the blue coalition, and filter one time.
-- Later, reset to include back inactive groups to the set.
GroupSet = SET_GROUP:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
... logic ...
GroupSet = SET_GROUP:New():FilterActive( false ):FilterCoalition( "blue" ):FilterOnce()
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).FilterCategories" ><strong>SET_GROUP:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of groups out of categories.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "plane", "helicopter", "ground", "ship".</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCategoryAirplane" ><strong>SET_GROUP:FilterCategoryAirplane()</strong></a></h2>
</div>
<p>Builds a set of groups out of airplane category.</p>
<div id= "#Functions##FilterCategoryAirplane" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCategoryGround" ><strong>SET_GROUP:FilterCategoryGround()</strong></a></h2>
</div>
<p>Builds a set of groups out of ground category.</p>
<div id= "#Functions##FilterCategoryGround" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCategoryHelicopter" ><strong>SET_GROUP:FilterCategoryHelicopter()</strong></a></h2>
</div>
<p>Builds a set of groups out of helicopter category.</p>
<div id= "#Functions##FilterCategoryHelicopter" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCategoryShip" ><strong>SET_GROUP:FilterCategoryShip()</strong></a></h2>
</div>
<p>Builds a set of groups out of ship category.</p>
<div id= "#Functions##FilterCategoryShip" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCategoryStructure" ><strong>SET_GROUP:FilterCategoryStructure()</strong></a></h2>
</div>
<p>Builds a set of groups out of structure category.</p>
<div id= "#Functions##FilterCategoryStructure" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCoalitions" ><strong>SET_GROUP:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of groups of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterCountries" ><strong>SET_GROUP:FilterCountries(Countries)</strong></a></h2>
</div>
<p>Builds a set of groups of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterPrefixes" ><strong>SET_GROUP:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of groups of defined GROUP prefixes.</p>
<p>All the groups starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the group name starts with.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FilterStart" ><strong>SET_GROUP:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).FindGroup" ><strong>SET_GROUP:FindGroup(GroupName)</strong></a></h2>
</div>
<p>Finds a Group based on the Group Name.</p>
<div id= "#Functions##FindGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>GroupName</strong></strong>
</p>
</div>
<div class="w3-half">
<p></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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
</div>
<div class="w3-half">
<p>The found Group.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).FindInDatabase" ><strong>SET_GROUP:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the GROUP</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The GROUP</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).FindNearestGroupFromPointVec2" ><strong>SET_GROUP:FindNearestGroupFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestGroupFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
</div>
<div class="w3-half">
<p>The closest group.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).ForEachGroup" ><strong>SET_GROUP:ForEachGroup(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each GROUP object, providing the GROUP and optional parameters.</p>
<div id= "#Functions##ForEachGroup" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).ForEachGroupAlive" ><strong>SET_GROUP:ForEachGroupAlive(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP object, providing the GROUP and optional parameters.</p>
<div id= "#Functions##ForEachGroupAlive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).ForEachGroupAnyInZone" ><strong>SET_GROUP:ForEachGroupAnyInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each alive GROUP that has any unit in the <a href="Core.Zone.html">Core.Zone</a>, providing the GROUP and optional parameters to the called function.</p>
<div id= "#Functions##ForEachGroupAnyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).ForEachGroupCompletelyInZone" ><strong>SET_GROUP:ForEachGroupCompletelyInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence completely in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
<div id= "#Functions##ForEachGroupCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).ForEachGroupNotInZone" ><strong>SET_GROUP:ForEachGroupNotInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence not in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
<div id= "#Functions##ForEachGroupNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).ForEachGroupPartlyInZone" ><strong>SET_GROUP:ForEachGroupPartlyInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and call an iterator function for each <strong>alive</strong> GROUP presence partly in a <a href="Zone.html">Zone</a>, providing the GROUP and optional parameters to the called function.</p>
<div id= "#Functions##ForEachGroupPartlyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive GROUP in the SET_GROUP. The function needs to accept a GROUP parameter.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).GetAliveSet" ><strong>SET_GROUP:GetAliveSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetAliveSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).IsIncludeObject" ><strong>SET_GROUP:IsIncludeObject(MGroup)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>MGroup</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The group that is checked for inclusion.</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="##(SET_GROUP)">#SET_GROUP</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="#(SET_GROUP).New" ><strong>SET_GROUP:New()</strong></a></h2>
</div>
<p>Creates a new SET_GROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_GROUP</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="##(SET_GROUP)">#SET_GROUP</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_GROUP Object. This DBObject will contain a reference to all alive GROUPS.
DBObject = SET_GROUP:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).NoneInZone" ><strong>SET_GROUP:NoneInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and return true if no <a href="GROUP.html">GROUP</a> of the <a href="SET_GROUP.html">SET_GROUP</a> is in <a href="ZONE.html">ZONE</a>
This could also be achieved with <code>not SET_GROUP:AnyPartlyInZone(Zone)</code>, but it's easier for the
mission designer to add a dedicated method</p>
<div id= "#Functions##NoneInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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 no <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a> is inside the <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> in any way, false otherwise.</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>local MyZone = ZONE:New("Zone1")
local MySetGroup = SET_GROUP:New()
MySetGroup:AddGroupsByName({"Group1", "Group2"})
if MySetGroup:NoneInZone(MyZone) then
MESSAGE:New("No GROUP is completely in zone !", 10):ToAll()
else
MESSAGE:New("No UNIT of any GROUP is in zone !", 10):ToAll()
end</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).RemoveGroupsByName" ><strong>SET_GROUP:RemoveGroupsByName(RemoveGroupNames)</strong></a></h2>
</div>
<p>Remove GROUP(s) from SET_GROUP.</p>
<div id= "#Functions##RemoveGroupsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
<strong><strong>RemoveGroupNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of GROUP names.</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>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="#(SET_GROUP).SetCargoBayWeightLimit" ><strong>SET_GROUP:SetCargoBayWeightLimit()</strong></a></h2>
</div>
<p>Iterate the SET_GROUP and set for each unit the default cargo bay weight limit.</p>
<p>Because within a group, the type of carriers can differ, each cargo bay weight limit is set on <a href="Wrapper.Unit.html">Wrapper.Unit</a> level.</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>SET_GROUP</p>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Set the default cargo bay weight limits of the carrier units.
local MySetGroup = SET_GROUP:New()
MySetGroup:SetCargoBayWeightLimit()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP)._EventOnDeadOrCrash" ><strong>SET_GROUP:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive groups set.</p>
<p>Note: The GROUP object in the SET_GROUP collection will only be removed if the last unit is destroyed of the GROUP.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_GROUP</p>
</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>Event</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 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="#(SET_GROUP).Add" ><strong>SET_GROUP:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_GROUP).AddObject" ><strong>SET_GROUP:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_GROUP).Count" ><strong>SET_GROUP:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).FilterCrashes" ><strong>SET_GROUP:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).FilterDeads" ><strong>SET_GROUP:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).FilterOnce" ><strong>SET_GROUP:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).FilterStop" ><strong>SET_GROUP:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).FindNearestObjectFromPointVec2" ><strong>SET_GROUP:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_GROUP).Flush" ><strong>SET_GROUP:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).ForEach" ><strong>SET_GROUP:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_GROUP).Get" ><strong>SET_GROUP:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_GROUP).GetFirst" ><strong>SET_GROUP:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_GROUP).GetLast" ><strong>SET_GROUP:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_GROUP).GetObjectNames" ><strong>SET_GROUP:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).GetRandom" ><strong>SET_GROUP:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_GROUP).GetSet" ><strong>SET_GROUP:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).GetSetNames" ><strong>SET_GROUP:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).GetSetObjects" ><strong>SET_GROUP:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP).IsIncludeObject" ><strong>SET_GROUP:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_GROUP).New" ><strong>SET_GROUP:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).OnAfterAdded" ><strong>SET_GROUP:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).OnAfterRemoved" ><strong>SET_GROUP:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).Remove" ><strong>SET_GROUP:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_GROUP).SetDatabase" ><strong>SET_GROUP:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_GROUP).SetIteratorIntervals" ><strong>SET_GROUP:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_GROUP)._EventOnBirth" ><strong>SET_GROUP:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP)._EventOnDeadOrCrash" ><strong>SET_GROUP:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP)._FilterStart" ><strong>SET_GROUP:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_GROUP)._Find" ><strong>SET_GROUP:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_GROUP).ClearState" ><strong>SET_GROUP: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="#(SET_GROUP).CreateEventBirth" ><strong>SET_GROUP: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="#(SET_GROUP).CreateEventCrash" ><strong>SET_GROUP: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="#(SET_GROUP).CreateEventDead" ><strong>SET_GROUP: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="#(SET_GROUP).CreateEventRemoveUnit" ><strong>SET_GROUP: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="#(SET_GROUP).CreateEventTakeoff" ><strong>SET_GROUP: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="#(SET_GROUP).E" ><strong>SET_GROUP: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="#(SET_GROUP).EventDispatcher" ><strong>SET_GROUP: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="#(SET_GROUP).EventRemoveAll" ><strong>SET_GROUP: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="#(SET_GROUP).F" ><strong>SET_GROUP: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="#(SET_GROUP).F2" ><strong>SET_GROUP: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="#(SET_GROUP).F3" ><strong>SET_GROUP: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="#(SET_GROUP).GetClassID" ><strong>SET_GROUP: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="#(SET_GROUP).GetClassName" ><strong>SET_GROUP: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="#(SET_GROUP).GetClassNameAndID" ><strong>SET_GROUP: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="#(SET_GROUP).GetEventPriority" ><strong>SET_GROUP: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="#(SET_GROUP).GetParent" ><strong>SET_GROUP: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>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>
<strong><strong>FromClass</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="##(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="#(SET_GROUP).GetState" ><strong>SET_GROUP: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, nillified 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="#(SET_GROUP).HandleEvent" ><strong>SET_GROUP:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_GROUP).I" ><strong>SET_GROUP: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="#(SET_GROUP).Inherit" ><strong>SET_GROUP: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="#(SET_GROUP).IsInstanceOf" ><strong>SET_GROUP: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="#(SET_GROUP).IsTrace" ><strong>SET_GROUP: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="#(SET_GROUP).New" ><strong>SET_GROUP: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="#(SET_GROUP).OnEvent" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventBaseCaptured" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventBirth" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventCrash" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventDead" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventEjection" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventEngineShutdown" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventEngineStartup" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventHit" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventHumanFailure" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventLand" ><strong>SET_GROUP:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_GROUP).OnEventMissionEnd" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventMissionStart" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventPilotDead" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventPlayerEnterUnit" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventPlayerLeaveUnit" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventRefueling" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventRefuelingStop" ><strong>SET_GROUP: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="#(SET_GROUP).OnEventShootingEnd" ><strong>SET_GROUP: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 shooing. </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="#(SET_GROUP).OnEventShootingStart" ><strong>SET_GROUP:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_GROUP).OnEventShot" ><strong>SET_GROUP:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_GROUP).OnEventTakeoff" ><strong>SET_GROUP: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_GROUP).ScheduleOnce" ><strong>SET_GROUP: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="#(SET_GROUP).ScheduleRepeat" ><strong>SET_GROUP: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="#(SET_GROUP).ScheduleStop" ><strong>SET_GROUP: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="#(SET_GROUP).SetEventPriority" ><strong>SET_GROUP: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">
</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="#(SET_GROUP).SetState" ><strong>SET_GROUP: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, nillified 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="#(SET_GROUP).T" ><strong>SET_GROUP: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="#(SET_GROUP).T2" ><strong>SET_GROUP: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="#(SET_GROUP).T3" ><strong>SET_GROUP: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="#(SET_GROUP).TraceAll" ><strong>SET_GROUP: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="#(SET_GROUP).TraceClass" ><strong>SET_GROUP: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="#(SET_GROUP).TraceClassMethod" ><strong>SET_GROUP: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="#(SET_GROUP).TraceLevel" ><strong>SET_GROUP: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="#(SET_GROUP).TraceOnOff" ><strong>SET_GROUP: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="#(SET_GROUP).UnHandleEvent" ><strong>SET_GROUP:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_GROUP)._F" ><strong>SET_GROUP:_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="#(SET_GROUP)._T" ><strong>SET_GROUP:_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="#(SET_GROUP).onEvent" ><strong>SET_GROUP:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_PLAYER')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_PLAYER)">Type <strong>SET_PLAYER</strong></a></h2></div>
<div id= "#Types##SET_PLAYER" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_PLAYER).AddClientsByName" ><strong>SET_PLAYER:AddClientsByName(AddClientNames)</strong></a></h2>
</div>
<p>Add CLIENT(s) to SET_PLAYER.</p>
<div id= "#Functions##AddClientsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>AddClientNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CLIENT names.</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>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="#(SET_PLAYER).AddInDatabase" ><strong>SET_PLAYER:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CLIENT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_PLAYER).FilterCategories" ><strong>SET_PLAYER:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of clients out of categories joined by players.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "plane", "helicopter", "ground", "ship".</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FilterCoalitions" ><strong>SET_PLAYER:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of clients of coalitions joined by specific players.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FilterCountries" ><strong>SET_PLAYER:FilterCountries(Countries)</strong></a></h2>
</div>
<p>Builds a set of clients of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FilterPrefixes" ><strong>SET_PLAYER:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of clients of defined client prefixes.</p>
<p>All the clients starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the client name starts with.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FilterStart" ><strong>SET_PLAYER:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FilterTypes" ><strong>SET_PLAYER:FilterTypes(Types)</strong></a></h2>
</div>
<p>Builds a set of clients of defined client types joined by players.</p>
<p>Possible current types are those types known within DCS world.</p>
<div id= "#Functions##FilterTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Types</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those type strings known within DCS world.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).FindClient" ><strong>SET_PLAYER:FindClient(PlayerName)</strong></a></h2>
</div>
<p>Finds a Client based on the Player Name.</p>
<div id= "#Functions##FindClient" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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></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.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>:</p>
</div>
<div class="w3-half">
<p>The found 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="#(SET_PLAYER).FindInDatabase" ><strong>SET_PLAYER:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the CLIENT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_PLAYER).ForEachPlayer" ><strong>SET_PLAYER:ForEachPlayer(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_PLAYER and call an interator function for each <strong>alive</strong> CLIENT, providing the CLIENT and optional parameters.</p>
<div id= "#Functions##ForEachPlayer" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_PLAYER. The function needs to accept a CLIENT parameter.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).ForEachPlayerInZone" ><strong>SET_PLAYER:ForEachPlayerInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_PLAYER and call an iterator function for each <strong>alive</strong> CLIENT presence completely in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachPlayerInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_PLAYER. The function needs to accept a CLIENT parameter.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).ForEachPlayerNotInZone" ><strong>SET_PLAYER:ForEachPlayerNotInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_PLAYER and call an iterator function for each <strong>alive</strong> CLIENT presence not in a <a href="Zone.html">Zone</a>, providing the CLIENT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachPlayerNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive CLIENT in the SET_PLAYER. The function needs to accept a CLIENT parameter.</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).IsIncludeObject" ><strong>SET_PLAYER:IsIncludeObject(MClient)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>MClient</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="##(SET_PLAYER)">#SET_PLAYER</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="#(SET_PLAYER).New" ><strong>SET_PLAYER:New()</strong></a></h2>
</div>
<p>Creates a new SET_PLAYER object, building a set of clients belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_PLAYER</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="##(SET_PLAYER)">#SET_PLAYER</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_PLAYER Object. This DBObject will contain a reference to all Clients.
DBObject = SET_PLAYER:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).RemoveClientsByName" ><strong>SET_PLAYER:RemoveClientsByName(RemoveClientNames)</strong></a></h2>
</div>
<p>Remove CLIENT(s) from SET_PLAYER.</p>
<div id= "#Functions##RemoveClientsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_PLAYER</p>
</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.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
<strong><strong>RemoveClientNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of CLIENT names.</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>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_PLAYER).Add" ><strong>SET_PLAYER:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_PLAYER).AddObject" ><strong>SET_PLAYER:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_PLAYER).Count" ><strong>SET_PLAYER:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).FilterCrashes" ><strong>SET_PLAYER:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).FilterDeads" ><strong>SET_PLAYER:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).FilterOnce" ><strong>SET_PLAYER:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).FilterStop" ><strong>SET_PLAYER:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).FindNearestObjectFromPointVec2" ><strong>SET_PLAYER:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_PLAYER).Flush" ><strong>SET_PLAYER:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).ForEach" ><strong>SET_PLAYER:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_PLAYER).Get" ><strong>SET_PLAYER:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_PLAYER).GetFirst" ><strong>SET_PLAYER:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_PLAYER).GetLast" ><strong>SET_PLAYER:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_PLAYER).GetObjectNames" ><strong>SET_PLAYER:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).GetRandom" ><strong>SET_PLAYER:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_PLAYER).GetSet" ><strong>SET_PLAYER:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).GetSetNames" ><strong>SET_PLAYER:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).GetSetObjects" ><strong>SET_PLAYER:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER).IsIncludeObject" ><strong>SET_PLAYER:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_PLAYER).New" ><strong>SET_PLAYER:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).OnAfterAdded" ><strong>SET_PLAYER:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).OnAfterRemoved" ><strong>SET_PLAYER:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).Remove" ><strong>SET_PLAYER:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_PLAYER).SetDatabase" ><strong>SET_PLAYER:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_PLAYER).SetIteratorIntervals" ><strong>SET_PLAYER:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_PLAYER)._EventOnBirth" ><strong>SET_PLAYER:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER)._EventOnDeadOrCrash" ><strong>SET_PLAYER:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER)._FilterStart" ><strong>SET_PLAYER:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_PLAYER)._Find" ><strong>SET_PLAYER:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_PLAYER).ClearState" ><strong>SET_PLAYER: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="#(SET_PLAYER).CreateEventBirth" ><strong>SET_PLAYER: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="#(SET_PLAYER).CreateEventCrash" ><strong>SET_PLAYER: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="#(SET_PLAYER).CreateEventDead" ><strong>SET_PLAYER: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="#(SET_PLAYER).CreateEventRemoveUnit" ><strong>SET_PLAYER: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="#(SET_PLAYER).CreateEventTakeoff" ><strong>SET_PLAYER: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="#(SET_PLAYER).E" ><strong>SET_PLAYER: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="#(SET_PLAYER).EventDispatcher" ><strong>SET_PLAYER: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="#(SET_PLAYER).EventRemoveAll" ><strong>SET_PLAYER: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="#(SET_PLAYER).F" ><strong>SET_PLAYER: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="#(SET_PLAYER).F2" ><strong>SET_PLAYER: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="#(SET_PLAYER).F3" ><strong>SET_PLAYER: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="#(SET_PLAYER).GetClassID" ><strong>SET_PLAYER: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="#(SET_PLAYER).GetClassName" ><strong>SET_PLAYER: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="#(SET_PLAYER).GetClassNameAndID" ><strong>SET_PLAYER: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="#(SET_PLAYER).GetEventPriority" ><strong>SET_PLAYER: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="#(SET_PLAYER).GetParent" ><strong>SET_PLAYER: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>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>
<strong><strong>FromClass</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="##(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="#(SET_PLAYER).GetState" ><strong>SET_PLAYER: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, nillified 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="#(SET_PLAYER).HandleEvent" ><strong>SET_PLAYER:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_PLAYER).I" ><strong>SET_PLAYER: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="#(SET_PLAYER).Inherit" ><strong>SET_PLAYER: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="#(SET_PLAYER).IsInstanceOf" ><strong>SET_PLAYER: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="#(SET_PLAYER).IsTrace" ><strong>SET_PLAYER: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="#(SET_PLAYER).New" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEvent" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventBaseCaptured" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventBirth" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventCrash" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventDead" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventEjection" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventEngineShutdown" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventEngineStartup" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventHit" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventHumanFailure" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventLand" ><strong>SET_PLAYER:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_PLAYER).OnEventMissionEnd" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventMissionStart" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventPilotDead" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventPlayerEnterUnit" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventPlayerLeaveUnit" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventRefueling" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventRefuelingStop" ><strong>SET_PLAYER: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="#(SET_PLAYER).OnEventShootingEnd" ><strong>SET_PLAYER: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 shooing. </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="#(SET_PLAYER).OnEventShootingStart" ><strong>SET_PLAYER:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_PLAYER).OnEventShot" ><strong>SET_PLAYER:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_PLAYER).OnEventTakeoff" ><strong>SET_PLAYER: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_PLAYER).ScheduleOnce" ><strong>SET_PLAYER: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="#(SET_PLAYER).ScheduleRepeat" ><strong>SET_PLAYER: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="#(SET_PLAYER).ScheduleStop" ><strong>SET_PLAYER: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="#(SET_PLAYER).SetEventPriority" ><strong>SET_PLAYER: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">
</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="#(SET_PLAYER).SetState" ><strong>SET_PLAYER: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, nillified 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="#(SET_PLAYER).T" ><strong>SET_PLAYER: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="#(SET_PLAYER).T2" ><strong>SET_PLAYER: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="#(SET_PLAYER).T3" ><strong>SET_PLAYER: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="#(SET_PLAYER).TraceAll" ><strong>SET_PLAYER: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="#(SET_PLAYER).TraceClass" ><strong>SET_PLAYER: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="#(SET_PLAYER).TraceClassMethod" ><strong>SET_PLAYER: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="#(SET_PLAYER).TraceLevel" ><strong>SET_PLAYER: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="#(SET_PLAYER).TraceOnOff" ><strong>SET_PLAYER: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="#(SET_PLAYER).UnHandleEvent" ><strong>SET_PLAYER:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_PLAYER)._F" ><strong>SET_PLAYER:_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="#(SET_PLAYER)._T" ><strong>SET_PLAYER:_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="#(SET_PLAYER).onEvent" ><strong>SET_PLAYER:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_STATIC')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_STATIC)">Type <strong>SET_STATIC</strong></a></h2></div>
<div id= "#Types##SET_STATIC" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_STATIC).AddInDatabase" ><strong>SET_STATIC:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the STATIC</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The STATIC</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).AddStatic" ><strong>SET_STATIC:AddStatic(AddStatic)</strong></a></h2>
</div>
<p>Add STATIC(s) to SET_STATIC.</p>
<div id= "#Functions##AddStatic" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>AddStatic</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single STATIC.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).AddStaticsByName" ><strong>SET_STATIC:AddStaticsByName(AddStaticNames)</strong></a></h2>
</div>
<p>Add STATIC(s) to SET_STATIC.</p>
<div id= "#Functions##AddStaticsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>AddStaticNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of STATIC names.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).CalculateThreatLevelA2G" ><strong>SET_STATIC:CalculateThreatLevelA2G()</strong></a></h2>
</div>
<p>Calculate the maxium A2G threat level of the SET_STATIC.</p>
<div id= "#Functions##CalculateThreatLevelA2G" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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 maximum threatlevel</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).FilterCategories" ><strong>SET_STATIC:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of units out of categories.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "plane", "helicopter", "ground", "ship".</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FilterCoalitions" ><strong>SET_STATIC:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of units of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FilterCountries" ><strong>SET_STATIC:FilterCountries(Countries)</strong></a></h2>
</div>
<p>Builds a set of units of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FilterPrefixes" ><strong>SET_STATIC:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of units of defined unit prefixes.</p>
<p>All the units starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the unit name starts with.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FilterStart" ><strong>SET_STATIC:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FilterTypes" ><strong>SET_STATIC:FilterTypes(Types)</strong></a></h2>
</div>
<p>Builds a set of units of defined unit types.</p>
<p>Possible current types are those types known within DCS world.</p>
<div id= "#Functions##FilterTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Types</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those type strings known within DCS world.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).FindInDatabase" ><strong>SET_STATIC:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the STATIC</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The STATIC</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).FindStatic" ><strong>SET_STATIC:FindStatic(StaticName)</strong></a></h2>
</div>
<p>Finds a Static based on the Static Name.</p>
<div id= "#Functions##FindStatic" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>StaticName</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.Static.html##(STATIC)">Wrapper.Static#STATIC</a>:</p>
</div>
<div class="w3-half">
<p>The found Static.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).ForEachStatic" ><strong>SET_STATIC:ForEachStatic(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_STATIC and call an interator function for each <strong>alive</strong> STATIC, providing the STATIC and optional parameters.</p>
<div id= "#Functions##ForEachStatic" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive STATIC in the SET_STATIC. The function needs to accept a STATIC parameter.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).ForEachStaticCompletelyInZone" ><strong>SET_STATIC:ForEachStaticCompletelyInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_STATIC and call an iterator function for each <strong>alive</strong> STATIC presence completely in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</p>
<div id= "#Functions##ForEachStaticCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive STATIC in the SET_STATIC. The function needs to accept a STATIC parameter.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).ForEachStaticInZone" ><strong>SET_STATIC:ForEachStaticInZone(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Check if minimal one element of the SET_STATIC is in the Zone.</p>
<div id= "#Functions##ForEachStaticInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive STATIC in the SET_STATIC. The function needs to accept a STATIC parameter.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).ForEachStaticNotInZone" ><strong>SET_STATIC:ForEachStaticNotInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_STATIC and call an iterator function for each <strong>alive</strong> STATIC presence not in a <a href="Zone.html">Zone</a>, providing the STATIC and optional parameters to the called function.</p>
<div id= "#Functions##ForEachStaticNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive STATIC in the SET_STATIC. The function needs to accept a STATIC parameter.</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).GetCoordinate" ><strong>SET_STATIC:GetCoordinate()</strong></a></h2>
</div>
<p>Get the center coordinate of the SET_STATIC.</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>SET_STATIC</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>The center coordinate of all the units in the set, including heading in degrees and speed in mps in case of moving 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="#(SET_STATIC).GetFirst" ><strong>SET_STATIC:GetFirst()</strong></a></h2>
</div>
<p>Get the first unit from the set.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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.Static.html##(STATIC)">Wrapper.Static#STATIC</a>:</p>
</div>
<div class="w3-half">
<p>The STATIC 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="#(SET_STATIC).GetHeading" ><strong>SET_STATIC:GetHeading()</strong></a></h2>
</div>
<p>Get the average heading of the SET_STATIC.</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>SET_STATIC</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>Heading Heading in degrees and speed in mps in case of moving 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="#(SET_STATIC).GetStaticTypes" ><strong>SET_STATIC:GetStaticTypes()</strong></a></h2>
</div>
<p>Returns map of unit types.</p>
<div id= "#Functions##GetStaticTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#map&lt;#string,#number&gt;:</p>
</div>
<div class="w3-half">
<p>A map of the unit types found. The key is the StaticTypeName and the value is the amount of unit types found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).GetStaticTypesText" ><strong>SET_STATIC:GetStaticTypesText()</strong></a></h2>
</div>
<p>Returns a comma separated string of the unit types with a count in the <a href="Set.html">Set</a>.</p>
<div id= "#Functions##GetStaticTypesText" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</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 types 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="#(SET_STATIC).GetTypeNames" ><strong>SET_STATIC:GetTypeNames(Delimiter)</strong></a></h2>
</div>
<p>Retrieve the type names of the <a href="Static.html">Static</a>s in the SET, delimited by an optional delimiter.</p>
<div id= "#Functions##GetTypeNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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>Delimiter</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The delimiter, which is default a comma.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The types of the <a href="Static.html">Static</a>s delimited.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).GetVelocity" ><strong>SET_STATIC:GetVelocity()</strong></a></h2>
</div>
<p>Get the maximum velocity of the SET_STATIC.</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>SET_STATIC</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 speed in mps in case of moving 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="#(SET_STATIC).IsIncludeObject" ><strong>SET_STATIC:IsIncludeObject(MStatic)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
<strong><strong>MStatic</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="##(SET_STATIC)">#SET_STATIC</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="#(SET_STATIC).IsNotInZone" ><strong>SET_STATIC:IsNotInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Check if no element of the SET_STATIC is in the Zone.</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>SET_STATIC</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).IsPatriallyInZone" ><strong>SET_STATIC:IsPatriallyInZone(Zone)</strong></a></h2>
</div>
<p>Check if minimal one element of the SET_STATIC is in the Zone.</p>
<div id= "#Functions##IsPatriallyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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)">Core.Zone#ZONE</a>
<strong><strong>Zone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</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="#(SET_STATIC).New" ><strong>SET_STATIC:New()</strong></a></h2>
</div>
<p>Creates a new SET_STATIC object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_STATIC</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="##(SET_STATIC)">#SET_STATIC</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_STATIC Object. This DBObject will contain a reference to all alive Statics.
DBObject = SET_STATIC:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).RemoveStaticsByName" ><strong>SET_STATIC:RemoveStaticsByName(RemoveStaticNames)</strong></a></h2>
</div>
<p>Remove STATIC(s) from SET_STATIC.</p>
<div id= "#Functions##RemoveStaticsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_STATIC</p>
</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.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
<strong><strong>RemoveStaticNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of STATIC names.</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>self</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_STATIC).Add" ><strong>SET_STATIC:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_STATIC).AddObject" ><strong>SET_STATIC:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_STATIC).Count" ><strong>SET_STATIC:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).FilterCrashes" ><strong>SET_STATIC:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).FilterDeads" ><strong>SET_STATIC:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).FilterOnce" ><strong>SET_STATIC:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).FilterStop" ><strong>SET_STATIC:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).FindNearestObjectFromPointVec2" ><strong>SET_STATIC:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_STATIC).Flush" ><strong>SET_STATIC:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).ForEach" ><strong>SET_STATIC:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_STATIC).Get" ><strong>SET_STATIC:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_STATIC).GetFirst" ><strong>SET_STATIC:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_STATIC).GetLast" ><strong>SET_STATIC:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_STATIC).GetObjectNames" ><strong>SET_STATIC:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).GetRandom" ><strong>SET_STATIC:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_STATIC).GetSet" ><strong>SET_STATIC:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).GetSetNames" ><strong>SET_STATIC:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).GetSetObjects" ><strong>SET_STATIC:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC).IsIncludeObject" ><strong>SET_STATIC:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_STATIC).New" ><strong>SET_STATIC:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).OnAfterAdded" ><strong>SET_STATIC:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).OnAfterRemoved" ><strong>SET_STATIC:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).Remove" ><strong>SET_STATIC:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_STATIC).SetDatabase" ><strong>SET_STATIC:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_STATIC).SetIteratorIntervals" ><strong>SET_STATIC:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_STATIC)._EventOnBirth" ><strong>SET_STATIC:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC)._EventOnDeadOrCrash" ><strong>SET_STATIC:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC)._FilterStart" ><strong>SET_STATIC:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_STATIC)._Find" ><strong>SET_STATIC:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_STATIC).ClearState" ><strong>SET_STATIC: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="#(SET_STATIC).CreateEventBirth" ><strong>SET_STATIC: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="#(SET_STATIC).CreateEventCrash" ><strong>SET_STATIC: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="#(SET_STATIC).CreateEventDead" ><strong>SET_STATIC: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="#(SET_STATIC).CreateEventRemoveUnit" ><strong>SET_STATIC: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="#(SET_STATIC).CreateEventTakeoff" ><strong>SET_STATIC: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="#(SET_STATIC).E" ><strong>SET_STATIC: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="#(SET_STATIC).EventDispatcher" ><strong>SET_STATIC: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="#(SET_STATIC).EventRemoveAll" ><strong>SET_STATIC: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="#(SET_STATIC).F" ><strong>SET_STATIC: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="#(SET_STATIC).F2" ><strong>SET_STATIC: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="#(SET_STATIC).F3" ><strong>SET_STATIC: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="#(SET_STATIC).GetClassID" ><strong>SET_STATIC: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="#(SET_STATIC).GetClassName" ><strong>SET_STATIC: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="#(SET_STATIC).GetClassNameAndID" ><strong>SET_STATIC: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="#(SET_STATIC).GetEventPriority" ><strong>SET_STATIC: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="#(SET_STATIC).GetParent" ><strong>SET_STATIC: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>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>
<strong><strong>FromClass</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="##(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="#(SET_STATIC).GetState" ><strong>SET_STATIC: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, nillified 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="#(SET_STATIC).HandleEvent" ><strong>SET_STATIC:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_STATIC).I" ><strong>SET_STATIC: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="#(SET_STATIC).Inherit" ><strong>SET_STATIC: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="#(SET_STATIC).IsInstanceOf" ><strong>SET_STATIC: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="#(SET_STATIC).IsTrace" ><strong>SET_STATIC: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="#(SET_STATIC).New" ><strong>SET_STATIC: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="#(SET_STATIC).OnEvent" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventBaseCaptured" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventBirth" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventCrash" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventDead" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventEjection" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventEngineShutdown" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventEngineStartup" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventHit" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventHumanFailure" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventLand" ><strong>SET_STATIC:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_STATIC).OnEventMissionEnd" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventMissionStart" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventPilotDead" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventPlayerEnterUnit" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventPlayerLeaveUnit" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventRefueling" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventRefuelingStop" ><strong>SET_STATIC: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="#(SET_STATIC).OnEventShootingEnd" ><strong>SET_STATIC: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 shooing. </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="#(SET_STATIC).OnEventShootingStart" ><strong>SET_STATIC:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_STATIC).OnEventShot" ><strong>SET_STATIC:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_STATIC).OnEventTakeoff" ><strong>SET_STATIC: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_STATIC).ScheduleOnce" ><strong>SET_STATIC: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="#(SET_STATIC).ScheduleRepeat" ><strong>SET_STATIC: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="#(SET_STATIC).ScheduleStop" ><strong>SET_STATIC: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="#(SET_STATIC).SetEventPriority" ><strong>SET_STATIC: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">
</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="#(SET_STATIC).SetState" ><strong>SET_STATIC: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, nillified 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="#(SET_STATIC).T" ><strong>SET_STATIC: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="#(SET_STATIC).T2" ><strong>SET_STATIC: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="#(SET_STATIC).T3" ><strong>SET_STATIC: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="#(SET_STATIC).TraceAll" ><strong>SET_STATIC: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="#(SET_STATIC).TraceClass" ><strong>SET_STATIC: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="#(SET_STATIC).TraceClassMethod" ><strong>SET_STATIC: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="#(SET_STATIC).TraceLevel" ><strong>SET_STATIC: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="#(SET_STATIC).TraceOnOff" ><strong>SET_STATIC: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="#(SET_STATIC).UnHandleEvent" ><strong>SET_STATIC:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_STATIC)._F" ><strong>SET_STATIC:_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="#(SET_STATIC)._T" ><strong>SET_STATIC:_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="#(SET_STATIC).onEvent" ><strong>SET_STATIC:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_UNIT')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_UNIT)">Type <strong>SET_UNIT</strong></a></h2></div>
<div id= "#Types##SET_UNIT" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_UNIT).AddInDatabase" ><strong>SET_UNIT:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the UNIT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_UNIT).AddUnit" ><strong>SET_UNIT:AddUnit(Unit)</strong></a></h2>
</div>
<p>Add UNIT(s) to SET_UNIT.</p>
<div id= "#Functions##AddUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Unit</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single 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="##(SET_UNIT)">#SET_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="#(SET_UNIT).AddUnitsByName" ><strong>SET_UNIT:AddUnitsByName(AddUnitNames)</strong></a></h2>
</div>
<p>Add UNIT(s) to SET_UNIT.</p>
<div id= "#Functions##AddUnitsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>AddUnitNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of UNIT names.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).CalculateThreatLevelA2G" ><strong>SET_UNIT:CalculateThreatLevelA2G()</strong></a></h2>
</div>
<p>Calculate the maxium A2G threat level of the SET_UNIT.</p>
<div id= "#Functions##CalculateThreatLevelA2G" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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 maximum threatlevel</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).FilterActive" ><strong>SET_UNIT:FilterActive(Active)</strong></a></h2>
</div>
<p>Builds a set of units that are only active.</p>
<p>Only the units that are active will be included within the set.</p>
<div id= "#Functions##FilterActive" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Active</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) Include only active units to the set.
Include inactive units if you provide 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="##(SET_UNIT)">#SET_UNIT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
-- Include only active units to the set.
UnitSet = SET_UNIT:New():FilterActive():FilterStart()
-- Include only active units to the set of the blue coalition, and filter one time.
UnitSet = SET_UNIT:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
-- Include only active units to the set of the blue coalition, and filter one time.
-- Later, reset to include back inactive units to the set.
UnitSet = SET_UNIT:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
... logic ...
UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterOnce()
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).FilterCategories" ><strong>SET_UNIT:FilterCategories(Categories)</strong></a></h2>
</div>
<p>Builds a set of units out of categories.</p>
<p>Possible current categories are plane, helicopter, ground, ship.</p>
<div id= "#Functions##FilterCategories" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Categories</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "plane", "helicopter", "ground", "ship".</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterCoalitions" ><strong>SET_UNIT:FilterCoalitions(Coalitions)</strong></a></h2>
</div>
<p>Builds a set of units of coalitions.</p>
<p>Possible current coalitions are red, blue and neutral.</p>
<div id= "#Functions##FilterCoalitions" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Coalitions</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take the following values: "red", "blue", "neutral".</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterCountries" ><strong>SET_UNIT:FilterCountries(Countries)</strong></a></h2>
</div>
<p>Builds a set of units of defined countries.</p>
<p>Possible current countries are those known within DCS world.</p>
<div id= "#Functions##FilterCountries" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Countries</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those country strings known within DCS world.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterHasRadar" ><strong>SET_UNIT:FilterHasRadar(RadarTypes)</strong></a></h2>
</div>
<p>Builds a set of units having a radar of give types.</p>
<p>All the units having a radar of a given type will be included within the set.</p>
<div id= "#Functions##FilterHasRadar" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>RadarTypes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The radar types.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterHasSEAD" ><strong>SET_UNIT:FilterHasSEAD()</strong></a></h2>
</div>
<p>Builds a set of SEADable units.</p>
<div id= "#Functions##FilterHasSEAD" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterPrefixes" ><strong>SET_UNIT:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of units of defined unit prefixes.</p>
<p>All the units starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the unit name starts with.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterStart" ><strong>SET_UNIT:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FilterTypes" ><strong>SET_UNIT:FilterTypes(Types)</strong></a></h2>
</div>
<p>Builds a set of units of defined unit types.</p>
<p>Possible current types are those types known within DCS world.</p>
<div id= "#Functions##FilterTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Types</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Can take those type strings known within DCS world.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).FindInDatabase" ><strong>SET_UNIT:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the UNIT</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>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="#(SET_UNIT).FindUnit" ><strong>SET_UNIT:FindUnit(UnitName)</strong></a></h2>
</div>
<p>Finds a Unit based on the Unit Name.</p>
<div id= "#Functions##FindUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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></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.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>:</p>
</div>
<div class="w3-half">
<p>The found 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="#(SET_UNIT).ForEachUnit" ><strong>SET_UNIT:ForEachUnit(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_UNIT and call an interator function for each <strong>alive</strong> UNIT, providing the UNIT and optional parameters.</p>
<div id= "#Functions##ForEachUnit" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive UNIT in the SET_UNIT. The function needs to accept a UNIT parameter.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).ForEachUnitCompletelyInZone" ><strong>SET_UNIT:ForEachUnitCompletelyInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT presence completely in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachUnitCompletelyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive UNIT in the SET_UNIT. The function needs to accept a UNIT parameter.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).ForEachUnitInZone" ><strong>SET_UNIT:ForEachUnitInZone(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Check if minimal one element of the SET_UNIT is in the Zone.</p>
<div id= "#Functions##ForEachUnitInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive UNIT in the SET_UNIT. The function needs to accept a UNIT parameter.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).ForEachUnitNotInZone" ><strong>SET_UNIT:ForEachUnitNotInZone(ZoneObject, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_UNIT and call an iterator function for each <strong>alive</strong> UNIT presence not in a <a href="Zone.html">Zone</a>, providing the UNIT and optional parameters to the called function.</p>
<div id= "#Functions##ForEachUnitNotInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive UNIT in the SET_UNIT. The function needs to accept a UNIT parameter.</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).ForEachUnitPerThreatLevel" ><strong>SET_UNIT:ForEachUnitPerThreatLevel(FromThreatLevel, ToThreatLevel, IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_UNIT <strong>sorted *per Threat Level</strong> and call an interator function for each <strong>alive</strong> UNIT, providing the UNIT and optional parameters.</p>
<div id= "#Functions##ForEachUnitPerThreatLevel" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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>FromThreatLevel</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The TreatLevel to start the evaluation <strong>From</strong> (this must be a value between 0 and 10).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>ToThreatLevel</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The TreatLevel to stop the evaluation <strong>To</strong> (this must be a value between 0 and 10).</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive UNIT in the SET_UNIT. The function needs to accept a UNIT parameter.</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="##(SET_UNIT)">#SET_UNIT</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>
UnitSet:ForEachUnitPerThreatLevel( 10, 0,
-- @param Wrapper.Unit#UNIT UnitObject The UNIT object in the UnitSet, that will be passed to the local function for evaluation.
function( UnitObject )
.. logic ..
end
)
</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).GetCoordinate" ><strong>SET_UNIT:GetCoordinate()</strong></a></h2>
</div>
<p>Get the center coordinate of the SET_UNIT.</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>SET_UNIT</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>The center coordinate of all the units in the set, including heading in degrees and speed in mps in case of moving 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="#(SET_UNIT).GetFirst" ><strong>SET_UNIT:GetFirst()</strong></a></h2>
</div>
<p>Get the first unit from the set.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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 UNIT 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="#(SET_UNIT).GetHeading" ><strong>SET_UNIT:GetHeading()</strong></a></h2>
</div>
<p>Get the average heading of the SET_UNIT.</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>SET_UNIT</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>Heading Heading in degrees and speed in mps in case of moving 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="#(SET_UNIT).GetTypeNames" ><strong>SET_UNIT:GetTypeNames(Delimiter)</strong></a></h2>
</div>
<p>Retrieve the type names of the <a href="Wrapper.Unit.html">Wrapper.Unit</a>s in the SET, delimited by an optional delimiter.</p>
<div id= "#Functions##GetTypeNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>Delimiter</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The delimiter, which is default a comma.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#string:</p>
</div>
<div class="w3-half">
<p>The types of the <a href="Wrapper.Unit.html">Wrapper.Unit</a>s delimited.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).GetUnitThreatLevels" ><strong>SET_UNIT:GetUnitThreatLevels()</strong></a></h2>
</div>
<p>Returns map of unit threat levels.</p>
<div id= "#Functions##GetUnitThreatLevels" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).GetUnitTypes" ><strong>SET_UNIT:GetUnitTypes()</strong></a></h2>
</div>
<p>Returns map of unit types.</p>
<div id= "#Functions##GetUnitTypes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#map&lt;#string,#number&gt;:</p>
</div>
<div class="w3-half">
<p>A map of the unit types found. The key is the UnitTypeName and the value is the amount of unit types found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).GetUnitTypesText" ><strong>SET_UNIT:GetUnitTypesText()</strong></a></h2>
</div>
<p>Returns a comma separated string of the unit types with a count in the <a href="Set.html">Set</a>.</p>
<div id= "#Functions##GetUnitTypesText" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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 types 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="#(SET_UNIT).GetVelocity" ><strong>SET_UNIT:GetVelocity()</strong></a></h2>
</div>
<p>Get the maximum velocity of the SET_UNIT.</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>SET_UNIT</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 speed in mps in case of moving 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="#(SET_UNIT).HasFriendlyUnits" ><strong>SET_UNIT:HasFriendlyUnits(FriendlyCoalition)</strong></a></h2>
</div>
<p>Returns if the <a href="Set.html">Set</a> has friendly ground units.</p>
<div id= "#Functions##HasFriendlyUnits" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>#number:</p>
</div>
<div class="w3-half">
<p>The amount of ground targets in the 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="#(SET_UNIT).HasGroundUnits" ><strong>SET_UNIT:HasGroundUnits()</strong></a></h2>
</div>
<p>Returns if the <a href="Set.html">Set</a> has ground targets.</p>
<div id= "#Functions##HasGroundUnits" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</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 amount of ground targets in the 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="#(SET_UNIT).HasRadar" ><strong>SET_UNIT:HasRadar(RadarType)</strong></a></h2>
</div>
<p>Returns if the <a href="Set.html">Set</a> has targets having a radar (of a given type).</p>
<div id= "#Functions##HasRadar" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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.RadarType)">DCS#Unit.RadarType</a>
<strong><strong>RadarType</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p>#number:</p>
</div>
<div class="w3-half">
<p>The amount of radars in the Set with the given type</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).HasSEAD" ><strong>SET_UNIT:HasSEAD()</strong></a></h2>
</div>
<p>Returns if the <a href="Set.html">Set</a> has targets that can be SEADed.</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>SET_UNIT</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 amount of SEADable units in the 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="#(SET_UNIT).IsIncludeObject" ><strong>SET_UNIT:IsIncludeObject(MUnit)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>MUnit</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="##(SET_UNIT)">#SET_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="#(SET_UNIT).IsNotInZone" ><strong>SET_UNIT:IsNotInZone(ZoneObject, Zone)</strong></a></h2>
</div>
<p>Check if no element of the SET_UNIT is in the Zone.</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>SET_UNIT</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>ZoneObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>Zone</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">
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).IsPartiallyInZone" ><strong>SET_UNIT:IsPartiallyInZone(ZoneTest)</strong></a></h2>
</div>
<p>Check if minimal one element of the SET_UNIT is in the Zone.</p>
<div id= "#Functions##IsPartiallyInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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)">Core.Zone#ZONE</a>
<strong><strong>ZoneTest</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The Zone to be tested for.</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="#(SET_UNIT).New" ><strong>SET_UNIT:New()</strong></a></h2>
</div>
<p>Creates a new SET_UNIT object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</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>SET_UNIT</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="##(SET_UNIT)">#SET_UNIT</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_UNIT Object. This DBObject will contain a reference to all alive Units.
DBObject = SET_UNIT:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).RemoveUnitsByName" ><strong>SET_UNIT:RemoveUnitsByName(RemoveUnitNames)</strong></a></h2>
</div>
<p>Remove UNIT(s) from SET_UNIT.</p>
<div id= "#Functions##RemoveUnitsByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_UNIT</p>
</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>RemoveUnitNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of UNIT names.</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>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="#(SET_UNIT).SetCargoBayWeightLimit" ><strong>SET_UNIT:SetCargoBayWeightLimit()</strong></a></h2>
</div>
<p>Iterate the SET_UNIT and set for each unit the default cargo bay weight limit.</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>SET_UNIT</p>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Set the default cargo bay weight limits of the carrier units.
local MySetUnit = SET_UNIT:New()
MySetUnit:SetCargoBayWeightLimit()</code></pre>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_UNIT).Add" ><strong>SET_UNIT:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_UNIT).AddObject" ><strong>SET_UNIT:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_UNIT).Count" ><strong>SET_UNIT:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).FilterCrashes" ><strong>SET_UNIT:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).FilterDeads" ><strong>SET_UNIT:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).FilterOnce" ><strong>SET_UNIT:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).FilterStop" ><strong>SET_UNIT:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).FindNearestObjectFromPointVec2" ><strong>SET_UNIT:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_UNIT).Flush" ><strong>SET_UNIT:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).ForEach" ><strong>SET_UNIT:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_UNIT).Get" ><strong>SET_UNIT:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_UNIT).GetFirst" ><strong>SET_UNIT:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_UNIT).GetLast" ><strong>SET_UNIT:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_UNIT).GetObjectNames" ><strong>SET_UNIT:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).GetRandom" ><strong>SET_UNIT:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_UNIT).GetSet" ><strong>SET_UNIT:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).GetSetNames" ><strong>SET_UNIT:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).GetSetObjects" ><strong>SET_UNIT:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT).IsIncludeObject" ><strong>SET_UNIT:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_UNIT).New" ><strong>SET_UNIT:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).OnAfterAdded" ><strong>SET_UNIT:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).OnAfterRemoved" ><strong>SET_UNIT:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).Remove" ><strong>SET_UNIT:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_UNIT).SetDatabase" ><strong>SET_UNIT:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_UNIT).SetIteratorIntervals" ><strong>SET_UNIT:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_UNIT)._EventOnBirth" ><strong>SET_UNIT:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT)._EventOnDeadOrCrash" ><strong>SET_UNIT:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT)._FilterStart" ><strong>SET_UNIT:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_UNIT)._Find" ><strong>SET_UNIT:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_UNIT).ClearState" ><strong>SET_UNIT: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="#(SET_UNIT).CreateEventBirth" ><strong>SET_UNIT: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="#(SET_UNIT).CreateEventCrash" ><strong>SET_UNIT: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="#(SET_UNIT).CreateEventDead" ><strong>SET_UNIT: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="#(SET_UNIT).CreateEventRemoveUnit" ><strong>SET_UNIT: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="#(SET_UNIT).CreateEventTakeoff" ><strong>SET_UNIT: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="#(SET_UNIT).E" ><strong>SET_UNIT: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="#(SET_UNIT).EventDispatcher" ><strong>SET_UNIT: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="#(SET_UNIT).EventRemoveAll" ><strong>SET_UNIT: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="#(SET_UNIT).F" ><strong>SET_UNIT: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="#(SET_UNIT).F2" ><strong>SET_UNIT: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="#(SET_UNIT).F3" ><strong>SET_UNIT: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="#(SET_UNIT).GetClassID" ><strong>SET_UNIT: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="#(SET_UNIT).GetClassName" ><strong>SET_UNIT: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="#(SET_UNIT).GetClassNameAndID" ><strong>SET_UNIT: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="#(SET_UNIT).GetEventPriority" ><strong>SET_UNIT: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="#(SET_UNIT).GetParent" ><strong>SET_UNIT: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>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>
<strong><strong>FromClass</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="##(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="#(SET_UNIT).GetState" ><strong>SET_UNIT: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, nillified 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="#(SET_UNIT).HandleEvent" ><strong>SET_UNIT:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_UNIT).I" ><strong>SET_UNIT: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="#(SET_UNIT).Inherit" ><strong>SET_UNIT: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="#(SET_UNIT).IsInstanceOf" ><strong>SET_UNIT: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="#(SET_UNIT).IsTrace" ><strong>SET_UNIT: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="#(SET_UNIT).New" ><strong>SET_UNIT: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="#(SET_UNIT).OnEvent" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventBaseCaptured" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventBirth" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventCrash" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventDead" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventEjection" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventEngineShutdown" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventEngineStartup" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventHit" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventHumanFailure" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventLand" ><strong>SET_UNIT:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_UNIT).OnEventMissionEnd" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventMissionStart" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventPilotDead" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventPlayerEnterUnit" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventPlayerLeaveUnit" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventRefueling" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventRefuelingStop" ><strong>SET_UNIT: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="#(SET_UNIT).OnEventShootingEnd" ><strong>SET_UNIT: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 shooing. </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="#(SET_UNIT).OnEventShootingStart" ><strong>SET_UNIT:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_UNIT).OnEventShot" ><strong>SET_UNIT:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_UNIT).OnEventTakeoff" ><strong>SET_UNIT: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_UNIT).ScheduleOnce" ><strong>SET_UNIT: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="#(SET_UNIT).ScheduleRepeat" ><strong>SET_UNIT: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="#(SET_UNIT).ScheduleStop" ><strong>SET_UNIT: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="#(SET_UNIT).SetEventPriority" ><strong>SET_UNIT: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">
</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="#(SET_UNIT).SetState" ><strong>SET_UNIT: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, nillified 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="#(SET_UNIT).T" ><strong>SET_UNIT: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="#(SET_UNIT).T2" ><strong>SET_UNIT: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="#(SET_UNIT).T3" ><strong>SET_UNIT: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="#(SET_UNIT).TraceAll" ><strong>SET_UNIT: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="#(SET_UNIT).TraceClass" ><strong>SET_UNIT: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="#(SET_UNIT).TraceClassMethod" ><strong>SET_UNIT: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="#(SET_UNIT).TraceLevel" ><strong>SET_UNIT: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="#(SET_UNIT).TraceOnOff" ><strong>SET_UNIT: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="#(SET_UNIT).UnHandleEvent" ><strong>SET_UNIT:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_UNIT)._F" ><strong>SET_UNIT:_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="#(SET_UNIT)._T" ><strong>SET_UNIT:_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="#(SET_UNIT).onEvent" ><strong>SET_UNIT:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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 onclick="myFunction('#Types##SET_ZONE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SET_ZONE)">Type <strong>SET_ZONE</strong></a></h2></div>
<div id= "#Types##SET_ZONE" class="w3-container w3-white w3-padding-16" id="module_other_types">
<div class="w3-white" id="record_type">
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_ZONE).AddInDatabase" ><strong>SET_ZONE:AddInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on an event (birth) that the Object was added in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE birth event gets called later than the SET</em>BASE birth event!</p>
<div id= "#Functions##AddInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the AIRBASE</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The AIRBASE</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).AddZone" ><strong>SET_ZONE:AddZone(Zone)</strong></a></h2>
</div>
<p>Add ZONEs to SET_ZONE.</p>
<div id= "#Functions##AddZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>A ZONE_BASE 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>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="#(SET_ZONE).AddZonesByName" ><strong>SET_ZONE:AddZonesByName(AddZoneNames)</strong></a></h2>
</div>
<p>Add ZONEs by a search name to SET_ZONE.</p>
<div id= "#Functions##AddZonesByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>AddZoneNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of ZONE_BASE names.</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>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="#(SET_ZONE).FilterPrefixes" ><strong>SET_ZONE:FilterPrefixes(Prefixes)</strong></a></h2>
</div>
<p>Builds a set of zones of defined zone prefixes.</p>
<p>All the zones starting with the given prefixes will be included within the set.</p>
<div id= "#Functions##FilterPrefixes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>Prefixes</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The prefix of which the zone name starts with.</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="##(SET_ZONE)">#SET_ZONE</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="#(SET_ZONE).FilterStart" ><strong>SET_ZONE:FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering.</p>
<div id= "#Functions##FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</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="##(SET_ZONE)">#SET_ZONE</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="#(SET_ZONE).FilterStop" ><strong>SET_ZONE:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</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="##(SET_ZONE)">#SET_ZONE</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="#(SET_ZONE).FindInDatabase" ><strong>SET_ZONE:FindInDatabase(Event)</strong></a></h2>
</div>
<p>Handles the Database to check on any event that Object exists in the Database.</p>
<p>This is required, because sometimes the <em>DATABASE event gets called later than the SET</em>BASE event or vise versa!</p>
<div id= "#Functions##FindInDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>Event</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>#string:</p>
</div>
<div class="w3-half">
<p>The name of the AIRBASE</p>
</div>
<div class="w3-half">
<p>#table:</p>
</div>
<div class="w3-half">
<p>The AIRBASE</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).FindZone" ><strong>SET_ZONE:FindZone(ZoneName)</strong></a></h2>
</div>
<p>Finds a Zone based on the Zone Name.</p>
<div id= "#Functions##FindZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>ZoneName</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.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>The found Zone.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).ForEachZone" ><strong>SET_ZONE:ForEachZone(IteratorFunction, ...)</strong></a></h2>
</div>
<p>Iterate the SET_ZONE and call an interator function for each ZONE, providing the ZONE and optional parameters.</p>
<div id= "#Functions##ForEachZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</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>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function that will be called when there is an alive ZONE in the SET_ZONE. The function needs to accept a AIRBASE parameter.</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="##(SET_ZONE)">#SET_ZONE</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="#(SET_ZONE).GetRandomZone" ><strong>SET_ZONE:GetRandomZone()</strong></a></h2>
</div>
<p>Get a random zone from the set.</p>
<div id= "#Functions##GetRandomZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</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.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>The random Zone.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>if no zone in the collection.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).IsCoordinateInZone" ><strong>SET_ZONE:IsCoordinateInZone(Coordinate)</strong></a></h2>
</div>
<p>Validate if a coordinate is in one of the zones in the set.</p>
<p>Returns the ZONE object where the coordiante is located.
If zones overlap, the first zone that validates the test is returned.</p>
<div id= "#Functions##IsCoordinateInZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<strong><strong>Coordinate</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The coordinate to be searched.</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="Core.Zone.html##(ZONE_BASE)">Core.Zone#ZONE_BASE</a>:</p>
</div>
<div class="w3-half">
<p>The zone that validates the coordinate location.</p>
</div>
<div class="w3-half">
<p>#nil:</p>
</div>
<div class="w3-half">
<p>No zone has been found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).IsIncludeObject" ><strong>SET_ZONE:IsIncludeObject(MZone)</strong></a></h2>
</div>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>MZone</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="##(SET_ZONE)">#SET_ZONE</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="#(SET_ZONE).New" ><strong>SET_ZONE:New()</strong></a></h2>
</div>
<p>Creates a new SET_ZONE object, building a set of zones.</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>SET_ZONE</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="##(SET_ZONE)">#SET_ZONE</a>:</p>
</div>
<div class="w3-half">
<p>self</p>
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_ZONE Object. The DatabaseSet will contain a reference to all Zones.
DatabaseSet = SET_ZONE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).OnEventDeleteZone" ><strong>SET_ZONE:OnEventDeleteZone(EventData)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##OnEventDeleteZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).OnEventNewZone" ><strong>SET_ZONE:OnEventNewZone(EventData)</strong></a></h2>
</div>
<p>Handles the OnEventNewZone event for the Set.</p>
<div id= "#Functions##OnEventNewZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).RemoveZonesByName" ><strong>SET_ZONE:RemoveZonesByName(RemoveZoneNames)</strong></a></h2>
</div>
<p>Remove ZONEs from SET_ZONE.</p>
<div id= "#Functions##RemoveZonesByName" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</p>
</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>RemoveZoneNames</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A single name or an array of ZONE_BASE names.</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>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="#(SET_ZONE).SetZoneProbability" ><strong>SET_ZONE:SetZoneProbability(ZoneName, ZoneProbability)</strong></a></h2>
</div>
<p>Set a zone probability.</p>
<div id= "#Functions##SetZoneProbability" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>SET_ZONE</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>ZoneName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the zone.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>ZoneProbability</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 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="#(SET_ZONE).Add" ><strong>SET_ZONE:Add(ObjectName, Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using a given ObjectName as the index.</p>
<div id= "#Functions##Add" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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="Core.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_ZONE).AddObject" ><strong>SET_ZONE:AddObject(Object)</strong></a></h2>
</div>
<p>Adds a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a>, using the Object Name as the index.</p>
<div id= "#Functions##AddObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Object.html##(OBJECT)">Wrapper.Object#OBJECT</a>
<strong><strong>Object</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The added BASE 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="#(SET_ZONE).Count" ><strong>SET_ZONE:Count()</strong></a></h2>
</div>
<p>Retrieves the amount of objects in the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##Count" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Count</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).FilterCrashes" ><strong>SET_ZONE:FilterCrashes()</strong></a></h2>
</div>
<p>Starts the filtering of the Crash events for the collection.</p>
<div id= "#Functions##FilterCrashes" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).FilterDeads" ><strong>SET_ZONE:FilterDeads()</strong></a></h2>
</div>
<p>Starts the filtering of the Dead events for the collection.</p>
<div id= "#Functions##FilterDeads" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).FilterOnce" ><strong>SET_ZONE:FilterOnce()</strong></a></h2>
</div>
<p>Filters for the defined collection.</p>
<div id= "#Functions##FilterOnce" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).FilterStop" ><strong>SET_ZONE:FilterStop()</strong></a></h2>
</div>
<p>Stops the filtering for the defined collection.</p>
<div id= "#Functions##FilterStop" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).FindNearestObjectFromPointVec2" ><strong>SET_ZONE:FindNearestObjectFromPointVec2(PointVec2)</strong></a></h2>
</div>
<p>Iterate the SET_BASE while identifying the nearest object from a <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>.</p>
<div id= "#Functions##FindNearestObjectFromPointVec2" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a>
<strong><strong>PointVec2</strong></strong>
</p>
</div>
<div class="w3-half">
<p>A <a href="Core.Point.html##(POINT_VEC2)">Core.Point#POINT_VEC2</a> object from where to evaluate the closest object in the 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="Core.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The closest 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="#(SET_ZONE).Flush" ><strong>SET_ZONE:Flush(MasterObject)</strong></a></h2>
</div>
<p>Flushes the current SET_BASE contents in the log ...</p>
<p>(for debugging reasons).</p>
<div id= "#Functions##Flush" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.Base#BASE</a>
<strong><strong>MasterObject</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) The master object as a 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>#string:</p>
</div>
<div class="w3-half">
<p>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).ForEach" ><strong>SET_ZONE:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)</strong></a></h2>
</div>
<p>Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.</p>
<div id= "#Functions##ForEach" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>
#function
<strong><strong>IteratorFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The function 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>arg</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>Set</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>Function</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>FunctionArguments</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="##(SET_BASE)">#SET_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="#(SET_ZONE).Get" ><strong>SET_ZONE:Get(ObjectName)</strong></a></h2>
</div>
<p>Gets a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Get" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.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="#(SET_ZONE).GetFirst" ><strong>SET_ZONE:GetFirst()</strong></a></h2>
</div>
<p>Gets the first object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetFirst" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_ZONE).GetLast" ><strong>SET_ZONE:GetLast()</strong></a></h2>
</div>
<p>Gets the last object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetLast" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_ZONE).GetObjectNames" ><strong>SET_ZONE:GetObjectNames()</strong></a></h2>
</div>
<p>Gets a string with all the object names.</p>
<div id= "#Functions##GetObjectNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>A string with the names of the objects.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).GetRandom" ><strong>SET_ZONE:GetRandom()</strong></a></h2>
</div>
<p>Gets a random object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes.</p>
<div id= "#Functions##GetRandom" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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.Base.html##(BASE)">Core.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="#(SET_ZONE).GetSet" ><strong>SET_ZONE:GetSet()</strong></a></h2>
</div>
<p>Gets the Set.</p>
<div id= "#Functions##GetSet" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).GetSetNames" ><strong>SET_ZONE:GetSetNames()</strong></a></h2>
</div>
<p>Gets a list of the Names of the Objects in the Set.</p>
<div id= "#Functions##GetSetNames" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).GetSetObjects" ><strong>SET_ZONE:GetSetObjects()</strong></a></h2>
</div>
<p>Gets a list of the Objects in the Set.</p>
<div id= "#Functions##GetSetObjects" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE).IsIncludeObject" ><strong>SET_ZONE:IsIncludeObject(Object)</strong></a></h2>
</div>
<p>Decides whether to include the Object</p>
<div id= "#Functions##IsIncludeObject" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#table
<strong><strong>Object</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="##(SET_BASE)">#SET_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="#(SET_ZONE).New" ><strong>SET_ZONE:New(Database)</strong></a></h2>
</div>
<p>Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.</p>
<div id= "#Functions##New" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Database</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="##(SET_BASE)">#SET_BASE</a>:</p>
</div>
<div class="w3-half">
</div>
</div>
<h2><strong>Usage:</strong></h2>
<pre class="example"><code>-- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
DBObject = SET_BASE:New()</code></pre>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).OnAfterAdded" ><strong>SET_ZONE:OnAfterAdded(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Added Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterAdded" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).OnAfterRemoved" ><strong>SET_ZONE:OnAfterRemoved(From, Event, To, ObjectName, Object)</strong></a></h2>
</div>
<p>Removed Handler OnAfter for SET_BASE</p>
<div id= "#Functions##OnAfterRemoved" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>From</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>To</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>ObjectName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the object.</p>
</div>
</div>
<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.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).Remove" ><strong>SET_ZONE:Remove(ObjectName, NoTriggerEvent)</strong></a></h2>
</div>
<p>Removes a <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object from the <a href="Core.Set.html##(SET_BASE)">Core.Set#SET_BASE</a> and derived classes, based on the Object Name.</p>
<div id= "#Functions##Remove" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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>NoTriggerEvent</strong></strong>
</p>
</div>
<div class="w3-half">
<p>(optional) When <code>true</code>, the :Remove() method will not trigger a <strong>Removed</strong> 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="#(SET_ZONE).SetDatabase" ><strong>SET_ZONE:SetDatabase(BaseSet)</strong></a></h2>
</div>
<p>Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).</p>
<div id= "#Functions##SetDatabase" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_BASE</a>
<strong><strong>BaseSet</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="##(SET_BASE)">#SET_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="#(SET_ZONE).SetIteratorIntervals" ><strong>SET_ZONE:SetIteratorIntervals(YieldInterval, TimeInterval)</strong></a></h2>
</div>
<p>Define the SET iterator <strong>"yield interval"</strong> and the <strong>"time interval"</strong>.</p>
<div id= "#Functions##SetIteratorIntervals" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>YieldInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>TimeInterval</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 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="##(SET_BASE)">#SET_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="#(SET_ZONE)._EventOnBirth" ><strong>SET_ZONE:_EventOnBirth(Event)</strong></a></h2>
</div>
<p>Handles the OnBirth event for the Set.</p>
<div id= "#Functions##_EventOnBirth" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE)._EventOnDeadOrCrash" ><strong>SET_ZONE:_EventOnDeadOrCrash(Event)</strong></a></h2>
</div>
<p>Handles the OnDead or OnCrash event for alive units set.</p>
<div id= "#Functions##_EventOnDeadOrCrash" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE)._FilterStart" ><strong>SET_ZONE:_FilterStart()</strong></a></h2>
</div>
<p>Starts the filtering for the defined collection.</p>
<div id= "#Functions##_FilterStart" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Set.html##(SET_BASE)">Core.Set#SET_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="##(SET_BASE)">#SET_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="#(SET_ZONE)._Find" ><strong>SET_ZONE:_Find(ObjectName)</strong></a></h2>
</div>
<p>Finds an <a href="Core.Base.html##(BASE)">Core.Base#BASE</a> object based on the object Name.</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="Core.Set.html##(SET_BASE)">Core.Set#SET_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>ObjectName</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.Base.html##(BASE)">Core.Base#BASE</a>:</p>
</div>
<div class="w3-half">
<p>The Object found.</p>
</div>
</div>
</div>
</div>
</div>
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</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="#(SET_ZONE).ClearState" ><strong>SET_ZONE: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="#(SET_ZONE).CreateEventBirth" ><strong>SET_ZONE: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="#(SET_ZONE).CreateEventCrash" ><strong>SET_ZONE: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="#(SET_ZONE).CreateEventDead" ><strong>SET_ZONE: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="#(SET_ZONE).CreateEventRemoveUnit" ><strong>SET_ZONE: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="#(SET_ZONE).CreateEventTakeoff" ><strong>SET_ZONE: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="#(SET_ZONE).E" ><strong>SET_ZONE: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="#(SET_ZONE).EventDispatcher" ><strong>SET_ZONE: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="#(SET_ZONE).EventRemoveAll" ><strong>SET_ZONE: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="#(SET_ZONE).F" ><strong>SET_ZONE: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="#(SET_ZONE).F2" ><strong>SET_ZONE: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="#(SET_ZONE).F3" ><strong>SET_ZONE: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="#(SET_ZONE).GetClassID" ><strong>SET_ZONE: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="#(SET_ZONE).GetClassName" ><strong>SET_ZONE: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="#(SET_ZONE).GetClassNameAndID" ><strong>SET_ZONE: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="#(SET_ZONE).GetEventPriority" ><strong>SET_ZONE: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="#(SET_ZONE).GetParent" ><strong>SET_ZONE: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>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>
<strong><strong>FromClass</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="##(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="#(SET_ZONE).GetState" ><strong>SET_ZONE: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, nillified 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="#(SET_ZONE).HandleEvent" ><strong>SET_ZONE:HandleEvent(Event, 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>Event</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#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="#(SET_ZONE).I" ><strong>SET_ZONE: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="#(SET_ZONE).Inherit" ><strong>SET_ZONE: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="#(SET_ZONE).IsInstanceOf" ><strong>SET_ZONE: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="#(SET_ZONE).IsTrace" ><strong>SET_ZONE: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="#(SET_ZONE).New" ><strong>SET_ZONE: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="#(SET_ZONE).OnEvent" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventBaseCaptured" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventBirth" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventCrash" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventDead" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventEjection" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventEngineShutdown" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventEngineStartup" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventHit" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventHumanFailure" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventLand" ><strong>SET_ZONE:OnEventLand(EventData)</strong></a></h2>
</div>
<p>Occurs when an aircraft lands at an airbase, farp or ship
initiator : The unit that has landed
place: Object that the unit landed on.</p>
<p>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="#(SET_ZONE).OnEventMissionEnd" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventMissionStart" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventPilotDead" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventPlayerEnterUnit" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventPlayerLeaveUnit" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventRefueling" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventRefuelingStop" ><strong>SET_ZONE: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="#(SET_ZONE).OnEventShootingEnd" ><strong>SET_ZONE: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 shooing. </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="#(SET_ZONE).OnEventShootingStart" ><strong>SET_ZONE:OnEventShootingStart(EventData)</strong></a></h2>
</div>
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
initiator : The unit that is doing the shooing.
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="#(SET_ZONE).OnEventShot" ><strong>SET_ZONE:OnEventShot(EventData)</strong></a></h2>
</div>
<p>Occurs whenever any unit in a mission fires a weapon.</p>
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.</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="#(SET_ZONE).OnEventTakeoff" ><strong>SET_ZONE: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 tookoff
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
<strong><strong>EventData</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The EventData structure.</p>
</div>
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(SET_ZONE).ScheduleOnce" ><strong>SET_ZONE: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="#(SET_ZONE).ScheduleRepeat" ><strong>SET_ZONE: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="#(SET_ZONE).ScheduleStop" ><strong>SET_ZONE: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="#(SET_ZONE).SetEventPriority" ><strong>SET_ZONE: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">
</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="#(SET_ZONE).SetState" ><strong>SET_ZONE: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, nillified 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="#(SET_ZONE).T" ><strong>SET_ZONE: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="#(SET_ZONE).T2" ><strong>SET_ZONE: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="#(SET_ZONE).T3" ><strong>SET_ZONE: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="#(SET_ZONE).TraceAll" ><strong>SET_ZONE: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="#(SET_ZONE).TraceClass" ><strong>SET_ZONE: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="#(SET_ZONE).TraceClassMethod" ><strong>SET_ZONE: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="#(SET_ZONE).TraceLevel" ><strong>SET_ZONE: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="#(SET_ZONE).TraceOnOff" ><strong>SET_ZONE: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="#(SET_ZONE).UnHandleEvent" ><strong>SET_ZONE:UnHandleEvent(Event)</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>Event</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="##(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="#(SET_ZONE)._F" ><strong>SET_ZONE:_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="#(SET_ZONE)._T" ><strong>SET_ZONE:_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="#(SET_ZONE).onEvent" ><strong>SET_ZONE:onEvent(event)</strong></a></h2>
</div>
<p> TODO: Complete DCS#Event structure. <br/>
- 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/Core_Sets.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>