mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2026-07-16 14:23:02 +00:00
MooseBotter
31189 lines
1.0 MiB
Plaintext
31189 lines
1.0 MiB
Plaintext
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-97385487-1"></script>
|
|
<script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'UA-97385487-1');</script>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="https://www.w3schools.com/lib/w3-theme-indigo.css">
|
|
<link rel="stylesheet" href="../Highlight/styles/github.css">
|
|
<script src="../Highlight/highlight.pack.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
<link rel="stylesheet" href="w3.css" type="text/css"/>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
|
|
<style>
|
|
.picturebox {
|
|
height:100px;
|
|
}
|
|
|
|
</style>
|
|
</head>
|
|
<body onload="myLoadFunction()" >
|
|
<div id="myHeader" class="w3-container sticky w3-border-white w3-bottombar" style="background-image:url('../Images/MOOSE.JPG');">
|
|
<h1>
|
|
<i class="fa fa-bars w3-text-white fa-2x" onclick="w3_open()"></i>
|
|
</h1>
|
|
</div>
|
|
<div id="main">
|
|
<nav class="w3-sidenav w3-theme-l5 w3-animate-left" style="display:none">
|
|
<a href="javascript:void(0)"
|
|
onclick="w3_close()"
|
|
class="w3-closenav w3-large">Close ×</a>
|
|
<div class="w3-row">
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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> - 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> - 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> - 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> - Models the process of air patrol of airplanes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_BAI.html">AI.AI_A2G_BAI</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of air to ground BAI engagement for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_CAS.html">AI.AI_A2G_CAS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of air to ground engagement for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Dispatching.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_Dispatcher.html">AI.AI_A2G_Dispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_SEAD.html">AI.AI_A2G_SEAD</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of air to ground SEAD engagement for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air.html">AI.AI_Air</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of AI air operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Dispatching.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Dispatcher.html">AI.AI_Air_Dispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Engage.html">AI.AI_Air_Engage</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of air to ground engagement for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Patrol.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Patrol.html">AI.AI_Air_Patrol</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Squadron.html">AI.AI_Air_Squadron</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models squadrons for airplanes and helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Battlefield_Air_Interdiction.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_BAI.html">AI.AI_BAI</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Peform Battlefield Area Interdiction (BAI) within an engagement zone.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Balancing.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Balancer.html">AI.AI_Balancer</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Combat_Air_Patrol.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_CAP.html">AI.AI_CAP</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Perform Combat Air Patrolling (CAP) for airplanes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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/Cargo.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo.html">AI.AI_Cargo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatching_For_APC.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_APC.html">AI.AI_Cargo_APC</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of cargo using ground vehicles.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatching_For_Airplanes.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Airplane.html">AI.AI_Cargo_Airplane</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of cargo using airplanes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatcher.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher.html">AI.AI_Cargo_Dispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatching_For_APC.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_APC.html">AI.AI_Cargo_Dispatcher_APC</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using APCs.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatching_For_Airplanes.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Airplane.html">AI.AI_Cargo_Dispatcher_Airplane</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - 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> - 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_Dispatcher.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Ship.html">AI.AI_Cargo_Dispatcher_Ship</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using Ships.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatching_For_Helicopters.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Helicopter.html">AI.AI_Cargo_Helicopter</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the intelligent transportation of cargo using helicopters.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Cargo_Dispatcher.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Ship.html">AI.AI_Cargo_Ship</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - 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/Escorting.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort.html">AI.AI_Escort</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Taking the lead of AI escorting your flight or of other AI.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Dispatcher.html">AI.AI_Escort_Dispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the automatic assignment of AI escorts to player flights.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Dispatcher_Request.html">AI.AI_Escort_Dispatcher_Request</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Models the assignment of AI escorts to player flights upon request using the radio menu.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Escorting.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Request.html">AI.AI_Escort_Request</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>AI</strong> - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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.Act_Account.html">Actions.Act_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 & report) various DCS events occurring on 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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Assign.html">Actions.Act_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.Act_Assist.html">Actions.Act_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.Act_Route.html">Actions.Act_Route</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Cargo.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.Cargo.html">Cargo.Cargo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Cargo</strong> - Management of CARGO logistics, that can be transported from and to transportation carriers.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Cargo_Crates.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoCrate.html">Cargo.CargoCrate</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Cargo</strong> - Management of single cargo crates, which are based on a STATIC 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 GROUP 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 STATIC 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 UNIT 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_Astar.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Astar.html">Core.Astar</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - A* Pathfinding.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Base.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Base.html">Core.Base</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - The base class within the framework.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Beacon.html">Core.Beacon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - TACAN and other beacons.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Menu.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ClientMenu.html">Core.ClientMenu</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Client Menu Management.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Condition.html">Core.Condition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define any or all conditions to be evaluated.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Database.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Database.html">Core.Database</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manages several databases containing templates, mission objects, and mission information.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Event.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Event.html">Core.Event</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models DCS event dispatching using a publish-subscribe model.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Finite_State_Machine.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Fsm.html">Core.Fsm</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Goal.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Goal.html">Core.Goal</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models the process to achieve goal(s).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE_Core.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.MarkerOps_Base.html">Core.MarkerOps_Base</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Tap into markers added to the F10 map by users.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Menu.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Menu.html">Core.Menu</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manage hierarchical menu structures and commands for players within a mission.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Message.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Message.html">Core.Message</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Informs the players using messages during a simulation.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/CORE_Pathline.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Pathline.html">Core.Pathline</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Path from A to B.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Coordinate.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Point.html">Core.Point</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Report.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Report.html">Core.Report</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Provides a handy means to create messages and reports.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Schedule_Dispatcher.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ScheduleDispatcher.html">Core.ScheduleDispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<ul>
|
|
<li><strong>Core</strong> - SCHEDULEDISPATCHER dispatches the different schedules.</li>
|
|
</ul>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Scheduler.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Scheduler.html">Core.Scheduler</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Prepares and handles the execution of functions over scheduled time (intervals).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Sets.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Set.html">Core.Set</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define collections of objects to perform bulk actions and logically group objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Settings.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Settings.html">Core.Settings</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manages various settings for missions, providing a menu for players to tweak settings in running missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Spawn.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spawn.html">Core.Spawn</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Spawn dynamically new groups of units in running missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Spawnstatic.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.SpawnStatic.html">Core.SpawnStatic</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Spawn statics.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Spot.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spot.html">Core.Spot</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.TextAndSound.html">Core.TextAndSound</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - A Moose GetText system.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Scheduler.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Timer scheduler.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Userflag.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserFlag.html">Core.UserFlag</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manage user flags to interact with the mission editor trigger system and server side scripts.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/CORE_Vector.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Vector.html">Core.Vector</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>CORE</strong> - Vector algebra.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Velocity.html">Core.Velocity</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Models a velocity or speed, which can be expressed in various formats according the settings.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Zones.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone.html">Core.Zone</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define zones within your mission of various forms, with various capabilities.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone_Detection.html">Core.Zone_Detection</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="DCS.html">DCS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>DCS API</strong> Prototypes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AICSAR.html">Functional.AICSAR</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - AI CSAR system.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Air_Traffic_Control_Ground_Operations.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ATC_Ground.html">Functional.ATC_Ground</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Monitor airbase traffic and regulate speed while taxiing.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Artillery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AmmoTruck.html">Functional.AmmoTruck</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> -- Send a truck to supply artillery groups.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Artillery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Artillery.html">Functional.Artillery</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Control artillery units.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Designation.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Autolase.html">Functional.Autolase</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Autolase targets in the field.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/CleanUp_Airbases.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.CleanUp.html">Functional.CleanUp</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/clientwatch.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ClientWatch.html">Functional.ClientWatch</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Manage and track client slots easily to add your own client-based menus and modules to.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Designation.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Designate.html">Functional.Designate</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Management of target <strong>Designation</strong>.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Detection.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Detection.html">Functional.Detection</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Models the detection of enemy units by FACs or RECCEs and group them according various methods.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.DetectionZones.html">Functional.DetectionZones</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Captures the class DETECTION_ZONES.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Escorting.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Escort.html">Functional.Escort</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Taking the lead of AI escorting your flight.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Large_Formations.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.FORMATION.html">Functional.FORMATION</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Build large airborne formations of aircraft.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Functional_FOX.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Fox.html">Functional.Fox</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Yet Another Missile Trainer.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Functional.Mantis.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Mantis.html">Functional.Mantis</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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> - Basic ATC.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/RAT.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.RAT.html">Functional.RAT</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Create random air traffic in your missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Range.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Range.html">Functional.Range</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Range Practice.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Scoring.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Scoring.html">Functional.Scoring</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Administer the scoring of player achievements, file and log the scoring events for use at websites.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/SEAD.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Sead.html">Functional.Sead</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Make SAM sites evasive and execute defensive behaviour when being fired upon.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Functional.Shorad.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Shorad.html">Functional.Shorad</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Short Range Air Defense System.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Functional.Stratego.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Stratego.html">Functional.Stratego</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Stratego.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Suppression.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Suppression.html">Functional.Suppression</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Suppress fire of ground units when they get hit.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Functional.Tiresias.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Tiresias.html">Functional.Tiresias</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Warehouse.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Warehouse.html">Functional.Warehouse</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Simulation of logistic operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Capture_Zones.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneCaptureCoalition.html">Functional.ZoneCaptureCoalition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Models the process to zone guarding and capturing.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoal.html">Functional.ZoneGoal</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Base class that models processes to achieve goals involving a Zone.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.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</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 modeling processes to achieve goals involving coalition zones.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Beacons.html">Navigation.Beacons</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Beacons of the map/theatre.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Point.html">Navigation.Point</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Navigation Airspace Points, Fixes and Aids.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Radios.html">Navigation.Radios</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Airbase radios.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Navigation.Towns.html">Navigation.Towns</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>NAVIGATION</strong> - Towns of the map/theatre.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_FlightControl.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="OPS.FlightControl.html">OPS.FlightControl</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>OPS</strong> - Air Traffic Control for AI and human players.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_ATIS.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ATIS.html">Ops.ATIS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_AWACS.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.AWACS.html">Ops.AWACS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - MOOSE AI AWACS Operations using text-to-speech.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Ops_Airboss.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airboss.html">Ops.Airboss</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_AirWing.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airwing.html">Ops.Airwing</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Airwing Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_ArmyGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ArmyGroup.html">Ops.ArmyGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Ground Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Auftrag.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Auftrag.html">Ops.Auftrag</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Brigade_.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Brigade.html">Ops.Brigade</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Brigade Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_CSAR.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CSAR.html">Ops.CSAR</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Combat Search and Rescue.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_CTLD.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CTLD.html">Ops.CTLD</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Combat Troops & Logistics Department.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Chief.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Chief.html">Ops.Chief</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Chief of Staff.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Cohort.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Cohort.html">Ops.Cohort</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Cohort encompassed all characteristics of SQUADRONs, PLATOONs and FLOTILLAs.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Commander.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Commander.html">Ops.Commander</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Commander of Airwings, Brigades and Fleets.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Air_To_Ground_Dispatching.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.EasyAG.html">Ops.EasyAG</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Create your A2G Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/AI_Combat_Air_Patrol.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.EasyGCICAP.html">Ops.EasyGCICAP</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Create your A2A Defenses.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Fleet.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Fleet.html">Ops.Fleet</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Fleet Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_FlightGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.FlightGroup.html">Ops.FlightGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Airborne Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Flotilla.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Flotilla.html">Ops.Flotilla</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Flotilla is a small naval group belonging to a fleet.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Intel.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Intel.html">Ops.Intel</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Office of Military Intelligence.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Legion.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Legion.html">Ops.Legion</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Legion Warehouse.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_NavyGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.NavyGroup.html">Ops.NavyGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Enhanced Naval Group.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Operation.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Operation.html">Ops.Operation</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Operation with multiple phases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_OpsGroup.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsGroup.html">Ops.OpsGroup</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Generic group enhancement.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_OpsTransport.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsTransport.html">Ops.OpsTransport</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Transport assignment for OPS groups and storage.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_OpsZone.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsZone.html">Ops.OpsZone</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Strategic Zone.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Platoon.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Platoon.html">Ops.Platoon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Brigade Platoon.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Ops_PlayerRecce.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerRecce.html">Ops.PlayerRecce</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Allow a player in a helo like the Gazelle, KA-50 to recon and lase ground targets.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_PlayerTask.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerTask.html">Ops.PlayerTask</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - PlayerTask (mission) for Players.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Ops_RecoveryTanker.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RecoveryTanker.html">Ops.RecoveryTanker</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Recovery tanker for carrier operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Ops_RescueHelo.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RescueHelo.html">Ops.RescueHelo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Rescue helicopter for carrier operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Squadron.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Squadron.html">Ops.Squadron</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Airwing Squadron.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_Target.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Target.html">Ops.Target</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Ops</strong> - Target.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.CUBE.html">Shapes.CUBE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.LINE.html">Shapes.LINE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.OVAL.html">Shapes.OVAL</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.POLYGON.html">Shapes.POLYGON</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/CORE_Pathline.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.SHAPE_BASE.html">Shapes.SHAPE_BASE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Shapes</strong> - Class that serves as the base shapes drawn in the Mission Editor</p>
|
|
|
|
|
|
<h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3>
|
|
|
|
<hr/>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.TRIANGLE.html">Shapes.TRIANGLE</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p>TRIANGLE class with properties and methods for handling triangles.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.Radio.html">Sound.Radio</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Radio transmissions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioQueue.html">Sound.RadioQueue</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Queues Radio Transmissions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Radio.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioSpeech.html">Sound.RadioSpeech</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Makes the radio talk.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Sound_MSRS.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SRS.html">Sound.SRS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Simple Radio Standalone (SRS) Integration and Text-to-Speech.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Sound_SoundOutput.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SoundOutput.html">Sound.SoundOutput</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Sound output classes.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Usersound.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.UserSound.html">Sound.UserSound</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Sound</strong> - Manage user sound.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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.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/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Capture_Dispatcher.html">Tasking.Task_Capture_Dispatcher</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Tasking</strong> - Creates and manages player TASK_ZONE_CAPTURE tasks.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Capture_Zone.html">Tasking.Task_Capture_Zone</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/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><strong>Tasking</strong> - 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="Utilities.Enums.html">Utilities.Enums</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> Enumerators.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.FiFo.html">Utilities.FiFo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p> <strong>UTILS</strong> - Classic FiFo Stack.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Utils_Profiler.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Profiler.html">Utilities.Profiler</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utils</strong> - Lua Profiler.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Socket.html">Utilities.Socket</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - Socket.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Utils.html">Utilities.Utils</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Airbase.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Airbase.html">Wrapper.Airbase</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - AIRBASE is a wrapper class to handle the DCS Airbase objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Client.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Client.html">Wrapper.Client</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - CLIENT wraps DCS Unit objects acting as a <strong>Client</strong> or <strong>Player</strong> within a mission.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Controllable.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Controllable.html">Wrapper.Controllable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Storage.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.DynamicCargo.html">Wrapper.DynamicCargo</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Dynamic Cargo create from the F8 menu.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Group.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Group.html">Wrapper.Group</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - GROUP wraps the DCS Class Group objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Identifiable.html">Wrapper.Identifiable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE_Core.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Markers On the F10 map.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Utils_Profiler.jpg" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Net.html">Wrapper.Net</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - DCS net functions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Object.html">Wrapper.Object</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - OBJECT wraps the DCS Object derived objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Positionable.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Positionable.html">Wrapper.Positionable</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - POSITIONABLE wraps DCS classes that are "positionable".</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Scenery.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Scenery.html">Wrapper.Scenery</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - SCENERY models scenery within the DCS simulator.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Static.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Static.html">Wrapper.Static</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - STATIC wraps the DCS StaticObject class.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Storage.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Storage.html">Wrapper.Storage</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Warehouse storage of DCS airbases.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Unit.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Unit.html">Wrapper.Unit</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - UNIT is a wrapper class for the DCS Class Unit.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Wrapper_Weapon.png" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Weapon.html">Wrapper.Weapon</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Wrapper</strong> - Weapon functions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<img src="..\Images\OPS_PlayerTask.jpg" alt="Banner Image"/>
|
|
<div id="content">
|
|
<div class="w3-container w3-theme-d5" id="module_title">
|
|
<h1>Module <strong>Ops.PlayerTask</strong></h1>
|
|
</div>
|
|
<div class="w3-container w3-white" id="module_description">
|
|
|
|
<p><strong>Ops</strong> - PlayerTask (mission) for Players.</p>
|
|
|
|
|
|
|
|
<h2>Main Features:</h2>
|
|
|
|
<ul>
|
|
<li>Simplifies defining and executing Player tasks</li>
|
|
<li>FSM events when a mission is added, done, successful or failed, replanned</li>
|
|
<li>Ready to use SRS and localization</li>
|
|
<li>Mission locations can be smoked, flared, illuminated and marked on the map</li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
<h2>Example Missions:</h2>
|
|
|
|
<p>Demo missions can be found on <a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Ops/PlayerTask">GitHub</a>.</p>
|
|
|
|
<hr/>
|
|
|
|
<h3>Author: <strong>Applevangelist</strong></h3>
|
|
<h3>Special thanks to: Streakeagle</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##PLAYERTASK')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>PLAYERTASK</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##PLAYERTASK" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(PLAYERTASK)">#PLAYERTASK</a>
|
|
<a id="PLAYERTASK" ><strong>PLAYERTASK</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-theme-d2 w3-margin-top ">
|
|
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##PLAYERTASKCONTROLLER')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>PLAYERTASKCONTROLLER</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
|
|
<p><em>It is our attitude at the beginning of a difficult task which, more than anything else, which will affect its successful outcome.</em> (William James)</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>PLAYERTASKCONTROLLER</h1>
|
|
|
|
<ul>
|
|
<li>Simplifies defining, executing and controlling of Player tasks</li>
|
|
<li>FSM events when a mission is added, done, successful or failed, replanned</li>
|
|
<li>Ready to use SRS and localization</li>
|
|
<li>Mission locations can be smoked, flared and marked on the map</li>
|
|
</ul>
|
|
|
|
<h2>1 Overview</h2>
|
|
|
|
<p>PLAYERTASKCONTROLLER is used to auto-create (optional) and control tasks for players.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##PLAYERTASKCONTROLLER" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>
|
|
<a id="PLAYERTASKCONTROLLER" ><strong>PLAYERTASKCONTROLLER</strong></a>
|
|
|
|
|
|
<p><em>It is our attitude at the beginning of a difficult task which, more than anything else, which will affect its successful outcome.</em> (William James)</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>PLAYERTASKCONTROLLER</h1>
|
|
|
|
<ul>
|
|
<li>Simplifies defining, executing and controlling of Player tasks</li>
|
|
<li>FSM events when a mission is added, done, successful or failed, replanned</li>
|
|
<li>Ready to use SRS and localization</li>
|
|
<li>Mission locations can be smoked, flared and marked on the map</li>
|
|
</ul>
|
|
|
|
<h2>1 Overview</h2>
|
|
|
|
<p>PLAYERTASKCONTROLLER is used to auto-create (optional) and control tasks for players.</p>
|
|
|
|
|
|
<p>It can be set up as Air-to-Ground (A2G, main focus), Air-to-Ship (A2S) or Air-to-Air (A2A) controller.
|
|
For the latter task type, also have a look at the <a href="Ops.AWACS.html##(AWACS)">Ops.AWACS#AWACS</a> class which allows for more complex scenarios.
|
|
One task at a time can be joined by the player from the F10 menu. A task can be joined by multiple players. Once joined, task information is available via the F10 menu, the task location
|
|
can be marked on the map and for A2G/S targets, the target can be marked with smoke and flares.</p>
|
|
|
|
<p>For the mission designer, tasks can be auto-created by means of detection with the integrated <a href="Ops.Intel.html##(INTEL)">Ops.Intel#INTEL</a> class setup, or be manually added to the task queue.</p>
|
|
|
|
<h2>2 Task Types</h2>
|
|
|
|
<p>Targets can be of types GROUP, SET_GROUP, UNIT, SET_UNIT, STATIC, SET_STATIC, SET_SCENERY, AIRBASE, ZONE or COORDINATE. The system will auto-create tasks for players from these targets.
|
|
Tasks are created as <a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a> objects, which leverage <a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a> for the management of the actual target. The system creates these task types
|
|
from the target objects: </p>
|
|
|
|
<ul>
|
|
<li>A2A - AUFTRAG.Type.INTERCEPT</li>
|
|
<li>A2S - AUFTRAG.Type.ANTISHIP</li>
|
|
<li>A2G - AUFTRAG.Type.CAS, AUFTRAG.Type.BAI, AUFTRAG.Type.SEAD, AUFTRAG.Type.BOMBING, AUFTRAG.Type.PRECISIONBOMBING, AUFTRAG.Type.BOMBRUNWAY</li>
|
|
<li>A2GS - A2S and A2G combined</li>
|
|
</ul>
|
|
|
|
<p>Task types are derived from <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>: </p>
|
|
|
|
<ul>
|
|
<li>CAS - Close air support, created to attack ground units, where friendly ground units are around the location in a bespoke radius (default: 500m/1km diameter)</li>
|
|
<li>BAI - Battlefield air interdiction, same as above, but no friendlies around</li>
|
|
<li>SEAD - Same as CAS, but the enemy ground units field AAA, SAM or EWR units</li>
|
|
<li>Bombing - Against static targets</li>
|
|
<li>Precision Bombing - (if enabled) Laser-guided bombing, against <strong>static targets</strong> and <strong>high-value (non-SAM) ground targets (MBTs etc)</strong></li>
|
|
<li>Bomb Runway - Against Airbase runways (in effect, drop bombs over the runway)</li>
|
|
<li>ZONE and COORDINATE - Targets will be scanned for GROUND or STATIC enemy units and tasks created from these</li>
|
|
<li>Intercept - Any airborne targets, if the controller is of type "A2A"</li>
|
|
<li>Anti-Ship - Any ship targets, if the controller is of type "A2S"</li>
|
|
<li>CTLD - Combat transport and logistics deployment</li>
|
|
<li>CSAR - Combat search and rescue</li>
|
|
<li>RECON - Identify targets</li>
|
|
<li>CAPTUREZONE - Capture an Ops.OpsZone#OPSZONE</li>
|
|
<li>Any #string name can be passed as Auftrag type, but then you need to make sure to define a success condition, and possibly also add the task type to the standard scoring list: <code>PLAYERTASKCONTROLLER.Scores["yournamehere"]=100</code></li>
|
|
</ul>
|
|
|
|
<h2>3 Task repetition</h2>
|
|
|
|
<p>On failure, tasks will be replanned by default for a maximum of 5 times.</p>
|
|
|
|
<h2>3.1 Pre-configured success conditions</h2>
|
|
|
|
<p>Pre-configured success conditions for #PLAYERTASK tasks are available as follows:</p>
|
|
|
|
<p><code>mytask:AddStaticObjectSuccessCondition()</code> -- success if static object is at least 80% dead</p>
|
|
|
|
<p><code>mytask:AddOpsZoneCaptureSuccessCondition(CaptureSquadGroupNamePrefix,Coalition)</code> -- success if a squad of the given (partial) name and coalition captures the OpsZone</p>
|
|
|
|
<p><code>mytask:AddReconSuccessCondition(MinDistance)</code> -- success if object is in line-of-sight with the given min distance in NM</p>
|
|
|
|
<p><code>mytask:AddTimeLimitSuccessCondition(TimeLimit)</code> -- failure if the task is not completed within the time limit in seconds given</p>
|
|
|
|
<h2>3.2 Task chaining</h2>
|
|
|
|
<p>You can create chains of tasks, which will depend on success or failure of the previous task with the following commands:</p>
|
|
|
|
<p><code>mytask:AddNextTaskAfterSuccess(FollowUpTask)</code> and </p>
|
|
|
|
<p><code>mytask:AddNextTaskAfterFailure(FollowUpTask)</code></p>
|
|
|
|
<h2>4 SETTINGS, SRS and language options (localization)</h2>
|
|
|
|
<p>The system can optionally communicate to players via SRS. Also localization is available, both "en" and "de" has been build in already.
|
|
Player and global <a href="Core.Settings.html##(SETTINGS)">Core.Settings#SETTINGS</a> for coordinates will be observed.</p>
|
|
|
|
<h2>5 Setup</h2>
|
|
|
|
<p>A basic setup is very simple:</p>
|
|
|
|
<pre><code> -- Settings - we want players to have a settings menu, be on imperial measures, and get directions as BR
|
|
_SETTINGS:SetPlayerMenuOn()
|
|
_SETTINGS:SetImperial()
|
|
_SETTINGS:SetA2G_BR()
|
|
|
|
-- Set up the A2G task controller for the blue side named "82nd Airborne"
|
|
local taskmanager = PLAYERTASKCONTROLLER:New("82nd Airborne",coalition.side.BLUE,PLAYERTASKCONTROLLER.Type.A2G)
|
|
|
|
-- set locale to English
|
|
taskmanager:SetLocale("en")
|
|
|
|
-- Set up detection with grup names *containing* "Blue Recce", these will add targets to our controller via detection. Can be e.g. a drone.
|
|
taskmanager:SetupIntel("Blue Recce")
|
|
|
|
-- Add a single Recce group name "Blue Humvee"
|
|
taskmanager:AddAgent(GROUP:FindByName("Blue Humvee"))
|
|
|
|
-- Set the callsign for SRS and Menu name to be "Groundhog"
|
|
taskmanager:SetMenuName("Groundhog")
|
|
|
|
-- Add accept- and reject-zones for detection
|
|
-- Accept zones are handy to limit e.g. the engagement to a certain zone. The example is a round, mission editor created zone named "AcceptZone"
|
|
taskmanager:AddAcceptZone(ZONE:New("AcceptZone"))
|
|
|
|
-- Reject zones are handy to create borders. The example is a ZONE_POLYGON, created in the mission editor, late activated with waypoints,
|
|
-- named "AcceptZone#ZONE_POLYGON"
|
|
taskmanager:AddRejectZone(ZONE:FindByName("RejectZone"))
|
|
|
|
-- Set up using SRS for messaging
|
|
local hereSRSPath = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio"
|
|
local hereSRSPort = 5002
|
|
-- local hereSRSGoogle = "C:\\Program Files\\DCS-SimpleRadio-Standalone\\ExternalAudio\\yourkey.json"
|
|
taskmanager:SetSRS({130,255},{radio.modulation.AM,radio.modulation.AM},hereSRSPath,"female","en-GB",hereSRSPort,"Microsoft Hazel Desktop",0.7,hereSRSGoogle)
|
|
|
|
-- Controller will announce itself under these broadcast frequencies, handy to use cold-start frequencies here of your aircraft
|
|
taskmanager:SetSRSBroadcast({127.5,305},{radio.modulation.AM,radio.modulation.AM})
|
|
|
|
-- Example: Manually add an AIRBASE as a target
|
|
taskmanager:AddTarget(AIRBASE:FindByName(AIRBASE.Caucasus.Senaki_Kolkhi))
|
|
|
|
-- Example: Manually add a COORDINATE as a target
|
|
taskmanager:AddTarget(GROUP:FindByName("Scout Coordinate"):GetCoordinate())
|
|
|
|
-- Set a whitelist for tasks, e.g. skip SEAD tasks
|
|
taskmanager:SetTaskWhiteList({AUFTRAG.Type.CAS, AUFTRAG.Type.BAI, AUFTRAG.Type.BOMBING, AUFTRAG.Type.BOMBRUNWAY})
|
|
|
|
-- Set target radius
|
|
taskmanager:SetTargetRadius(1000)
|
|
</code></pre>
|
|
|
|
<h2>6 Localization</h2>
|
|
|
|
<p>Localization for English and German texts are build-in. Default setting is English. Change with <a href="##(PLAYERTASKCONTROLLER).SetLocale">PLAYERTASKCONTROLLER.SetLocale</a>()</p>
|
|
|
|
<h3>6.1 Adding Localization</h3>
|
|
|
|
<p>A list of fields to be defined follows below. <strong>Note</strong> that in some cases <code>string.format()</code> is used to format texts for screen and SRS.
|
|
Hence, the <code>%d</code>, <code>%s</code> and <code>%f</code> special characters need to appear in the exact same amount and order of appearance in the localized text or it will create errors.
|
|
To add a localization, the following texts need to be translated and set in your mission script <strong>before</strong> <a href="##(PLAYERTASKCONTROLLER).New">PLAYERTASKCONTROLLER.New</a>(): </p>
|
|
|
|
<pre><code> PLAYERTASKCONTROLLER.Messages = {
|
|
EN = {
|
|
TASKABORT = "Task aborted!",
|
|
NOACTIVETASK = "No active task!",
|
|
FREQUENCIES = "frequencies ",
|
|
FREQUENCY = "frequency %.3f",
|
|
BROADCAST = "%s, %s, switch to %s for task assignment!",
|
|
CASTTS = "close air support",
|
|
SEADTTS = "suppress air defense",
|
|
BOMBTTS = "bombing",
|
|
PRECBOMBTTS = "precision bombing",
|
|
BAITTS = "battle field air interdiction",
|
|
ANTISHIPTTS = "anti-ship",
|
|
INTERCEPTTS = "intercept",
|
|
BOMBRUNWAYTTS = "bomb runway",
|
|
HAVEACTIVETASK = "You already have one active task! Complete it first!",
|
|
PILOTJOINEDTASK = "%s, %s. You have been assigned %s task %03d",
|
|
TASKNAME = "%s Task ID %03d",
|
|
TASKNAMETTS = "%s Task ID %03d",
|
|
THREATHIGH = "high",
|
|
THREATMEDIUM = "medium",
|
|
THREATLOW = "low",
|
|
THREATTEXT = "%s\nThreat: %s\nTargets left: %d\nCoord: %s",
|
|
THREATTEXTTTS = "%s, %s. Target information for %s. Threat level %s. Targets left %d. Target location %s.",
|
|
MARKTASK = "%s, %s, copy, task %03d location marked on map!",
|
|
SMOKETASK = "%s, %s, copy, task %03d location smoked!",
|
|
FLARETASK = "%s, %s, copy, task %03d location illuminated!",
|
|
ABORTTASK = "All stations, %s, %s has aborted %s task %03d!",
|
|
UNKNOWN = "Unknown",
|
|
MENUTASKING = " Tasking ",
|
|
MENUACTIVE = "Active Task",
|
|
MENUINFO = "Info",
|
|
MENUMARK = "Mark on map",
|
|
MENUSMOKE = "Smoke",
|
|
MENUFLARE = "Flare",
|
|
MENUILLU = "Illuminate",
|
|
MENUABORT = "Abort",
|
|
MENUJOIN = "Join Task",
|
|
MENUTASKINFO = Task Info",
|
|
MENUTASKNO = "TaskNo",
|
|
MENUNOTASKS = "Currently no tasks available.",
|
|
TASKCANCELLED = "Task #%03d %s is cancelled!",
|
|
TASKCANCELLEDTTS = "%s, task %03d %s is cancelled!",
|
|
TASKSUCCESS = "Task #%03d %s completed successfully!",
|
|
TASKSUCCESSTTS = "%s, task %03d %s completed successfully!",
|
|
TASKFAILED = "Task #%03d %s was a failure!",
|
|
TASKFAILEDTTS = "%s, task %03d %s was a failure!",
|
|
TASKFAILEDREPLAN = "Task #%03d %s was a failure! Replanning!",
|
|
TASKFAILEDREPLANTTS = "%s, task %03d %s was a failure! Replanning!",
|
|
TASKADDED = "%s has a new task %s available!",
|
|
PILOTS = "\nPilot(s): ",
|
|
PILOTSTTS = ". Pilot(s): ",
|
|
YES = "Yes",
|
|
NO = "No",
|
|
NONE = "None",
|
|
POINTEROVERTARGET = "%s, %s, pointer in reach for task %03d, lasing!",
|
|
POINTERTARGETREPORT = "\nPointer in reach: %s\nLasing: %s",
|
|
RECCETARGETREPORT = "\nRecce %s in reach: %s\nLasing: %s",
|
|
POINTERTARGETLASINGTTS = ". Pointer in reach and lasing.",
|
|
TARGET = "Target",
|
|
FLASHON = "%s - Flashing directions is now ON!",
|
|
FLASHOFF = "%s - Flashing directions is now OFF!",
|
|
FLASHMENU = "Flash Directions Switch",
|
|
BRIEFING = "Briefing",
|
|
TARGETLOCATION ="Target location",
|
|
COORDINATE = "Coordinate",
|
|
INFANTRY = "Infantry",
|
|
TECHNICAL = "Technical",
|
|
ARTILLERY = "Artillery",
|
|
TANKS = "Tanks",
|
|
AIRDEFENSE = "Airdefense",
|
|
SAM = "SAM",
|
|
GROUP = "Group",
|
|
ELEVATION = "\nTarget Elevation: %s %s",
|
|
METER = "meter",
|
|
FEET = "feet",
|
|
INTERCEPTCOURSE = "Intercept course",
|
|
},
|
|
</code></pre>
|
|
|
|
<p>e.g.</p>
|
|
|
|
<pre><code> taskmanager.Messages = {
|
|
FR = {
|
|
TASKABORT = "Tâche abandonnée!",
|
|
NOACTIVETASK = "Aucune tâche active!",
|
|
FREQUENCIES = "fréquences ",
|
|
FREQUENCY = "fréquence %.3f",
|
|
BROADCAST = "%s, %s, passer au %s pour l'attribution des tâches!",
|
|
...
|
|
TASKADDED = "%s a créé une nouvelle tâche %s",
|
|
PILOTS = "\nPilote(s): ",
|
|
PILOTSTTS = ". Pilote(s): ",
|
|
},
|
|
</code></pre>
|
|
|
|
<p>and then <code>taskmanager:SetLocale("fr")</code> <strong>after</strong> <a href="##(PLAYERTASKCONTROLLER).New">PLAYERTASKCONTROLLER.New</a>() in your script.</p>
|
|
|
|
<p>If you just want to replace a <strong>single text block</strong> in the table, you can do this like so:</p>
|
|
|
|
<pre><code> mycontroller.Messages.EN.NOACTIVETASK = "Choose a task first!"
|
|
mycontroller.Messages.FR.YES = "Oui"
|
|
</code></pre>
|
|
|
|
<h2>7 Events</h2>
|
|
|
|
<p> The class comes with a number of FSM-based events that missions designers can use to shape their mission.
|
|
These are:</p>
|
|
|
|
<h3>7.1 TaskAdded.</h3>
|
|
|
|
<p>The event is triggered when a new task is added to the controller. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterTaskAdded">PLAYERTASKCONTROLLER.OnAfterTaskAdded</a>() to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterTaskAdded(From, Event, To, Task)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h3>7.2 TaskDone.</h3>
|
|
|
|
<p>The event is triggered when a task has ended. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterTaskDone">PLAYERTASKCONTROLLER.OnAfterTaskDone</a>() to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterTaskDone(From, Event, To, Task)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h3>7.3 TaskCancelled.</h3>
|
|
|
|
<p>The event is triggered when a task was cancelled manually. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterTaskCancelled">PLAYERTASKCONTROLLER.OnAfterTaskCancelled</a>()` to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterTaskCancelled(From, Event, To, Task, Silent)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h3>7.4 TaskSuccess.</h3>
|
|
|
|
<p>The event is triggered when a task completed successfully. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterTaskSuccess">PLAYERTASKCONTROLLER.OnAfterTaskSuccess</a>() to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterTaskSuccess(From, Event, To, Task)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h3>7.5 TaskFailed.</h3>
|
|
|
|
<p>The event is triggered when a task failed, no repeats. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterTaskFailed">PLAYERTASKCONTROLLER.OnAfterTaskFailed</a>() to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterTaskFailed(From, Event, To, Task)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h3>7.6 TaskRepeatOnFailed.</h3>
|
|
|
|
<p>The event is triggered when a task failed and is re-planned for execution. Use <a href="##(PLAYERTASKCONTROLLER).OnAfterRepeatOnFailed">PLAYERTASKCONTROLLER.OnAfterRepeatOnFailed</a>() to link into this event:</p>
|
|
|
|
<pre><code> function taskmanager:OnAfterRepeatOnFailed(From, Event, To, Task)
|
|
... your code here ...
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>8 Using F10 map markers to create new targets</h2>
|
|
|
|
<p>You can use F10 map markers to create new target points for player tasks. <br/>
|
|
Enable this option with e.g., setting the tag to be used to "TARGET":</p>
|
|
|
|
<pre><code> taskmanager:EnableMarkerOps("TARGET")
|
|
</code></pre>
|
|
|
|
<p>Set a marker on the map and add the following text to create targets from it: "TARGET". This is effectively the same as adding a COORDINATE object as target.
|
|
The marker can be deleted any time.</p>
|
|
|
|
<h2>9 Single Task Persistence for mission designer added tasks</h2>
|
|
|
|
<p>The class can persist the state of single tasks of type BOMBING, PRECISIONBOMBING, ARTY and SEAD, i.e. tasks which have a GROUND(!) GROUP, UNIT, STATIC or SCENERY as target.
|
|
This requires the task to have a unique(!) menu name set, a TARGET which already exists on the map at mission start(!), and a flag that this task is actually to be persisted.
|
|
Also, you need to desanitize the mission scripting environment, i.e. "lfs" and "io" must be available so we can write to disk.</p>
|
|
|
|
<pre><code> -- First, we need to enable on the PLAYERTASKCONTROLLER itself
|
|
taskmanager:EnableTaskPersistance([[C:\Users\myname\Saved Games\DCS\Missions\MyMisionFolder\]],"Mission Tasks.csv") -- Path and Filename
|
|
|
|
-- Then, we can design a task marking mission progress that we want to persist
|
|
local RussianRadios = SET_STATIC:New():FilterPrefixes("Comms Tower Russia"):FilterOnce()
|
|
|
|
local RadioTask = PLAYERTASK:New(AUFTRAG.Type.BOMBING,RussianRadios,true,5,"Bombing")
|
|
RadioTask:SetMenuName("Neutralize Comms Towers") -- UNIQUE menu name so we can find the task later!
|
|
RadioTask:AddFreetext("Find and neutralize the two communication towers near NB70 East of Fulda on Streufelsberg!")
|
|
RadioTask:AddFreetextTTS("Find and neutralize the two communication towers naer N;B;7;zero; East of Fulda on Streufelsberg!")
|
|
RadioTask:EnablePersistance() -- Enable persistence for this task
|
|
|
|
taskmanager:AddPlayerTaskToQueue(RadioTask,true,false)
|
|
</code></pre>
|
|
|
|
<h2>10 Discussion</h2>
|
|
|
|
<p>If you have questions or suggestions, please visit the <a href="https://discord.gg/AeYAkHP">MOOSE Discord</a> #ops-playertask channel. </p>
|
|
|
|
<pre><code>
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-theme-d2 w3-margin-top ">
|
|
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##_PlayerTaskNr')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>_PlayerTaskNr</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p>Global PlayerTaskNr counter</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##_PlayerTaskNr" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="_PlayerTaskNr" ><strong>_PlayerTaskNr</strong></a>
|
|
|
|
<p>Global PlayerTaskNr counter</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><strong>Type(s)</strong></h2></div>
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASK)">Type <strong>PLAYERTASK</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(PLAYERTASK)">PLAYERTASK</a></strong>
|
|
, extends <strong><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></strong>
|
|
, extends <strong><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></strong>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from PLAYERTASK</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="##(PLAYERTASK).AUUIDS">PLAYERTASK.AUUIDS</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="##(PLAYERTASK).AddClient">PLAYERTASK:AddClient(Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a client to this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddConditionFailure">PLAYERTASK:AddConditionFailure(ConditionFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add failure condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddConditionSuccess">PLAYERTASK:AddConditionSuccess(ConditionFunction, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add success condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddFreetext">PLAYERTASK:AddFreetext(Text)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Add a free text description to this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddFreetextTTS">PLAYERTASK:AddFreetextTTS(TextTTS)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Add a free text description for TTS to this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddNextTaskAfterFailure">PLAYERTASK:AddNextTaskAfterFailure(Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Add a task to be assigned to same clients when task was a failure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddNextTaskAfterSuccess">PLAYERTASK:AddNextTaskAfterSuccess(Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Add a task to be assigned to same clients when task was a success.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddOpsZoneCaptureSuccessCondition">PLAYERTASK:AddOpsZoneCaptureSuccessCondition(CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Adds task success condition for AUFTRAG.Type.CAPTUREZONE for OpsZone or OpsZone set target object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddReconSuccessCondition">PLAYERTASK:AddReconSuccessCondition(MinDistance)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Adds task success condition for AUFTRAG.Type.RECON when a client is at a certain LOS distance from the target.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddStaticObjectSuccessCondition">PLAYERTASK:AddStaticObjectSuccessCondition()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Adds task success condition for dead STATIC, SET_STATIC, SCENERY or SET_SCENERY target object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddTimeLimitFailureCondition">PLAYERTASK:AddTimeLimitFailureCondition(TimeLimit)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Adds a time limit for the task to be completed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CanJoinTask">PLAYERTASK:CanJoinTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Override this function in order to implement custom logic if a player can join a task or not.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CanSmoke">PLAYERTASK.CanSmoke</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="##(PLAYERTASK).ClassName">PLAYERTASK.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).ClientAbort">PLAYERTASK:ClientAbort(Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Client has aborted task this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Clients">PLAYERTASK.Clients</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>FiFo of Wrapper.Client#CLIENT planes executing this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CountClients">PLAYERTASK:CountClients()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Count clients</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).EnablePersistance">PLAYERTASK:EnablePersistance()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set this task for persistance, if persistance is enabled on the PLAYERTASKCONTROLLER instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).FinalState">PLAYERTASK.FinalState</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="##(PLAYERTASK).FlareColor">PLAYERTASK.FlareColor</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="##(PLAYERTASK).FlareTarget">PLAYERTASK:FlareTarget(Color)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Flare Target</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Freetext">PLAYERTASK.Freetext</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="##(PLAYERTASK).FreetextTTS">PLAYERTASK.FreetextTTS</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="##(PLAYERTASK).GetClientObjects">PLAYERTASK:GetClientObjects()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Get #CLIENT objects assigned as table</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetClients">PLAYERTASK:GetClients()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Get client names assigned as table of #strings</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetCoalition">PLAYERTASK:GetCoalition()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Get the coalition side for this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetFreetext">PLAYERTASK:GetFreetext()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Get the free text description from this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetFreetextTTS">PLAYERTASK:GetFreetextTTS()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Get the free text TTS description from this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetSubType">PLAYERTASK:GetSubType()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Get task sub type description from this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetTarget">PLAYERTASK:GetTarget()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Get the Ops.Target#TARGET object for this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).HasClients">PLAYERTASK:HasClients()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Check if PLAYERTASK has clients assigned to it.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).HasFreetext">PLAYERTASK:HasFreetext()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Query if a task has free text description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).HasFreetextTTS">PLAYERTASK:HasFreetextTTS()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Query if a task has free text TTS description.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).HasPlayerName">PLAYERTASK:HasPlayerName(Name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Check if a player name is assigned to this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).IlluminateTarget">PLAYERTASK:IlluminateTarget(Power, Height)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Illuminate Target Area</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).IsDone">PLAYERTASK:IsDone()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Check if task is done</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).IsNotDone">PLAYERTASK:IsNotDone()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Check if task is NOT done</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).MarkTargetOnF10Map">PLAYERTASK:MarkTargetOnF10Map(Text, Coalition, ReadOnly)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Create target mark on F10 map</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).New">PLAYERTASK:New(Type, Target, Repeat, Times, TTSType)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Constructor</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).NewFromTarget">PLAYERTASK:NewFromTarget(Target, Repeat, Times, TTSType)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Constructor that automatically determines the task type based on the target.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).NextTaskFailure">PLAYERTASK.NextTaskFailure</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="##(PLAYERTASK).NextTaskSuccess">PLAYERTASK.NextTaskSuccess</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="##(PLAYERTASK).OnAfterCancel">PLAYERTASK:OnAfterCancel(From, Event, To, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Cancel" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterClientAborted">PLAYERTASK:OnAfterClientAborted(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "ClientAborted" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterClientAdded">PLAYERTASK:OnAfterClientAdded(From, Event, To, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "ClientAdded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterClientRemoved">PLAYERTASK:OnAfterClientRemoved(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "ClientRemoved" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterDone">PLAYERTASK:OnAfterDone(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Done" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterExecuting">PLAYERTASK:OnAfterExecuting(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Executing" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterFailed">PLAYERTASK:OnAfterFailed(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Failed" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterPilotPlanned">PLAYERTASK:OnAfterPilotPlanned(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Planned" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterPlanned">PLAYERTASK:OnAfterPlanned(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Planned" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterRequested">PLAYERTASK:OnAfterRequested(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Requested" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnAfterSuccess">PLAYERTASK:OnAfterSuccess(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "Success" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).PersistMe">PLAYERTASK.PersistMe</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="##(PLAYERTASK).PlayerTaskNr">PLAYERTASK.PlayerTaskNr</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>(Globally unique) Number of the task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).PreviousCount">PLAYERTASK.PreviousCount</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="##(PLAYERTASK).RemoveClient">PLAYERTASK:RemoveClient(Client, Name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove a client from this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Repeat">PLAYERTASK.Repeat</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="##(PLAYERTASK).RepeatNo">PLAYERTASK.RepeatNo</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="##(PLAYERTASK).SetCanSmoke">PLAYERTASK:SetCanSmoke(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Set if a task can have a smoke marker.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetCoalition">PLAYERTASK:SetCoalition(Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set a coalition side for this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetMenuName">PLAYERTASK:SetMenuName(Text)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Add a short free text description for the menu entry of this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetShowThreatDetails">PLAYERTASK:SetShowThreatDetails(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Set if a task can show threat details.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetSubType">PLAYERTASK:SetSubType(Type)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[USER] Set a task sub type description to this task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).ShowThreatDetails">PLAYERTASK.ShowThreatDetails</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="##(PLAYERTASK).SmokeColor">PLAYERTASK.SmokeColor</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="##(PLAYERTASK).SmokeTarget">PLAYERTASK:SmokeTarget(Color)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Smoke Target</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).TTSType">PLAYERTASK.TTSType</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="##(PLAYERTASK).Target">PLAYERTASK.Target</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The target for this Task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).TargetMarker">PLAYERTASK.TargetMarker</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="##(PLAYERTASK).TaskController">PLAYERTASK.TaskController</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="##(PLAYERTASK).TaskSubType">PLAYERTASK.TaskSubType</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="##(PLAYERTASK).Type">PLAYERTASK.Type</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The type of the task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).TypeName">PLAYERTASK.TypeName</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="##(PLAYERTASK).UUIDS">PLAYERTASK.UUIDS</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="##(PLAYERTASK)._CheckCaptureOpsZoneSuccess">PLAYERTASK:_CheckCaptureOpsZoneSuccess(OpsZone, CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check OpsZone capture success condition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._EvalConditionsAny">PLAYERTASK:_EvalConditionsAny(Conditions)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check if any of the given conditions is true.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._GetTaskTypeForTarget">PLAYERTASK:_GetTaskTypeForTarget(Target)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Determines AUFTRAG type based on the target characteristics.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._SetController">PLAYERTASK:_SetController(Controller)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Add a PLAYERTASKCONTROLLER for this task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).coalition">PLAYERTASK.coalition</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="##(PLAYERTASK).conditionFailure">PLAYERTASK.conditionFailure</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="##(PLAYERTASK).conditionSuccess">PLAYERTASK.conditionSuccess</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="##(PLAYERTASK).lastsmoketime">PLAYERTASK.lastsmoketime</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="##(PLAYERTASK).lid">PLAYERTASK.lid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Class id string for output to DCS log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterCancel">PLAYERTASK:onafterCancel(From, Event, To, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after cancel call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterClientAdded">PLAYERTASK:onafterClientAdded(From, Event, To, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after client added call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterDone">PLAYERTASK:onafterDone(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after done call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterExecuting">PLAYERTASK:onafterExecuting(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after executing call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterFailed">PLAYERTASK:onafterFailed(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after failed call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterPlanned">PLAYERTASK:onafterPlanned(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after planned call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterProgress">PLAYERTASK:onafterProgress(From, Event, To, TargetCount)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after progress call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterRequested">PLAYERTASK:onafterRequested(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after requested call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterStatus">PLAYERTASK:onafterStatus(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after status call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterStop">PLAYERTASK:onafterStop(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after status call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).onafterSuccess">PLAYERTASK:onafterSuccess(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after success call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).repeats">PLAYERTASK.repeats</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="##(PLAYERTASK).timestamp">PLAYERTASK.timestamp</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="##(PLAYERTASK).verbose">PLAYERTASK.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Switch verbosity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).version">PLAYERTASK.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>PLAYERTASK class version.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from FSM</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddEndState">PLAYERTASK:AddEndState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds an End state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddProcess">PLAYERTASK:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddScore">PLAYERTASK:AddScore(State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddScoreProcess">PLAYERTASK:AddScoreProcess(From, Event, State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).AddTransition">PLAYERTASK:AddTransition(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CallScheduler">PLAYERTASK.CallScheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call scheduler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).ClassName">PLAYERTASK.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Events">PLAYERTASK.Events</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetCurrentState">PLAYERTASK:GetCurrentState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetEndStates">PLAYERTASK:GetEndStates()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the End states.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetProcess">PLAYERTASK:GetProcess(From, Event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetProcesses">PLAYERTASK:GetProcesses()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetScores">PLAYERTASK:GetScores()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the scores defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetStartState">PLAYERTASK:GetStartState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetState">PLAYERTASK:GetState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetSubs">PLAYERTASK:GetSubs()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the Subs defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetTransitions">PLAYERTASK:GetTransitions()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Is">PLAYERTASK:Is(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).LoadCallBacks">PLAYERTASK:LoadCallBacks(CallBackTable)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Load call backs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).New">PLAYERTASK:New()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creates a new FSM object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Scores">PLAYERTASK.Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Scores.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetProcess">PLAYERTASK:SetProcess(From, Event, Fsm)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetStartState">PLAYERTASK:SetStartState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sets the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._EndStates">PLAYERTASK._EndStates</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._EventSchedules">PLAYERTASK._EventSchedules</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._Processes">PLAYERTASK._Processes</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._Scores">PLAYERTASK._Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._StartState">PLAYERTASK._StartState</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._Transitions">PLAYERTASK._Transitions</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._add_to_map">PLAYERTASK:_add_to_map(Map, Event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add to map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._call_handler">PLAYERTASK:_call_handler(step, trigger, params, EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._create_transition">PLAYERTASK:_create_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._delayed_transition">PLAYERTASK:_delayed_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delayed transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._eventmap">PLAYERTASK:_eventmap(Events, EventStructure)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Event map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._gosub">PLAYERTASK:_gosub(ParentFrom, ParentEvent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Go sub.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._handler">PLAYERTASK:_handler(EventName, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._isendstate">PLAYERTASK:_isendstate(Current)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is end state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._submap">PLAYERTASK:_submap(subs, sub, name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sub maps.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).can">PLAYERTASK:can(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if can do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).cannot">PLAYERTASK:cannot(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if cannot do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).current">PLAYERTASK.current</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Current state name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).endstates">PLAYERTASK.endstates</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).is">PLAYERTASK:is(State, state)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).options">PLAYERTASK.options</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Options.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).subs">PLAYERTASK.subs</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subs.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from BASE</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).ClassID">PLAYERTASK.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="##(PLAYERTASK).ClassName">PLAYERTASK.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="##(PLAYERTASK).ClassNameAndID">PLAYERTASK.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="##(PLAYERTASK).ClearState">PLAYERTASK: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="##(PLAYERTASK).CreateEventBirth">PLAYERTASK: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="##(PLAYERTASK).CreateEventCrash">PLAYERTASK:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventDead">PLAYERTASK:CreateEventDead(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Dead Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventDynamicCargoLoaded">PLAYERTASK:CreateEventDynamicCargoLoaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventDynamicCargoRemoved">PLAYERTASK:CreateEventDynamicCargoRemoved(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventDynamicCargoUnloaded">PLAYERTASK:CreateEventDynamicCargoUnloaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventNewDynamicCargo">PLAYERTASK:CreateEventNewDynamicCargo(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventPlayerEnterAircraft">PLAYERTASK:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).CreateEventRemoveUnit">PLAYERTASK: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="##(PLAYERTASK).CreateEventTakeoff">PLAYERTASK: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="##(PLAYERTASK).CreateEventUnitLost">PLAYERTASK:CreateEventUnitLost(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).E">PLAYERTASK: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="##(PLAYERTASK).EventDispatcher">PLAYERTASK: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="##(PLAYERTASK).EventRemoveAll">PLAYERTASK: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="##(PLAYERTASK).F">PLAYERTASK: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="##(PLAYERTASK).F2">PLAYERTASK: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="##(PLAYERTASK).F3">PLAYERTASK: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="##(PLAYERTASK).GetClassID">PLAYERTASK: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="##(PLAYERTASK).GetClassName">PLAYERTASK: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="##(PLAYERTASK).GetClassNameAndID">PLAYERTASK: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="##(PLAYERTASK).GetEventPriority">PLAYERTASK:GetEventPriority()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetParent">PLAYERTASK: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="##(PLAYERTASK).GetProperties">PLAYERTASK:GetProperties()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetProperty">PLAYERTASK:GetProperty(Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get one property of an object by the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).GetState">PLAYERTASK: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="##(PLAYERTASK).HandleEvent">PLAYERTASK:HandleEvent(EventID, EventFunction)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subscribe to a DCS Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).I">PLAYERTASK: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="##(PLAYERTASK).Inherit">PLAYERTASK: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="##(PLAYERTASK).IsInstanceOf">PLAYERTASK: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="##(PLAYERTASK).IsTrace">PLAYERTASK: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="##(PLAYERTASK).New">PLAYERTASK: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="##(PLAYERTASK).OnEvent">PLAYERTASK:OnEvent(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventBDA">PLAYERTASK:OnEventBDA(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BDA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventBaseCaptured">PLAYERTASK: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="##(PLAYERTASK).OnEventBirth">PLAYERTASK: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="##(PLAYERTASK).OnEventCrash">PLAYERTASK: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="##(PLAYERTASK).OnEventDead">PLAYERTASK: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="##(PLAYERTASK).OnEventDetailedFailure">PLAYERTASK:OnEventDetailedFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventDiscardChairAfterEjection">PLAYERTASK:OnEventDiscardChairAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Discard chair after ejection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventDynamicCargoLoaded">PLAYERTASK:OnEventDynamicCargoLoaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventDynamicCargoRemoved">PLAYERTASK:OnEventDynamicCargoRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventDynamicCargoUnloaded">PLAYERTASK:OnEventDynamicCargoUnloaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventEjection">PLAYERTASK:OnEventEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventEngineShutdown">PLAYERTASK: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="##(PLAYERTASK).OnEventEngineStartup">PLAYERTASK: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="##(PLAYERTASK).OnEventHit">PLAYERTASK: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="##(PLAYERTASK).OnEventHumanFailure">PLAYERTASK: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="##(PLAYERTASK).OnEventKill">PLAYERTASK:OnEventKill(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs on the death of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventLand">PLAYERTASK:OnEventLand(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventLandingAfterEjection">PLAYERTASK:OnEventLandingAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventLandingQualityMark">PLAYERTASK:OnEventLandingQualityMark(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Landing quality mark.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventMarkAdded">PLAYERTASK:OnEventMarkAdded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a new mark was added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventMarkChange">PLAYERTASK:OnEventMarkChange(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark text was changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventMarkRemoved">PLAYERTASK:OnEventMarkRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark was removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventMissionEnd">PLAYERTASK:OnEventMissionEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventMissionStart">PLAYERTASK:OnEventMissionStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventNewDynamicCargo">PLAYERTASK:OnEventNewDynamicCargo(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventParatrooperLanding">PLAYERTASK:OnEventParatrooperLanding(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Weapon add.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventPilotDead">PLAYERTASK: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="##(PLAYERTASK).OnEventPlayerEnterAircraft">PLAYERTASK:OnEventPlayerEnterAircraft(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventPlayerEnterUnit">PLAYERTASK: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="##(PLAYERTASK).OnEventPlayerLeaveUnit">PLAYERTASK: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="##(PLAYERTASK).OnEventRefueling">PLAYERTASK: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="##(PLAYERTASK).OnEventRefuelingStop">PLAYERTASK: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="##(PLAYERTASK).OnEventScore">PLAYERTASK:OnEventScore(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventShootingEnd">PLAYERTASK: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="##(PLAYERTASK).OnEventShootingStart">PLAYERTASK: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="##(PLAYERTASK).OnEventShot">PLAYERTASK: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="##(PLAYERTASK).OnEventTakeoff">PLAYERTASK: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="##(PLAYERTASK).OnEventTriggerZone">PLAYERTASK:OnEventTriggerZone(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).OnEventUnitLost">PLAYERTASK:OnEventUnitLost(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Properties">PLAYERTASK.Properties</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).ScheduleOnce">PLAYERTASK: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="##(PLAYERTASK).ScheduleRepeat">PLAYERTASK: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="##(PLAYERTASK).ScheduleStop">PLAYERTASK:ScheduleStop(SchedulerID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Stops the Schedule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).Scheduler">PLAYERTASK.Scheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The scheduler object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetEventPriority">PLAYERTASK:SetEventPriority(EventPriority)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetProperty">PLAYERTASK:SetProperty(Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set one property of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).SetState">PLAYERTASK: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="##(PLAYERTASK).T">PLAYERTASK: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="##(PLAYERTASK).T2">PLAYERTASK: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="##(PLAYERTASK).T3">PLAYERTASK: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="##(PLAYERTASK).TraceAll">PLAYERTASK: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="##(PLAYERTASK).TraceClass">PLAYERTASK: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="##(PLAYERTASK).TraceClassMethod">PLAYERTASK: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="##(PLAYERTASK).TraceLevel">PLAYERTASK: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="##(PLAYERTASK).TraceOff">PLAYERTASK:TraceOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).TraceOn">PLAYERTASK:TraceOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK).TraceOnOff">PLAYERTASK: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="##(PLAYERTASK).UnHandleEvent">PLAYERTASK:UnHandleEvent(EventID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._">PLAYERTASK._</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="##(PLAYERTASK)._F">PLAYERTASK:_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="##(PLAYERTASK)._Serialize">PLAYERTASK:_Serialize(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>(Internal) Serialize arguments</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK)._T">PLAYERTASK:_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="##(PLAYERTASK).__">PLAYERTASK.__</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="##(PLAYERTASK).onEvent">PLAYERTASK:onEvent(event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The main event handling function...</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASK.Condition)">Type <strong>PLAYERTASK.Condition</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(PLAYERTASK.Condition)">PLAYERTASK.Condition</a></strong>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from PLAYERTASK.Condition</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK.Condition).arg">PLAYERTASK.Condition.arg</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Optional arguments passed to the condition callback function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASK.Condition).func">PLAYERTASK.Condition.func</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Callback function to check for a condition. Should return a #boolean.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASKCONTROLLER)">Type <strong>PLAYERTASKCONTROLLER</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(PLAYERTASKCONTROLLER)">PLAYERTASKCONTROLLER</a></strong>
|
|
, extends <strong><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></strong>
|
|
, extends <strong><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></strong>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER).AccessKey">PLAYERTASKCONTROLLER.AccessKey</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="##(PLAYERTASKCONTROLLER).ActiveClientSet">PLAYERTASKCONTROLLER.ActiveClientSet</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="##(PLAYERTASKCONTROLLER).ActiveInfoMenu">PLAYERTASKCONTROLLER.ActiveInfoMenu</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="##(PLAYERTASKCONTROLLER).ActiveTaskMenuTemplate">PLAYERTASKCONTROLLER.ActiveTaskMenuTemplate</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="##(PLAYERTASKCONTROLLER).ActiveTopMenu">PLAYERTASKCONTROLLER.ActiveTopMenu</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="##(PLAYERTASKCONTROLLER).AddAcceptZone">PLAYERTASKCONTROLLER:AddAcceptZone(AcceptZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add an accept zone to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddAcceptZoneSet">PLAYERTASKCONTROLLER:AddAcceptZoneSet(AcceptZoneSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add an accept SET_ZONE to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddAgent">PLAYERTASKCONTROLLER:AddAgent(Recce)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add agent group to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddAgentSet">PLAYERTASKCONTROLLER:AddAgentSet(RecceSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add agent SET_GROUP to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddConflictZone">PLAYERTASKCONTROLLER:AddConflictZone(ConflictZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a conflict zone to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddConflictZoneSet">PLAYERTASKCONTROLLER:AddConflictZoneSet(ConflictZoneSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a conflict SET_ZONE to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddCorridorZone">PLAYERTASKCONTROLLER:AddCorridorZone(CorridorZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add an corridor zone to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddCorridorZoneSet">PLAYERTASKCONTROLLER:AddCorridorZoneSet(CorridorZoneSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add an corridor SET_ZONE to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddPlayerTaskToQueue">PLAYERTASKCONTROLLER:AddPlayerTaskToQueue(PlayerTask, Silent, TaskFilter)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a PLAYERTASK object to the list of (open) tasks</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddPrecisionBombingOpsGroup">PLAYERTASKCONTROLLER:AddPrecisionBombingOpsGroup(FlightGroup, LaserCode, HoldingPoint, Alt, Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Convenience function - add done or ground allowing precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddRejectZone">PLAYERTASKCONTROLLER:AddRejectZone(RejectZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a reject zone to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddRejectZoneSet">PLAYERTASKCONTROLLER:AddRejectZoneSet(RejectZoneSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a reject SET_ZONE to INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddTarget">PLAYERTASKCONTROLLER:AddTarget(Target)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Add a target object to the target queue</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AllowFlash">PLAYERTASKCONTROLLER.AllowFlash</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Flashing directions for players allowed</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).BCFrequency">PLAYERTASKCONTROLLER.BCFrequency</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="##(PLAYERTASKCONTROLLER).BCModulation">PLAYERTASKCONTROLLER.BCModulation</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="##(PLAYERTASKCONTROLLER).BlackList">PLAYERTASKCONTROLLER.BlackList</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="##(PLAYERTASKCONTROLLER).CallsignCustomArgs">PLAYERTASKCONTROLLER.CallsignCustomArgs</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="##(PLAYERTASKCONTROLLER).CallsignCustomFunc">PLAYERTASKCONTROLLER.CallsignCustomFunc</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="##(PLAYERTASKCONTROLLER).CallsignTranslations">PLAYERTASKCONTROLLER.CallsignTranslations</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="##(PLAYERTASKCONTROLLER).CanJoinTask">PLAYERTASKCONTROLLER:CanJoinTask(Task, Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Override this function in order to implement custom logic if a player can join a task or not.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CancelTask">PLAYERTASKCONTROLLER:CancelTask(Task, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Manually cancel a specific task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ClassName">PLAYERTASKCONTROLLER.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ClearPersistedData">PLAYERTASKCONTROLLER:ClearPersistedData()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Clear persisted data on disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ClientFilter">PLAYERTASKCONTROLLER.ClientFilter</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="##(PLAYERTASKCONTROLLER).ClientSet">PLAYERTASKCONTROLLER.ClientSet</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="##(PLAYERTASKCONTROLLER).ClusterRadius">PLAYERTASKCONTROLLER.ClusterRadius</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="##(PLAYERTASKCONTROLLER).Coalition">PLAYERTASKCONTROLLER.Coalition</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="##(PLAYERTASKCONTROLLER).CoalitionName">PLAYERTASKCONTROLLER.CoalitionName</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="##(PLAYERTASKCONTROLLER).Culture">PLAYERTASKCONTROLLER.Culture</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="##(PLAYERTASKCONTROLLER).DisableBuddyLasing">PLAYERTASKCONTROLLER:DisableBuddyLasing()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc) with player units lasing.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).DisablePrecisionBombing">PLAYERTASKCONTROLLER:DisablePrecisionBombing(FlightGroup, LaserCode)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Disable precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).DisableScoring">PLAYERTASKCONTROLLER:DisableScoring()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove the SCORING object from this taskcontroller</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).DisableTaskInfoMenu">PLAYERTASKCONTROLLER:DisableTaskInfoMenu()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Disable extra menu to show task detail information before joining</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).DisableTaskPersistance">PLAYERTASKCONTROLLER:DisableTaskPersistance()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Disable Task persistance (for specific gound target tasks)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnableBuddyLasing">PLAYERTASKCONTROLLER:EnableBuddyLasing(Recce)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc) with player units lasing.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnableMarkerOps">PLAYERTASKCONTROLLER:EnableMarkerOps(Tag)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Allow addition of targets with user F10 map markers.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnablePrecisionBombing">PLAYERTASKCONTROLLER:EnablePrecisionBombing(FlightGroup, LaserCode, HoldingPoint, Alt, Speed, MaxTravelDist)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnableScoring">PLAYERTASKCONTROLLER:EnableScoring(Scoring)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set or create a SCORING object for this taskcontroller</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnableTaskInfoMenu">PLAYERTASKCONTROLLER:EnableTaskInfoMenu()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Enable extra menu to show task detail information before joining</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).EnableTaskPersistance">PLAYERTASKCONTROLLER:EnableTaskPersistance(Path, Filename, KgsOfTNT)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Enable Task persistance (for specific gound target tasks)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).FlashPlayer">PLAYERTASKCONTROLLER.FlashPlayer</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>List of player who switched Flashing Direction Info on</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Frequency">PLAYERTASKCONTROLLER.Frequency</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Gender">PLAYERTASKCONTROLLER.Gender</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="##(PLAYERTASKCONTROLLER).InfoHasCoordinate">PLAYERTASKCONTROLLER.InfoHasCoordinate</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="##(PLAYERTASKCONTROLLER).InfoHasLLDDM">PLAYERTASKCONTROLLER.InfoHasLLDDM</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="##(PLAYERTASKCONTROLLER).InformationMenu">PLAYERTASKCONTROLLER.InformationMenu</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Show Radio Info Menu</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Intel">PLAYERTASKCONTROLLER.Intel</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="##(PLAYERTASKCONTROLLER).IsClientSet">PLAYERTASKCONTROLLER.IsClientSet</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="##(PLAYERTASKCONTROLLER).JoinInfoMenu">PLAYERTASKCONTROLLER.JoinInfoMenu</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="##(PLAYERTASKCONTROLLER).JoinMenu">PLAYERTASKCONTROLLER.JoinMenu</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="##(PLAYERTASKCONTROLLER).JoinTaskMenuTemplate">PLAYERTASKCONTROLLER.JoinTaskMenuTemplate</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="##(PLAYERTASKCONTROLLER).JoinTopMenu">PLAYERTASKCONTROLLER.JoinTopMenu</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="##(PLAYERTASKCONTROLLER).Keepnumber">PLAYERTASKCONTROLLER.Keepnumber</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="##(PLAYERTASKCONTROLLER).LasingDrone">PLAYERTASKCONTROLLER.LasingDrone</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="##(PLAYERTASKCONTROLLER).LasingDroneSet">PLAYERTASKCONTROLLER.LasingDroneSet</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="##(PLAYERTASKCONTROLLER).MarkerOps">PLAYERTASKCONTROLLER.MarkerOps</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="##(PLAYERTASKCONTROLLER).MarkerReadOnly">PLAYERTASKCONTROLLER.MarkerReadOnly</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="##(PLAYERTASKCONTROLLER).MenuName">PLAYERTASKCONTROLLER.MenuName</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="##(PLAYERTASKCONTROLLER).MenuNoTask">PLAYERTASKCONTROLLER.MenuNoTask</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="##(PLAYERTASKCONTROLLER).MenuParent">PLAYERTASKCONTROLLER.MenuParent</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="##(PLAYERTASKCONTROLLER).Messages">PLAYERTASKCONTROLLER.Messages</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="##(PLAYERTASKCONTROLLER).Modulation">PLAYERTASKCONTROLLER.Modulation</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="##(PLAYERTASKCONTROLLER).Name">PLAYERTASKCONTROLLER.Name</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="##(PLAYERTASKCONTROLLER).New">PLAYERTASKCONTROLLER:New(Name, Coalition, Type, ClientFilter)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create and run a new TASKCONTROLLER instance.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).NoScreenOutput">PLAYERTASKCONTROLLER.NoScreenOutput</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="##(PLAYERTASKCONTROLLER).OnAfterPlayerAbortedTask">PLAYERTASKCONTROLLER:OnAfterPlayerAbortedTask(From, Event, To, Group, Client, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "PlayerAbortedTask" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterPlayerJoinedTask">PLAYERTASKCONTROLLER:OnAfterPlayerJoinedTask(From, Event, To, Group, Client, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "PlayerJoinedTask" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskAdded">PLAYERTASKCONTROLLER:OnAfterTaskAdded(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskAdded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskCancelled">PLAYERTASKCONTROLLER:OnAfterTaskCancelled(From, Event, To, Task, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskCancelled" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskDone">PLAYERTASKCONTROLLER:OnAfterTaskDone(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskDone" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskFailed">PLAYERTASKCONTROLLER:OnAfterTaskFailed(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskFailed" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskProgress">PLAYERTASKCONTROLLER:OnAfterTaskProgress(From, Event, To, Task, TargetCount)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskProgress" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskRepeatOnFailed">PLAYERTASKCONTROLLER:OnAfterTaskRepeatOnFailed(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskRepeatOnFailed" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskSuccess">PLAYERTASKCONTROLLER:OnAfterTaskSuccess(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskSuccess" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskTargetFlared">PLAYERTASKCONTROLLER:OnAfterTaskTargetFlared(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskTargetFlared" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskTargetIlluminated">PLAYERTASKCONTROLLER:OnAfterTaskTargetIlluminated(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskTargetIlluminated" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnAfterTaskTargetSmoked">PLAYERTASKCONTROLLER:OnAfterTaskTargetSmoked(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On After "TaskTargetSmoked" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).PathToGoogleKey">PLAYERTASKCONTROLLER.PathToGoogleKey</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="##(PLAYERTASKCONTROLLER).PathToSRS">PLAYERTASKCONTROLLER.PathToSRS</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="##(PLAYERTASKCONTROLLER).PlayerFlashMenu">PLAYERTASKCONTROLLER.PlayerFlashMenu</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="##(PLAYERTASKCONTROLLER).PlayerInfoMenu">PLAYERTASKCONTROLLER.PlayerInfoMenu</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="##(PLAYERTASKCONTROLLER).PlayerJoinMenu">PLAYERTASKCONTROLLER.PlayerJoinMenu</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="##(PLAYERTASKCONTROLLER).PlayerMenu">PLAYERTASKCONTROLLER.PlayerMenu</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="##(PLAYERTASKCONTROLLER).PlayerMenuTag">PLAYERTASKCONTROLLER.PlayerMenuTag</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="##(PLAYERTASKCONTROLLER).PlayerRecce">PLAYERTASKCONTROLLER.PlayerRecce</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="##(PLAYERTASKCONTROLLER).Port">PLAYERTASKCONTROLLER.Port</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="##(PLAYERTASKCONTROLLER).PrecisionTasks">PLAYERTASKCONTROLLER.PrecisionTasks</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="##(PLAYERTASKCONTROLLER).RecceSet">PLAYERTASKCONTROLLER.RecceSet</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="##(PLAYERTASKCONTROLLER).RemoveAcceptZone">PLAYERTASKCONTROLLER:RemoveAcceptZone(AcceptZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove an accept zone from INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).RemoveConflictZone">PLAYERTASKCONTROLLER:RemoveConflictZone(ConflictZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove a conflict zone from INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).RemoveCorridorZone">PLAYERTASKCONTROLLER:RemoveCorridorZone(CorridorZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove an corridor zone from INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).RemoveRejectZone">PLAYERTASKCONTROLLER:RemoveRejectZone(RejectZone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Remove a reject zone from INTEL detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SRS">PLAYERTASKCONTROLLER.SRS</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="##(PLAYERTASKCONTROLLER).SRSQueue">PLAYERTASKCONTROLLER.SRSQueue</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="##(PLAYERTASKCONTROLLER).SceneryExplosivesAmount">PLAYERTASKCONTROLLER.SceneryExplosivesAmount</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Kgs of TNT to explode scenery on task persistance loading</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Scores">PLAYERTASKCONTROLLER.Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Scoring">PLAYERTASKCONTROLLER.Scoring</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="##(PLAYERTASKCONTROLLER).SeadAttributes">PLAYERTASKCONTROLLER.SeadAttributes</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="##(PLAYERTASKCONTROLLER).SetAllowFlashDirection">PLAYERTASKCONTROLLER:SetAllowFlashDirection(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set flash directions option for player (player based info)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetBriefingDuration">PLAYERTASKCONTROLLER:SetBriefingDuration(Seconds)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set how long the briefing is shown on screen.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetCallSignOptions">PLAYERTASKCONTROLLER:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations, CallsignCustomFunc, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set callsign options for TTS output.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetClusterRadius">PLAYERTASKCONTROLLER:SetClusterRadius(Radius)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set the cluster radius if you want to use target clusters rather than single group detection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetCorridorZoneFloorAndCeiling">PLAYERTASKCONTROLLER:SetCorridorZoneFloorAndCeiling(Floor, Ceiling)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function to set corridor zone floor and ceiling in FEET.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetCorridorZoneFloorAndCeilingMeters">PLAYERTASKCONTROLLER:SetCorridorZoneFloorAndCeilingMeters(Floor, Ceiling)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function to set corridor zone floor and ceiling in METERS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetDisableIlluminateTask">PLAYERTASKCONTROLLER:SetDisableIlluminateTask()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Do not show menu entries to illuminate targets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetDisableSmokeFlareTask">PLAYERTASKCONTROLLER:SetDisableSmokeFlareTask()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Do not show menu entries to smoke or flare targets</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetDisableUseTypeNames">PLAYERTASKCONTROLLER:SetDisableUseTypeNames()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Do not show target menu entries of type names for GROUND targets</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetEnableIlluminateTask">PLAYERTASKCONTROLLER:SetEnableIlluminateTask()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Show menu entries to illuminate targets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetEnableSmokeFlareTask">PLAYERTASKCONTROLLER:SetEnableSmokeFlareTask()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Show menu entries to smoke or flare targets (on by default!)</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetEnableUseTypeNames">PLAYERTASKCONTROLLER:SetEnableUseTypeNames()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Show target menu entries of type names for GROUND targets (off by default!), e.g.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetInfoShowsCoordinate">PLAYERTASKCONTROLLER:SetInfoShowsCoordinate(OnOff, LLDDM)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Show info text on screen with a coordinate info in any case (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="##(PLAYERTASKCONTROLLER).SetLocale">PLAYERTASKCONTROLLER:SetLocale(Locale)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set locale for localization.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetMarkerDeleteable">PLAYERTASKCONTROLLER:SetMarkerDeleteable()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Allow F10 markers to be deleted by pilots.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetMarkerReadOnly">PLAYERTASKCONTROLLER:SetMarkerReadOnly()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Forbid F10 markers to be deleted by pilots.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetMenuName">PLAYERTASKCONTROLLER:SetMenuName(Name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set the top menu name to a custom string.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetMenuOptions">PLAYERTASKCONTROLLER:SetMenuOptions(InfoMenu, ItemLimit, HoldTime)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set menu build fine-tuning options</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetParentMenu">PLAYERTASKCONTROLLER:SetParentMenu(Menu)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set the top menu to be a sub-menu of another MENU entry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetSEADAttributes">PLAYERTASKCONTROLLER:SetSEADAttributes(Attributes)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Change the list of attributes, which are considered on GROUP or SET_GROUP level of a target to create SEAD player tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetSRS">PLAYERTASKCONTROLLER:SetSRS(Frequency, Modulation, PathToSRS, Gender, Culture, Port, Voice, Volume, PathToGoogleKey, AccessKey, Coordinate, Backend)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set SRS TTS details - see <a href="Sound.SRS.html">Sound.SRS</a> for details.<code>SetSRS()</code> will try to use as many attributes configured with <a href="Sound.SRS.html##(MSRS).LoadConfigFile">Sound.SRS#MSRS.LoadConfigFile</a>() as possible.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetSRSBroadcast">PLAYERTASKCONTROLLER:SetSRSBroadcast(Frequency, Modulation)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set SRS Broadcast - for the announcement to joining players which SRS frequency, modulation to use.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetShowRadioInfoMenu">PLAYERTASKCONTROLLER:SetShowRadioInfoMenu(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set to show a menu entry to retrieve the radio frequencies used.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetTargetRadius">PLAYERTASKCONTROLLER:SetTargetRadius(Radius)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set target radius.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetTaskBlackList">PLAYERTASKCONTROLLER:SetTaskBlackList(BlackList)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set up a (negative) blacklist of forbidden task types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetTaskRepetition">PLAYERTASKCONTROLLER:SetTaskRepetition(OnOff, Repeats)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set repetition options for tasks.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetTaskWhiteList">PLAYERTASKCONTROLLER:SetTaskWhiteList(WhiteList)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set up a (positive) whitelist of allowed task types.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetTransmitOnlyWithPlayers">PLAYERTASKCONTROLLER:SetTransmitOnlyWithPlayers(Switch)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] For SRS - Switch to only transmit if there are players on the server.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER:SetupIntel(RecceName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set up INTEL detection</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ShortCallsign">PLAYERTASKCONTROLLER.ShortCallsign</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="##(PLAYERTASKCONTROLLER).ShowMagnetic">PLAYERTASKCONTROLLER.ShowMagnetic</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Also show magnetic angles</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SuppressScreenOutput">PLAYERTASKCONTROLLER:SuppressScreenOutput(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Switch screen output.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SwitchDetectStatics">PLAYERTASKCONTROLLER:SwitchDetectStatics(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Set up detection of STATIC objects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SwitchMagenticAngles">PLAYERTASKCONTROLLER:SwitchMagenticAngles(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Switch showing additional magnetic angles</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SwitchUseGroupNames">PLAYERTASKCONTROLLER:SwitchUseGroupNames(OnOff)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[User] Switch usage of target names for menu entries on or off</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TargetQueue">PLAYERTASKCONTROLLER.TargetQueue</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="##(PLAYERTASKCONTROLLER).TargetRadius">PLAYERTASKCONTROLLER.TargetRadius</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="##(PLAYERTASKCONTROLLER).TaskInfoDuration">PLAYERTASKCONTROLLER.TaskInfoDuration</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>How long to show the briefing info on the screen</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TaskPersistance">PLAYERTASKCONTROLLER.TaskPersistance</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table for persistance data</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TaskPersistanceFilename">PLAYERTASKCONTROLLER.TaskPersistanceFilename</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>File name for persisting tasks</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TaskPersistancePath">PLAYERTASKCONTROLLER.TaskPersistancePath</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>File path for persisting tasks</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TaskPersistanceSwitch">PLAYERTASKCONTROLLER.TaskPersistanceSwitch</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Switch for persisting tasks</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TaskQueue">PLAYERTASKCONTROLLER.TaskQueue</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="##(PLAYERTASKCONTROLLER).TasksPerPlayer">PLAYERTASKCONTROLLER.TasksPerPlayer</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="##(PLAYERTASKCONTROLLER).TasksPersistable">PLAYERTASKCONTROLLER.TasksPersistable</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>List of persistable tasks</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TransmitOnlyWithPlayers">PLAYERTASKCONTROLLER.TransmitOnlyWithPlayers</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="##(PLAYERTASKCONTROLLER).Type">PLAYERTASKCONTROLLER.Type</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).UseBlackList">PLAYERTASKCONTROLLER.UseBlackList</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="##(PLAYERTASKCONTROLLER).UseGroupNames">PLAYERTASKCONTROLLER.UseGroupNames</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="##(PLAYERTASKCONTROLLER).UseSRS">PLAYERTASKCONTROLLER.UseSRS</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="##(PLAYERTASKCONTROLLER).UseTypeNames">PLAYERTASKCONTROLLER.UseTypeNames</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="##(PLAYERTASKCONTROLLER).UseWhiteList">PLAYERTASKCONTROLLER.UseWhiteList</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="##(PLAYERTASKCONTROLLER).Voice">PLAYERTASKCONTROLLER.Voice</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="##(PLAYERTASKCONTROLLER).Volume">PLAYERTASKCONTROLLER.Volume</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="##(PLAYERTASKCONTROLLER).WhiteList">PLAYERTASKCONTROLLER.WhiteList</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="##(PLAYERTASKCONTROLLER)._AbortTask">PLAYERTASKCONTROLLER:_AbortTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Abort Task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._ActiveTaskInfo">PLAYERTASKCONTROLLER:_ActiveTaskInfo(Task, Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Show active task info</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._AddPersistenceData">PLAYERTASKCONTROLLER:_AddPersistenceData(Task)</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="##(PLAYERTASKCONTROLLER)._AddTask">PLAYERTASKCONTROLLER:_AddTask(Target)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Add a task to the task queue</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CalcGroupFuturePosition">PLAYERTASKCONTROLLER:_CalcGroupFuturePosition(group, seconds)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Calculate group future position after given seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckPlayerHasTask">PLAYERTASKCONTROLLER:_CheckPlayerHasTask(PlayerName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check task queue for a specific player name</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckPrecisionTasks">PLAYERTASKCONTROLLER:_CheckPrecisionTasks()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check precision task queue</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckTargetQueue">PLAYERTASKCONTROLLER:_CheckTargetQueue()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check target queue</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckTaskQueue">PLAYERTASKCONTROLLER:_CheckTaskQueue()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check task queue</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckTaskTypeAllowed">PLAYERTASKCONTROLLER:_CheckTaskTypeAllowed(Type)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check for allowed task type, if there is a (positive) whitelist</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CheckTaskTypeDisallowed">PLAYERTASKCONTROLLER:_CheckTaskTypeDisallowed(Type)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Check for allowed task type, if there is a (negative) blacklist</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CreateActiveTaskMenuTemplate">PLAYERTASKCONTROLLER:_CreateActiveTaskMenuTemplate()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] _CreateActiveTaskMenuTemplate</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._CreateJoinMenuTemplate">PLAYERTASKCONTROLLER:_CreateJoinMenuTemplate()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] _CreateJoinMenuTemplate</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._EventHandler">PLAYERTASKCONTROLLER:_EventHandler(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Event handling</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._FindLasingDroneForTaskID">PLAYERTASKCONTROLLER:_FindLasingDroneForTaskID(ID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Find matching drone for precision bombing task, if any is assigned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._FlareTask">PLAYERTASKCONTROLLER:_FlareTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Flare task location</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._FlashInfo">PLAYERTASKCONTROLLER:_FlashInfo()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Flashing directional info for a client</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._GetAvailableTaskTypes">PLAYERTASKCONTROLLER:_GetAvailableTaskTypes()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Get task types for the menu</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._GetPlayerName">PLAYERTASKCONTROLLER:_GetPlayerName(Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Get player name</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._GetTasksPerType">PLAYERTASKCONTROLLER:_GetTasksPerType()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Get task per type for the menu</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._GetTextForSpeech">PLAYERTASKCONTROLLER:_GetTextForSpeech(text)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Get text for text-to-speech.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._IlluminateTask">PLAYERTASKCONTROLLER:_IlluminateTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Illuminate task location</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._InitLocalization">PLAYERTASKCONTROLLER:_InitLocalization()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Init localization</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._IsAttributeSead">PLAYERTASKCONTROLLER:_IsAttributeSead(Attribute)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Function the check against SeadAttributes</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._JoinTask">PLAYERTASKCONTROLLER:_JoinTask(Task, Force, Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Join a player to a task</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._LoadTasksPersisted">PLAYERTASKCONTROLLER:_LoadTasksPersisted()</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="##(PLAYERTASKCONTROLLER)._MarkTask">PLAYERTASKCONTROLLER:_MarkTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Mark task on F10 map</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._RemoveMenuEntriesForTask">PLAYERTASKCONTROLLER:_RemoveMenuEntriesForTask(Task, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] _RemoveMenuEntriesForTask</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._SaveTasksPersisted">PLAYERTASKCONTROLLER:_SaveTasksPersisted()</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="##(PLAYERTASKCONTROLLER)._SendMessageToClients">PLAYERTASKCONTROLLER:_SendMessageToClients(Text, Seconds)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Send message to SET_CLIENT of players</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._ShowRadioInfo">PLAYERTASKCONTROLLER:_ShowRadioInfo(Group, 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="##(PLAYERTASKCONTROLLER)._SmokeTask">PLAYERTASKCONTROLLER:_SmokeTask(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Smoke task location</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._SwitchFlashing">PLAYERTASKCONTROLLER:_SwitchFlashing(Group, Client)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] Switch flashing info for a client</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._SwitchMenuForClient">PLAYERTASKCONTROLLER:_SwitchMenuForClient(Client, MenuType, Delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] _SwitchMenuForClient</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._UpdateJoinMenuTemplate">PLAYERTASKCONTROLLER:_UpdateJoinMenuTemplate()</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="##(PLAYERTASKCONTROLLER)._UpdateTargetsAlive">PLAYERTASKCONTROLLER:_UpdateTargetsAlive(Task, TargetsLeft)</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="##(PLAYERTASKCONTROLLER).activehasinfomenu">PLAYERTASKCONTROLLER.activehasinfomenu</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="##(PLAYERTASKCONTROLLER).autolase">PLAYERTASKCONTROLLER.autolase</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="##(PLAYERTASKCONTROLLER).buddylasing">PLAYERTASKCONTROLLER.buddylasing</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="##(PLAYERTASKCONTROLLER).customcallsigns">PLAYERTASKCONTROLLER.customcallsigns</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="##(PLAYERTASKCONTROLLER).gettext">PLAYERTASKCONTROLLER.gettext</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="##(PLAYERTASKCONTROLLER).holdmenutime">PLAYERTASKCONTROLLER.holdmenutime</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="##(PLAYERTASKCONTROLLER).illumenu">PLAYERTASKCONTROLLER.illumenu</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="##(PLAYERTASKCONTROLLER).lasttaskcount">PLAYERTASKCONTROLLER.lasttaskcount</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="##(PLAYERTASKCONTROLLER).lid">PLAYERTASKCONTROLLER.lid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Class id string for output to DCS log file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).locale">PLAYERTASKCONTROLLER.locale</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="##(PLAYERTASKCONTROLLER).menuitemlimit">PLAYERTASKCONTROLLER.menuitemlimit</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="##(PLAYERTASKCONTROLLER).noflaresmokemenu">PLAYERTASKCONTROLLER.noflaresmokemenu</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="##(PLAYERTASKCONTROLLER).onafterStart">PLAYERTASKCONTROLLER:onafterStart(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after start call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterStatus">PLAYERTASKCONTROLLER:onafterStatus(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after Status call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterStop">PLAYERTASKCONTROLLER:onafterStop(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after Stop call</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskAdded">PLAYERTASKCONTROLLER:onafterTaskAdded(From, Event, To, Task, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task added</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskCancelled">PLAYERTASKCONTROLLER:onafterTaskCancelled(From, Event, To, Task, Silent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task cancelled</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskDone">PLAYERTASKCONTROLLER:onafterTaskDone(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task done</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskFailed">PLAYERTASKCONTROLLER:onafterTaskFailed(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task failed</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskRepeatOnFailed">PLAYERTASKCONTROLLER:onafterTaskRepeatOnFailed(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task failed, repeat planned</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).onafterTaskSuccess">PLAYERTASKCONTROLLER:onafterTaskSuccess(From, Event, To, Task)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>[Internal] On after task success</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).precisionbombing">PLAYERTASKCONTROLLER.precisionbombing</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="##(PLAYERTASKCONTROLLER).repeatonfailed">PLAYERTASKCONTROLLER.repeatonfailed</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="##(PLAYERTASKCONTROLLER).repeattimes">PLAYERTASKCONTROLLER.repeattimes</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="##(PLAYERTASKCONTROLLER).taskinfomenu">PLAYERTASKCONTROLLER.taskinfomenu</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="##(PLAYERTASKCONTROLLER).usecluster">PLAYERTASKCONTROLLER.usecluster</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="##(PLAYERTASKCONTROLLER).verbose">PLAYERTASKCONTROLLER.verbose</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Switch verbosity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).version">PLAYERTASKCONTROLLER.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>PLAYERTASK class version.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from FSM</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddEndState">PLAYERTASKCONTROLLER:AddEndState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds an End state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddProcess">PLAYERTASKCONTROLLER:AddProcess(From, Event, Process, ReturnEvents)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddScore">PLAYERTASKCONTROLLER:AddScore(State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddScoreProcess">PLAYERTASKCONTROLLER:AddScoreProcess(From, Event, State, ScoreText, Score)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).AddTransition">PLAYERTASKCONTROLLER:AddTransition(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CallScheduler">PLAYERTASKCONTROLLER.CallScheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call scheduler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ClassName">PLAYERTASKCONTROLLER.ClassName</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the class.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Events">PLAYERTASKCONTROLLER.Events</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetCurrentState">PLAYERTASKCONTROLLER:GetCurrentState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetEndStates">PLAYERTASKCONTROLLER:GetEndStates()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the End states.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetProcess">PLAYERTASKCONTROLLER:GetProcess(From, Event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetProcesses">PLAYERTASKCONTROLLER:GetProcesses()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetScores">PLAYERTASKCONTROLLER:GetScores()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the scores defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetStartState">PLAYERTASKCONTROLLER:GetStartState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetState">PLAYERTASKCONTROLLER:GetState()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get current state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetSubs">PLAYERTASKCONTROLLER:GetSubs()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table with the Subs defined.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetTransitions">PLAYERTASKCONTROLLER:GetTransitions()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Is">PLAYERTASKCONTROLLER:Is(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).LoadCallBacks">PLAYERTASKCONTROLLER:LoadCallBacks(CallBackTable)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Load call backs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).New">PLAYERTASKCONTROLLER:New()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creates a new FSM object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Scores">PLAYERTASKCONTROLLER.Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Scores.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetProcess">PLAYERTASKCONTROLLER:SetProcess(From, Event, Fsm)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetStartState">PLAYERTASKCONTROLLER:SetStartState(State)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sets the start state of the FSM.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._EndStates">PLAYERTASKCONTROLLER._EndStates</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._EventSchedules">PLAYERTASKCONTROLLER._EventSchedules</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._Processes">PLAYERTASKCONTROLLER._Processes</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._Scores">PLAYERTASKCONTROLLER._Scores</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._StartState">PLAYERTASKCONTROLLER._StartState</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._Transitions">PLAYERTASKCONTROLLER._Transitions</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._add_to_map">PLAYERTASKCONTROLLER:_add_to_map(Map, Event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add to map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._call_handler">PLAYERTASKCONTROLLER:_call_handler(step, trigger, params, EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Call handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._create_transition">PLAYERTASKCONTROLLER:_create_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._delayed_transition">PLAYERTASKCONTROLLER:_delayed_transition(EventName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delayed transition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._eventmap">PLAYERTASKCONTROLLER:_eventmap(Events, EventStructure)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Event map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._gosub">PLAYERTASKCONTROLLER:_gosub(ParentFrom, ParentEvent)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Go sub.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._handler">PLAYERTASKCONTROLLER:_handler(EventName, ...)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Handler.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._isendstate">PLAYERTASKCONTROLLER:_isendstate(Current)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is end state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._submap">PLAYERTASKCONTROLLER:_submap(subs, sub, name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sub maps.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).can">PLAYERTASKCONTROLLER:can(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if can do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).cannot">PLAYERTASKCONTROLLER:cannot(e)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if cannot do an event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).current">PLAYERTASKCONTROLLER.current</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Current state name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).endstates">PLAYERTASKCONTROLLER.endstates</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).is">PLAYERTASKCONTROLLER:is(State, state)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if FSM is in state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).options">PLAYERTASKCONTROLLER.options</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Options.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).subs">PLAYERTASKCONTROLLER.subs</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subs.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from BASE</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ClassID">PLAYERTASKCONTROLLER.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="##(PLAYERTASKCONTROLLER).ClassName">PLAYERTASKCONTROLLER.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="##(PLAYERTASKCONTROLLER).ClassNameAndID">PLAYERTASKCONTROLLER.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="##(PLAYERTASKCONTROLLER).ClearState">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).CreateEventBirth">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).CreateEventCrash">PLAYERTASKCONTROLLER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventDead">PLAYERTASKCONTROLLER:CreateEventDead(EventTime, Initiator, IniObjectCategory)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Dead Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventDynamicCargoLoaded">PLAYERTASKCONTROLLER:CreateEventDynamicCargoLoaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventDynamicCargoRemoved">PLAYERTASKCONTROLLER:CreateEventDynamicCargoRemoved(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventDynamicCargoUnloaded">PLAYERTASKCONTROLLER:CreateEventDynamicCargoUnloaded(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventNewDynamicCargo">PLAYERTASKCONTROLLER:CreateEventNewDynamicCargo(DynamicCargo)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventPlayerEnterAircraft">PLAYERTASKCONTROLLER:CreateEventPlayerEnterAircraft(PlayerUnit)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).CreateEventRemoveUnit">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).CreateEventTakeoff">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).CreateEventUnitLost">PLAYERTASKCONTROLLER:CreateEventUnitLost(EventTime, Initiator)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Creation of a Crash Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).E">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).EventDispatcher">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).EventRemoveAll">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).F">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).F2">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).F3">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).GetClassID">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).GetClassName">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).GetClassNameAndID">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).GetEventPriority">PLAYERTASKCONTROLLER:GetEventPriority()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetParent">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).GetProperties">PLAYERTASKCONTROLLER:GetProperties()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetProperty">PLAYERTASKCONTROLLER:GetProperty(Key)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get one property of an object by the key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).GetState">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).HandleEvent">PLAYERTASKCONTROLLER:HandleEvent(EventID, EventFunction)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Subscribe to a DCS Event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).I">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).Inherit">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).IsInstanceOf">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).IsTrace">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).New">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEvent">PLAYERTASKCONTROLLER:OnEvent(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventBDA">PLAYERTASKCONTROLLER:OnEventBDA(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>BDA.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventBaseCaptured">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventBirth">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventCrash">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventDead">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventDetailedFailure">PLAYERTASKCONTROLLER:OnEventDetailedFailure(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventDiscardChairAfterEjection">PLAYERTASKCONTROLLER:OnEventDiscardChairAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Discard chair after ejection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventDynamicCargoLoaded">PLAYERTASKCONTROLLER:OnEventDynamicCargoLoaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventDynamicCargoRemoved">PLAYERTASKCONTROLLER:OnEventDynamicCargoRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventDynamicCargoUnloaded">PLAYERTASKCONTROLLER:OnEventDynamicCargoUnloaded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventEjection">PLAYERTASKCONTROLLER:OnEventEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventEngineShutdown">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventEngineStartup">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventHit">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventHumanFailure">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventKill">PLAYERTASKCONTROLLER:OnEventKill(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs on the death of a unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventLand">PLAYERTASKCONTROLLER:OnEventLand(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventLandingAfterEjection">PLAYERTASKCONTROLLER:OnEventLandingAfterEjection(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventLandingQualityMark">PLAYERTASKCONTROLLER:OnEventLandingQualityMark(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Landing quality mark.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventMarkAdded">PLAYERTASKCONTROLLER:OnEventMarkAdded(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a new mark was added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventMarkChange">PLAYERTASKCONTROLLER:OnEventMarkChange(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark text was changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventMarkRemoved">PLAYERTASKCONTROLLER:OnEventMarkRemoved(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mark was removed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventMissionEnd">PLAYERTASKCONTROLLER:OnEventMissionEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventMissionStart">PLAYERTASKCONTROLLER:OnEventMissionStart(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventNewDynamicCargo">PLAYERTASKCONTROLLER:OnEventNewDynamicCargo(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventParatrooperLanding">PLAYERTASKCONTROLLER:OnEventParatrooperLanding(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Weapon add.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventPilotDead">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventPlayerEnterAircraft">PLAYERTASKCONTROLLER:OnEventPlayerEnterAircraft(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventPlayerEnterUnit">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventPlayerLeaveUnit">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventRefueling">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventRefuelingStop">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventScore">PLAYERTASKCONTROLLER:OnEventScore(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventShootingEnd">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventShootingStart">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventShot">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventTakeoff">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).OnEventTriggerZone">PLAYERTASKCONTROLLER:OnEventTriggerZone(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).OnEventUnitLost">PLAYERTASKCONTROLLER:OnEventUnitLost(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Properties">PLAYERTASKCONTROLLER.Properties</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).ScheduleOnce">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).ScheduleRepeat">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).ScheduleStop">PLAYERTASKCONTROLLER:ScheduleStop(SchedulerID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Stops the Schedule.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).Scheduler">PLAYERTASKCONTROLLER.Scheduler</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The scheduler object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetEventPriority">PLAYERTASKCONTROLLER:SetEventPriority(EventPriority)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetProperty">PLAYERTASKCONTROLLER:SetProperty(Key, Value)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set one property of an object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).SetState">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).T">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).T2">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).T3">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).TraceAll">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).TraceClass">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).TraceClassMethod">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).TraceLevel">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).TraceOff">PLAYERTASKCONTROLLER:TraceOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TraceOn">PLAYERTASKCONTROLLER:TraceOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set trace on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER).TraceOnOff">PLAYERTASKCONTROLLER: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="##(PLAYERTASKCONTROLLER).UnHandleEvent">PLAYERTASKCONTROLLER:UnHandleEvent(EventID)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._">PLAYERTASKCONTROLLER._</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="##(PLAYERTASKCONTROLLER)._F">PLAYERTASKCONTROLLER:_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="##(PLAYERTASKCONTROLLER)._Serialize">PLAYERTASKCONTROLLER:_Serialize(Arguments)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>(Internal) Serialize arguments</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PLAYERTASKCONTROLLER)._T">PLAYERTASKCONTROLLER:_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="##(PLAYERTASKCONTROLLER).__">PLAYERTASKCONTROLLER.__</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="##(PLAYERTASKCONTROLLER).onEvent">PLAYERTASKCONTROLLER:onEvent(event)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The main event handling function...</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PersistenceData)">Type <strong>PersistenceData</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(PersistenceData)">PersistenceData</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 PersistenceData</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="##(PersistenceData).ID">PersistenceData.ID</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="##(PersistenceData).InitialTargets">PersistenceData.InitialTargets</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="##(PersistenceData).Name">PersistenceData.Name</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="##(PersistenceData).Targetsleft">PersistenceData.Targetsleft</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="##(PersistenceData).Task">PersistenceData.Task</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="##(PersistenceData).Type">PersistenceData.Type</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(PersistenceData).updated">PersistenceData.updated</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="#(SeadAttributes)">Type <strong>SeadAttributes</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(SeadAttributes)">SeadAttributes</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 SeadAttributes</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="##(SeadAttributes).AAA">SeadAttributes.AAA</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>GROUP.Attribute.GROUND_AAA</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SeadAttributes).EWR">SeadAttributes.EWR</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>GROUP.Attribute.GROUND_EWR </p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(SeadAttributes).SAM">SeadAttributes.SAM</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>GROUP.Attribute.GROUND_SAM </p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Type)">Type <strong>Type</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(Type)">Type</a></strong>
|
|
</div>
|
|
<div class="w3-card w3-margin">
|
|
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
|
<tr class="w3-theme-l1">
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from Type</th>
|
|
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Type).A2A">Type.A2A</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Air-to-Air Controller</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Type).A2G">Type.A2G</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Air-to-Ground Controller</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Type).A2GS">Type.A2GS</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Air-to-Ground-and-Ship Controller</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Type).A2S">Type.A2S</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Air-to-Ship Controller</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Ops.PlayerTask)" >Type <strong>Ops.PlayerTask</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##PLAYERTASK')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASK)">Type <strong>PLAYERTASK</strong></a></h2></div>
|
|
<div id= "#Types##PLAYERTASK" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>PLAYERTASK class.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).CanSmoke" ><strong>PLAYERTASK.CanSmoke</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).ClassName" ><strong>PLAYERTASK.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASK).Clients" ><strong>PLAYERTASK.Clients</strong></a>
|
|
|
|
<p>FiFo of Wrapper.Client#CLIENT planes executing this task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FinalState" ><strong>PLAYERTASK.FinalState</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).FlareColor" ><strong>PLAYERTASK.FlareColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).Freetext" ><strong>PLAYERTASK.Freetext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FreetextTTS" ><strong>PLAYERTASK.FreetextTTS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskFailure" ><strong>PLAYERTASK.NextTaskFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskSuccess" ><strong>PLAYERTASK.NextTaskSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).PersistMe" ><strong>PLAYERTASK.PersistMe</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PlayerTaskNr" ><strong>PLAYERTASK.PlayerTaskNr</strong></a>
|
|
|
|
<p>(Globally unique) Number of the task.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PreviousCount" ><strong>PLAYERTASK.PreviousCount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).Repeat" ><strong>PLAYERTASK.Repeat</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).RepeatNo" ><strong>PLAYERTASK.RepeatNo</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).ShowThreatDetails" ><strong>PLAYERTASK.ShowThreatDetails</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).SmokeColor" ><strong>PLAYERTASK.SmokeColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<a id="#(PLAYERTASK).Target" ><strong>PLAYERTASK.Target</strong></a>
|
|
|
|
<p>The target for this Task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a>
|
|
<a id="#(PLAYERTASK).TargetMarker" ><strong>PLAYERTASK.TargetMarker</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASKCONTROLLER)">Ops.PlayerTask#PLAYERTASKCONTROLLER</a>
|
|
<a id="#(PLAYERTASK).TaskController" ><strong>PLAYERTASK.TaskController</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TaskSubType" ><strong>PLAYERTASK.TaskSubType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG.Type)">Ops.Auftrag#AUFTRAG.Type</a>
|
|
<a id="#(PLAYERTASK).Type" ><strong>PLAYERTASK.Type</strong></a>
|
|
|
|
<p>The type of the task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TypeName" ><strong>PLAYERTASK.TypeName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).coalition" ><strong>PLAYERTASK.coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionFailure" ><strong>PLAYERTASK.conditionFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionSuccess" ><strong>PLAYERTASK.conditionSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).lastsmoketime" ><strong>PLAYERTASK.lastsmoketime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).lid" ><strong>PLAYERTASK.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).repeats" ><strong>PLAYERTASK.repeats</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).timestamp" ><strong>PLAYERTASK.timestamp</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).verbose" ><strong>PLAYERTASK.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).version" ><strong>PLAYERTASK.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddClient" ><strong>PLAYERTASK:AddClient(Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a client to this task</p>
|
|
|
|
<div id= "#Functions##AddClient" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><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>Client</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddConditionFailure" ><strong>PLAYERTASK:AddConditionFailure(ConditionFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add failure condition.</p>
|
|
|
|
<div id= "#Functions##AddConditionFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>ConditionFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If this function returns <code>true</code>, the task is cancelled.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Condition function arguments if any.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddConditionSuccess" ><strong>PLAYERTASK:AddConditionSuccess(ConditionFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add success condition.</p>
|
|
|
|
<div id= "#Functions##AddConditionSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>ConditionFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If this function returns <code>true</code>, the mission is cancelled.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Condition function arguments if any.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddFreetext" ><strong>PLAYERTASK:AddFreetext(Text)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Add a free text description to this task.</p>
|
|
|
|
<div id= "#Functions##AddFreetext" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Text</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddFreetextTTS" ><strong>PLAYERTASK:AddFreetextTTS(TextTTS)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Add a free text description for TTS to this task.</p>
|
|
|
|
<div id= "#Functions##AddFreetextTTS" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>TextTTS</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddNextTaskAfterFailure" ><strong>PLAYERTASK:AddNextTaskAfterFailure(Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Add a task to be assigned to same clients when task was a failure.</p>
|
|
|
|
<div id= "#Functions##AddNextTaskAfterFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddNextTaskAfterSuccess" ><strong>PLAYERTASK:AddNextTaskAfterSuccess(Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Add a task to be assigned to same clients when task was a success.</p>
|
|
|
|
<div id= "#Functions##AddNextTaskAfterSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddOpsZoneCaptureSuccessCondition" ><strong>PLAYERTASK:AddOpsZoneCaptureSuccessCondition(CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Adds task success condition for AUFTRAG.Type.CAPTUREZONE for OpsZone or OpsZone set target object.</p>
|
|
|
|
|
|
<ul>
|
|
<li>At least one of the task clients and one capture group need to be inside the zone in order for the capture to be successful.</li>
|
|
</ul>
|
|
|
|
<div id= "#Functions##AddOpsZoneCaptureSuccessCondition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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="##(SET_BASE)">#SET_BASE</a>
|
|
<strong><strong>CaptureSquadGroupNamePrefix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The prefix of the group name that needs to capture the zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The coalition that needs to capture the zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>CheckClientInZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, a CLIENT assigned to this task also needs to be in the zone for the task to be successful.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- We can use either STATIC, SET_STATIC, SCENERY or SET_SCENERY as target objects.
|
|
local opsZone = OPSZONE:New(zone, coalition.side.RED)
|
|
|
|
...
|
|
|
|
-- We can use either OPSZONE or SET_OPSZONE.
|
|
local mytask = PLAYERTASK:NewFromTarget(opsZone, true, 50, "Capture the zone")
|
|
mytask:SetMenuName("Capture the ops zone")
|
|
mytask:AddFreetext("Transport capture squad to the ops zone.")
|
|
|
|
-- We set CaptureSquadGroupNamePrefix the group name prefix as set in the ME or the spawn of the group that need to be present at the OpsZone like a capture squad,
|
|
-- and set the capturing Coalition in order to trigger a successful task.
|
|
mytask:AddOpsZoneCaptureSuccessCondition("capture-squad", coalition.side.BLUE, false)
|
|
|
|
playerTaskManager:AddPlayerTaskToQueue(mytask)</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddReconSuccessCondition" ><strong>PLAYERTASK:AddReconSuccessCondition(MinDistance)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Adds task success condition for AUFTRAG.Type.RECON when a client is at a certain LOS distance from the target.</p>
|
|
|
|
<div id= "#Functions##AddReconSuccessCondition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>MinDistance</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Minimum distance in meters from client to target in LOS for success condition. (Default 5 NM)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- target can be any object that has a `GetCoordinate()` function like STATIC, GROUP, ZONE...
|
|
local mytask = PLAYERTASK:New(AUFTRAG.Type.RECON, ZONE:New("WF Zone"), true, 50, "Deep Earth")
|
|
mytask:SetMenuName("Recon weapon factory")
|
|
mytask:AddFreetext("Locate and investigate underground weapons factory near Kovdor.")
|
|
|
|
-- We set the MinDistance (optional) in meters for the client to be in LOS from the target in order to trigger a successful task.
|
|
mytask:AddReconSuccessCondition(10000) -- 10 km (default is 5 NM if not set)
|
|
|
|
playerTaskManager:AddPlayerTaskToQueue(mytask)</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddStaticObjectSuccessCondition" ><strong>PLAYERTASK:AddStaticObjectSuccessCondition()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Adds task success condition for dead STATIC, SET_STATIC, SCENERY or SET_SCENERY target object.</p>
|
|
|
|
<div id= "#Functions##AddStaticObjectSuccessCondition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- We can use either STATIC, SET_STATIC, SCENERY or SET_SCENERY as target objects.
|
|
local mytask = PLAYERTASK:NewFromTarget(static, true, 50, "Destroy the target")
|
|
mytask:SetMenuName("Destroy Power Plant")
|
|
mytask:AddFreetext("Locate and destroy the power plant near Olenya.")
|
|
mytask:AddStaticObjectSuccessCondition()
|
|
|
|
playerTaskManager:AddPlayerTaskToQueue(mytask)</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddTimeLimitFailureCondition" ><strong>PLAYERTASK:AddTimeLimitFailureCondition(TimeLimit)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Adds a time limit for the task to be completed.</p>
|
|
|
|
<div id= "#Functions##AddTimeLimitFailureCondition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>TimeLimit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Time limit in seconds for the task to be completed. (Default 0 = no time limit)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>local mytask = PLAYERTASK:New(AUFTRAG.Type.RECON, ZONE:New("WF Zone"), true, 50, "Deep Earth")
|
|
mytask:SetMenuName("Recon weapon factory")
|
|
mytask:AddFreetext("Locate and investigate underground weapons factory near Kovdor.")
|
|
mytask:AddReconSuccessCondition(10000) -- 10 km
|
|
|
|
-- We set the TimeLimit to 10 minutes (600 seconds) from the moment the task is started, once the time has passed and the task is not yet successful it will trigger a failure.
|
|
mytask:AddTimeLimitFailureCondition(600)
|
|
|
|
playerTaskManager:AddPlayerTaskToQueue(mytask)</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CanJoinTask" ><strong>PLAYERTASK:CanJoinTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Override this function in order to implement custom logic if a player can join a task or not.</p>
|
|
|
|
<div id= "#Functions##CanJoinTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></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>Outcome True if player can join the task, false if not</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).ClientAbort" ><strong>PLAYERTASK:ClientAbort(Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Client has aborted task this task</p>
|
|
|
|
<div id= "#Functions##ClientAbort" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><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>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CountClients" ><strong>PLAYERTASK:CountClients()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Count clients</p>
|
|
|
|
<div id= "#Functions##CountClients" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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>clientcount</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).EnablePersistance" ><strong>PLAYERTASK:EnablePersistance()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set this task for persistance, if persistance is enabled on the PLAYERTASKCONTROLLER instance.</p>
|
|
|
|
<div id= "#Functions##EnablePersistance" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).FlareTarget" ><strong>PLAYERTASK:FlareTarget(Color)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Flare Target</p>
|
|
|
|
<div id= "#Functions##FlareTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Color</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p> defaults to FLARECOLOR.Red</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetClientObjects" ><strong>PLAYERTASK:GetClientObjects()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Get #CLIENT objects assigned as table</p>
|
|
|
|
<div id= "#Functions##GetClientObjects" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>clients</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>clientcount</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetClients" ><strong>PLAYERTASK:GetClients()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Get client names assigned as table of #strings</p>
|
|
|
|
<div id= "#Functions##GetClients" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>clients</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>clientcount</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetCoalition" ><strong>PLAYERTASK:GetCoalition()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Get the coalition side for this task</p>
|
|
|
|
<div id= "#Functions##GetCoalition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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>Coalition Coaltion side, e.g. coalition.side.BLUE, or nil if not 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="#(PLAYERTASK).GetFreetext" ><strong>PLAYERTASK:GetFreetext()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Get the free text description from this task.</p>
|
|
|
|
<div id= "#Functions##GetFreetext" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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>Text</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetFreetextTTS" ><strong>PLAYERTASK:GetFreetextTTS()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Get the free text TTS description from this task.</p>
|
|
|
|
<div id= "#Functions##GetFreetextTTS" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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>Text</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetSubType" ><strong>PLAYERTASK:GetSubType()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Get task sub type description from this task.</p>
|
|
|
|
<div id= "#Functions##GetSubType" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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>Type or nil</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetTarget" ><strong>PLAYERTASK:GetTarget()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Get the Ops.Target#TARGET object for this task</p>
|
|
|
|
<div id= "#Functions##GetTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Target</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).HasClients" ><strong>PLAYERTASK:HasClients()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Check if PLAYERTASK has clients assigned to it.</p>
|
|
|
|
<div id= "#Functions##HasClients" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>hasclients</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).HasFreetext" ><strong>PLAYERTASK:HasFreetext()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Query if a task has free text description.</p>
|
|
|
|
<div id= "#Functions##HasFreetext" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).HasFreetextTTS" ><strong>PLAYERTASK:HasFreetextTTS()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Query if a task has free text TTS description.</p>
|
|
|
|
<div id= "#Functions##HasFreetextTTS" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).HasPlayerName" ><strong>PLAYERTASK:HasPlayerName(Name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Check if a player name is assigned to this task</p>
|
|
|
|
<div id= "#Functions##HasPlayerName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Name</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>HasName</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).IlluminateTarget" ><strong>PLAYERTASK:IlluminateTarget(Power, Height)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Illuminate Target Area</p>
|
|
|
|
<div id= "#Functions##IlluminateTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Power</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Power of illumination bomb in Candela. Default 1000 cd.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Height</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Height above target used to release the bomb, default 150m.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).IsDone" ><strong>PLAYERTASK:IsDone()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Check if task is done</p>
|
|
|
|
<div id= "#Functions##IsDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>done</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).IsNotDone" ><strong>PLAYERTASK:IsNotDone()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Check if task is NOT done</p>
|
|
|
|
<div id= "#Functions##IsNotDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>done</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).MarkTargetOnF10Map" ><strong>PLAYERTASK:MarkTargetOnF10Map(Text, Coalition, ReadOnly)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Create target mark on F10 map</p>
|
|
|
|
<div id= "#Functions##MarkTargetOnF10Map" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Text</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Text to show on the marker</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Coalition this marker is for. Default = All.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>ReadOnly</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Make target marker read-only. Default = false.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).New" ><strong>PLAYERTASK:New(Type, Target, Repeat, Times, TTSType)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Constructor</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>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.Auftrag.html##(AUFTRAG.Type)">Ops.Auftrag#AUFTRAG.Type</a>
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of this task</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<strong><strong>Target</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Target for this task</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Repeat this task if true (default = false)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Times</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Repeat on failure this many times if Repeat is true (default = 1)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>TTSType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>TTS friendly task type name</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).NewFromTarget" ><strong>PLAYERTASK:NewFromTarget(Target, Repeat, Times, TTSType)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Constructor that automatically determines the task type based on the target.</p>
|
|
|
|
<div id= "#Functions##NewFromTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<strong><strong>Target</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Target for this task</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Repeat this task if true (default = false)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Times</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Repeat on failure this many times if Repeat is true (default = 1)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>TTSType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>TTS friendly task type name</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterCancel" ><strong>PLAYERTASK:OnAfterCancel(From, Event, To, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Cancel" event.</p>
|
|
|
|
|
|
<p>Task has been cancelled.</p>
|
|
|
|
<div id= "#Functions##OnAfterCancel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, suppress message output on cancel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterClientAborted" ><strong>PLAYERTASK:OnAfterClientAborted(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "ClientAborted" event.</p>
|
|
|
|
|
|
<p>A client has aborted the task.</p>
|
|
|
|
<div id= "#Functions##OnAfterClientAborted" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterClientAdded" ><strong>PLAYERTASK:OnAfterClientAdded(From, Event, To, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "ClientAdded" event.</p>
|
|
|
|
|
|
<p>Client has been added to the task.</p>
|
|
|
|
<div id= "#Functions##OnAfterClientAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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="#(PLAYERTASK).OnAfterClientRemoved" ><strong>PLAYERTASK:OnAfterClientRemoved(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "ClientRemoved" event.</p>
|
|
|
|
|
|
<p>Client has been removed from the task.</p>
|
|
|
|
<div id= "#Functions##OnAfterClientRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterDone" ><strong>PLAYERTASK:OnAfterDone(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Done" event.</p>
|
|
|
|
|
|
<p>Task is done.</p>
|
|
|
|
<div id= "#Functions##OnAfterDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterExecuting" ><strong>PLAYERTASK:OnAfterExecuting(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Executing" event.</p>
|
|
|
|
|
|
<p>Task is executed by the 1st client.</p>
|
|
|
|
<div id= "#Functions##OnAfterExecuting" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterFailed" ><strong>PLAYERTASK:OnAfterFailed(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Failed" event.</p>
|
|
|
|
|
|
<p>Task has been a failure.</p>
|
|
|
|
<div id= "#Functions##OnAfterFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterPilotPlanned" ><strong>PLAYERTASK:OnAfterPilotPlanned(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Planned" event.</p>
|
|
|
|
|
|
<p>Task has been planned.</p>
|
|
|
|
<div id= "#Functions##OnAfterPilotPlanned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterPlanned" ><strong>PLAYERTASK:OnAfterPlanned(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Planned" event.</p>
|
|
|
|
|
|
<p>Task has been planned.</p>
|
|
|
|
<div id= "#Functions##OnAfterPlanned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterRequested" ><strong>PLAYERTASK:OnAfterRequested(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Requested" event.</p>
|
|
|
|
|
|
<p>Task has been Requested.</p>
|
|
|
|
<div id= "#Functions##OnAfterRequested" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnAfterSuccess" ><strong>PLAYERTASK:OnAfterSuccess(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "Success" event.</p>
|
|
|
|
|
|
<p>Task has been a success.</p>
|
|
|
|
<div id= "#Functions##OnAfterSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).RemoveClient" ><strong>PLAYERTASK:RemoveClient(Client, Name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove a client from this task</p>
|
|
|
|
<div id= "#Functions##RemoveClient" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the client</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetCanSmoke" ><strong>PLAYERTASK:SetCanSmoke(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Set if a task can have a smoke marker.</p>
|
|
|
|
<div id= "#Functions##SetCanSmoke" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true (default) it can be smoke, false if not.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetCoalition" ><strong>PLAYERTASK:SetCoalition(Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set a coalition side for this task</p>
|
|
|
|
<div id= "#Functions##SetCoalition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coaltion side to add, e.g. coalition.side.BLUE</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetMenuName" ><strong>PLAYERTASK:SetMenuName(Text)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Add a short free text description for the menu entry of this task.</p>
|
|
|
|
<div id= "#Functions##SetMenuName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Text</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetShowThreatDetails" ><strong>PLAYERTASK:SetShowThreatDetails(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Set if a task can show threat details.</p>
|
|
|
|
<div id= "#Functions##SetShowThreatDetails" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true (default) it can be shown, false if not.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetSubType" ><strong>PLAYERTASK:SetSubType(Type)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[USER] Set a task sub type description to this task.</p>
|
|
|
|
<div id= "#Functions##SetSubType" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Type</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SmokeTarget" ><strong>PLAYERTASK:SmokeTarget(Color)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Smoke Target</p>
|
|
|
|
<div id= "#Functions##SmokeTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>Color</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p> defaults to SMOKECOLOR.Red</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._CheckCaptureOpsZoneSuccess" ><strong>PLAYERTASK:_CheckCaptureOpsZoneSuccess(OpsZone, CaptureSquadGroupNamePrefix, Coalition, CheckClientInZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check OpsZone capture success condition.</p>
|
|
|
|
<div id= "#Functions##_CheckCaptureOpsZoneSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>
|
|
<strong><strong>OpsZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The OpsZone target object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>CaptureSquadGroupNamePrefix</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The prefix of the group name that needs to capture the zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The coalition that needs to capture the zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>CheckClientInZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Check if any of the clients are in zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._EvalConditionsAny" ><strong>PLAYERTASK:_EvalConditionsAny(Conditions)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check if any of the given conditions is true.</p>
|
|
|
|
<div id= "#Functions##_EvalConditionsAny" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Conditions</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of conditions.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, at least one condition is true.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._GetTaskTypeForTarget" ><strong>PLAYERTASK:_GetTaskTypeForTarget(Target)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Determines AUFTRAG type based on the target characteristics.</p>
|
|
|
|
<div id= "#Functions##_GetTaskTypeForTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<strong><strong>Target</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Target for this task</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>AUFTRAG.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="#(PLAYERTASK)._SetController" ><strong>PLAYERTASK:_SetController(Controller)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Add a PLAYERTASKCONTROLLER for this task</p>
|
|
|
|
<div id= "#Functions##_SetController" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASKCONTROLLER)">Ops.PlayerTask#PLAYERTASKCONTROLLER</a>
|
|
<strong><strong>Controller</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterCancel" ><strong>PLAYERTASK:onafterCancel(From, Event, To, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after cancel call</p>
|
|
|
|
<div id= "#Functions##onafterCancel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
#boolean
|
|
<strong><strong>Silent</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterClientAdded" ><strong>PLAYERTASK:onafterClientAdded(From, Event, To, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after client added call</p>
|
|
|
|
<div id= "#Functions##onafterClientAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterDone" ><strong>PLAYERTASK:onafterDone(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after done call</p>
|
|
|
|
<div id= "#Functions##onafterDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterExecuting" ><strong>PLAYERTASK:onafterExecuting(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after executing call</p>
|
|
|
|
<div id= "#Functions##onafterExecuting" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterFailed" ><strong>PLAYERTASK:onafterFailed(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after failed call</p>
|
|
|
|
<div id= "#Functions##onafterFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterPlanned" ><strong>PLAYERTASK:onafterPlanned(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after planned call</p>
|
|
|
|
<div id= "#Functions##onafterPlanned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterProgress" ><strong>PLAYERTASK:onafterProgress(From, Event, To, TargetCount)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after progress call</p>
|
|
|
|
<div id= "#Functions##onafterProgress" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
#number
|
|
<strong><strong>TargetCount</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="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterRequested" ><strong>PLAYERTASK:onafterRequested(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after requested call</p>
|
|
|
|
<div id= "#Functions##onafterRequested" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterStatus" ><strong>PLAYERTASK:onafterStatus(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after status call</p>
|
|
|
|
<div id= "#Functions##onafterStatus" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterStop" ><strong>PLAYERTASK:onafterStop(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after status call</p>
|
|
|
|
<div id= "#Functions##onafterStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).onafterSuccess" ><strong>PLAYERTASK:onafterSuccess(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after success call</p>
|
|
|
|
<div id= "#Functions##onafterSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASK</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASK)">#PLAYERTASK</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).CanSmoke" ><strong>PLAYERTASK.CanSmoke</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).ClassName" ><strong>PLAYERTASK.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASK).Clients" ><strong>PLAYERTASK.Clients</strong></a>
|
|
|
|
<p>FiFo of Wrapper.Client#CLIENT planes executing this task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FinalState" ><strong>PLAYERTASK.FinalState</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).FlareColor" ><strong>PLAYERTASK.FlareColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).Freetext" ><strong>PLAYERTASK.Freetext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FreetextTTS" ><strong>PLAYERTASK.FreetextTTS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskFailure" ><strong>PLAYERTASK.NextTaskFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskSuccess" ><strong>PLAYERTASK.NextTaskSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).PersistMe" ><strong>PLAYERTASK.PersistMe</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PlayerTaskNr" ><strong>PLAYERTASK.PlayerTaskNr</strong></a>
|
|
|
|
<p>(Globally unique) Number of the task.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PreviousCount" ><strong>PLAYERTASK.PreviousCount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).Repeat" ><strong>PLAYERTASK.Repeat</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).RepeatNo" ><strong>PLAYERTASK.RepeatNo</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).ShowThreatDetails" ><strong>PLAYERTASK.ShowThreatDetails</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).SmokeColor" ><strong>PLAYERTASK.SmokeColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<a id="#(PLAYERTASK).Target" ><strong>PLAYERTASK.Target</strong></a>
|
|
|
|
<p>The target for this Task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a>
|
|
<a id="#(PLAYERTASK).TargetMarker" ><strong>PLAYERTASK.TargetMarker</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASKCONTROLLER)">Ops.PlayerTask#PLAYERTASKCONTROLLER</a>
|
|
<a id="#(PLAYERTASK).TaskController" ><strong>PLAYERTASK.TaskController</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TaskSubType" ><strong>PLAYERTASK.TaskSubType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG.Type)">Ops.Auftrag#AUFTRAG.Type</a>
|
|
<a id="#(PLAYERTASK).Type" ><strong>PLAYERTASK.Type</strong></a>
|
|
|
|
<p>The type of the task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TypeName" ><strong>PLAYERTASK.TypeName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).coalition" ><strong>PLAYERTASK.coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionFailure" ><strong>PLAYERTASK.conditionFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionSuccess" ><strong>PLAYERTASK.conditionSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).lastsmoketime" ><strong>PLAYERTASK.lastsmoketime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).lid" ><strong>PLAYERTASK.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).repeats" ><strong>PLAYERTASK.repeats</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).timestamp" ><strong>PLAYERTASK.timestamp</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).verbose" ><strong>PLAYERTASK.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).version" ><strong>PLAYERTASK.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddEndState" ><strong>PLAYERTASK:AddEndState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds an End state.</p>
|
|
|
|
<div id= "#Functions##AddEndState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddProcess" ><strong>PLAYERTASK:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
|
|
<div id= "#Functions##AddProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>
|
|
<strong><strong>Process</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>An sub-process FSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>ReturnEvents</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The SubFSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddScore" ><strong>PLAYERTASK:AddScore(State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScore" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddScoreProcess" ><strong>PLAYERTASK:AddScoreProcess(From, Event, State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScoreProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the From State of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Event of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).AddTransition" ><strong>PLAYERTASK:AddTransition(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
|
|
|
|
<p>A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.</p>
|
|
|
|
<div id= "#Functions##AddTransition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetCurrentState" ><strong>PLAYERTASK:GetCurrentState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</p>
|
|
|
|
<div id= "#Functions##GetCurrentState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetEndStates" ><strong>PLAYERTASK:GetEndStates()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the End states.</p>
|
|
|
|
<div id= "#Functions##GetEndStates" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>End states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetProcess" ><strong>PLAYERTASK:GetProcess(From, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetProcesses" ><strong>PLAYERTASK:GetProcesses()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetProcesses" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub processes.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetScores" ><strong>PLAYERTASK:GetScores()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the scores defined.</p>
|
|
|
|
<div id= "#Functions##GetScores" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Scores.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetStartState" ><strong>PLAYERTASK:GetStartState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##GetStartState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A string containing the start state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetState" ><strong>PLAYERTASK:GetState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</p>
|
|
|
|
<div id= "#Functions##GetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetSubs" ><strong>PLAYERTASK:GetSubs()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the Subs defined.</p>
|
|
|
|
<div id= "#Functions##GetSubs" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub processes.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetTransitions" ><strong>PLAYERTASK:GetTransitions()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetTransitions" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transitions.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).Is" ><strong>PLAYERTASK:Is(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##Is" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).LoadCallBacks" ><strong>PLAYERTASK:LoadCallBacks(CallBackTable)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Load call backs.</p>
|
|
|
|
<div id= "#Functions##LoadCallBacks" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>CallBackTable</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of call backs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).New" ><strong>PLAYERTASK:New()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creates a new FSM object.</p>
|
|
|
|
<div id= "#Functions##New" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetProcess" ><strong>PLAYERTASK:SetProcess(From, Event, Fsm)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##SetProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Fsm</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetStartState" ><strong>PLAYERTASK:SetStartState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sets the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##SetStartState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A string defining the start state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._add_to_map" ><strong>PLAYERTASK:_add_to_map(Map, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add to map.</p>
|
|
|
|
<div id= "#Functions##_add_to_map" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Map</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event table.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._call_handler" ><strong>PLAYERTASK:_call_handler(step, trigger, params, EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Call handler.</p>
|
|
|
|
<div id= "#Functions##_call_handler" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>step</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Step "onafter", "onbefore", "onenter", "onleave".</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>trigger</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Trigger.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>params</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parameters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._create_transition" ><strong>PLAYERTASK:_create_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create transition.</p>
|
|
|
|
<div id= "#Functions##_create_transition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._delayed_transition" ><strong>PLAYERTASK:_delayed_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delayed transition.</p>
|
|
|
|
<div id= "#Functions##_delayed_transition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._eventmap" ><strong>PLAYERTASK:_eventmap(Events, EventStructure)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Event map.</p>
|
|
|
|
<div id= "#Functions##_eventmap" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Events</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Events.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>EventStructure</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._gosub" ><strong>PLAYERTASK:_gosub(ParentFrom, ParentEvent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Go sub.</p>
|
|
|
|
<div id= "#Functions##_gosub" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ParentFrom</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent from state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ParentEvent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Subs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._handler" ><strong>PLAYERTASK:_handler(EventName, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Handler.</p>
|
|
|
|
<div id= "#Functions##_handler" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Arguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._isendstate" ><strong>PLAYERTASK:_isendstate(Current)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Is end state.</p>
|
|
|
|
<div id= "#Functions##_isendstate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Current</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current state name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>FSM parent.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._submap" ><strong>PLAYERTASK:_submap(subs, sub, name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sub maps.</p>
|
|
|
|
<div id= "#Functions##_submap" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>subs</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Subs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>sub</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).can" ><strong>PLAYERTASK:can(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if can do an event.</p>
|
|
|
|
<div id= "#Functions##can" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM can do the event.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).cannot" ><strong>PLAYERTASK:cannot(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if cannot do an event.</p>
|
|
|
|
<div id= "#Functions##cannot" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM cannot do the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).is" ><strong>PLAYERTASK:is(State, state)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##is" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>state</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).CanSmoke" ><strong>PLAYERTASK.CanSmoke</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).ClassName" ><strong>PLAYERTASK.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASK).Clients" ><strong>PLAYERTASK.Clients</strong></a>
|
|
|
|
<p>FiFo of Wrapper.Client#CLIENT planes executing this task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FinalState" ><strong>PLAYERTASK.FinalState</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).FlareColor" ><strong>PLAYERTASK.FlareColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).Freetext" ><strong>PLAYERTASK.Freetext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).FreetextTTS" ><strong>PLAYERTASK.FreetextTTS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskFailure" ><strong>PLAYERTASK.NextTaskFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).NextTaskSuccess" ><strong>PLAYERTASK.NextTaskSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).PersistMe" ><strong>PLAYERTASK.PersistMe</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PlayerTaskNr" ><strong>PLAYERTASK.PlayerTaskNr</strong></a>
|
|
|
|
<p>(Globally unique) Number of the task.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).PreviousCount" ><strong>PLAYERTASK.PreviousCount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).Repeat" ><strong>PLAYERTASK.Repeat</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).RepeatNo" ><strong>PLAYERTASK.RepeatNo</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).ShowThreatDetails" ><strong>PLAYERTASK.ShowThreatDetails</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).SmokeColor" ><strong>PLAYERTASK.SmokeColor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<a id="#(PLAYERTASK).Target" ><strong>PLAYERTASK.Target</strong></a>
|
|
|
|
<p>The target for this Task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a>
|
|
<a id="#(PLAYERTASK).TargetMarker" ><strong>PLAYERTASK.TargetMarker</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASKCONTROLLER)">Ops.PlayerTask#PLAYERTASKCONTROLLER</a>
|
|
<a id="#(PLAYERTASK).TaskController" ><strong>PLAYERTASK.TaskController</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TaskSubType" ><strong>PLAYERTASK.TaskSubType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Auftrag.html##(AUFTRAG.Type)">Ops.Auftrag#AUFTRAG.Type</a>
|
|
<a id="#(PLAYERTASK).Type" ><strong>PLAYERTASK.Type</strong></a>
|
|
|
|
<p>The type of the task</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).TypeName" ><strong>PLAYERTASK.TypeName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).coalition" ><strong>PLAYERTASK.coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionFailure" ><strong>PLAYERTASK.conditionFailure</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK).conditionSuccess" ><strong>PLAYERTASK.conditionSuccess</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).lastsmoketime" ><strong>PLAYERTASK.lastsmoketime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).lid" ><strong>PLAYERTASK.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).repeats" ><strong>PLAYERTASK.repeats</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASK).timestamp" ><strong>PLAYERTASK.timestamp</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASK).verbose" ><strong>PLAYERTASK.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASK).version" ><strong>PLAYERTASK.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).ClearState" ><strong>PLAYERTASK: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="#(PLAYERTASK).CreateEventBirth" ><strong>PLAYERTASK: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="#(PLAYERTASK).CreateEventCrash" ><strong>PLAYERTASK:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventCrash" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventDead" ><strong>PLAYERTASK:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Dead Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventDynamicCargoLoaded" ><strong>PLAYERTASK:CreateEventDynamicCargoLoaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoLoaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventDynamicCargoRemoved" ><strong>PLAYERTASK:CreateEventDynamicCargoRemoved(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventDynamicCargoUnloaded" ><strong>PLAYERTASK:CreateEventDynamicCargoUnloaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoUnloaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventNewDynamicCargo" ><strong>PLAYERTASK:CreateEventNewDynamicCargo(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
|
|
<div id= "#Functions##CreateEventNewDynamicCargo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventPlayerEnterAircraft" ><strong>PLAYERTASK:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
|
|
<div id= "#Functions##CreateEventPlayerEnterAircraft" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
|
<strong><strong>PlayerUnit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The aircraft unit the player entered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).CreateEventRemoveUnit" ><strong>PLAYERTASK: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="#(PLAYERTASK).CreateEventTakeoff" ><strong>PLAYERTASK: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="#(PLAYERTASK).CreateEventUnitLost" ><strong>PLAYERTASK:CreateEventUnitLost(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventUnitLost" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).E" ><strong>PLAYERTASK: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="#(PLAYERTASK).EventDispatcher" ><strong>PLAYERTASK: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="#(PLAYERTASK).EventRemoveAll" ><strong>PLAYERTASK: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="#(PLAYERTASK).F" ><strong>PLAYERTASK: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="#(PLAYERTASK).F2" ><strong>PLAYERTASK: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="#(PLAYERTASK).F3" ><strong>PLAYERTASK: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="#(PLAYERTASK).GetClassID" ><strong>PLAYERTASK: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="#(PLAYERTASK).GetClassName" ><strong>PLAYERTASK: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="#(PLAYERTASK).GetClassNameAndID" ><strong>PLAYERTASK: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="#(PLAYERTASK).GetEventPriority" ><strong>PLAYERTASK:GetEventPriority()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##GetEventPriority" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetParent" ><strong>PLAYERTASK:GetParent(Child, FromClass)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
|
|
|
|
<p>Note that the Parent class must be passed to call the parent class method.</p>
|
|
|
|
<pre><code>self:GetParent(self):ParentMethod()
|
|
</code></pre>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetParent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>This is the Child class from which the Parent class needs to be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>FromClass</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The class from which to get the parent.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetProperties" ><strong>PLAYERTASK:GetProperties()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
|
|
<div id= "#Functions##GetProperties" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of values, indexed by keys.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetProperty" ><strong>PLAYERTASK:GetProperty(Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get one property of an object by the key.</p>
|
|
|
|
<div id= "#Functions##GetProperty" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).GetState" ><strong>PLAYERTASK:GetState(Object, Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##GetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).HandleEvent" ><strong>PLAYERTASK:HandleEvent(EventID, EventFunction)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Subscribe to a DCS Event.</p>
|
|
|
|
<div id= "#Functions##HandleEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>EventFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) The function to be called when the event occurs for the unit.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).I" ><strong>PLAYERTASK: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="#(PLAYERTASK).Inherit" ><strong>PLAYERTASK: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="#(PLAYERTASK).IsInstanceOf" ><strong>PLAYERTASK: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="#(PLAYERTASK).IsTrace" ><strong>PLAYERTASK: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="#(PLAYERTASK).New" ><strong>PLAYERTASK: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="#(PLAYERTASK).OnEvent" ><strong>PLAYERTASK:OnEvent(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that triggered the event. </p>
|
|
|
|
<div id= "#Functions##OnEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventBDA" ><strong>PLAYERTASK:OnEventBDA(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BDA.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventBDA" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventBaseCaptured" ><strong>PLAYERTASK:OnEventBaseCaptured(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that captured the base
|
|
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
|
|
|
|
<div id= "#Functions##OnEventBaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventBirth" ><strong>PLAYERTASK:OnEventBirth(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was spawned </p>
|
|
|
|
<div id= "#Functions##OnEventBirth" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventCrash" ><strong>PLAYERTASK:OnEventCrash(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that has crashed </p>
|
|
|
|
<div id= "#Functions##OnEventCrash" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDead" ><strong>PLAYERTASK:OnEventDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an object is dead.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is dead. </p>
|
|
|
|
<div id= "#Functions##OnEventDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDetailedFailure" ><strong>PLAYERTASK:OnEventDetailedFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
|
|
|
|
<p>Will update this page when new information become available.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that had the failure.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventDetailedFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDiscardChairAfterEjection" ><strong>PLAYERTASK:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Discard chair after ejection.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventDiscardChairAfterEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDynamicCargoLoaded" ><strong>PLAYERTASK:OnEventDynamicCargoLoaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoLoaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDynamicCargoRemoved" ><strong>PLAYERTASK:OnEventDynamicCargoRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventDynamicCargoUnloaded" ><strong>PLAYERTASK:OnEventDynamicCargoUnloaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoUnloaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventEjection" ><strong>PLAYERTASK:OnEventEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has ejected </p>
|
|
|
|
<div id= "#Functions##OnEventEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventEngineShutdown" ><strong>PLAYERTASK:OnEventEngineShutdown(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is stopping its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineShutdown" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventEngineStartup" ><strong>PLAYERTASK:OnEventEngineStartup(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is starting its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineStartup" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventHit" ><strong>PLAYERTASK:OnEventHit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit object the fired the weapon
|
|
weapon: Weapon object that hit the target
|
|
target: The Object that was hit. </p>
|
|
|
|
<div id= "#Functions##OnEventHit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventHumanFailure" ><strong>PLAYERTASK:OnEventHumanFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that had the failure </p>
|
|
|
|
<div id= "#Functions##OnEventHumanFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventKill" ><strong>PLAYERTASK:OnEventKill(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs on the death of a unit.</p>
|
|
|
|
|
|
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that killed the target</li>
|
|
<li>target: Target Object</li>
|
|
<li>weapon: Weapon Object</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventKill" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventLand" ><strong>PLAYERTASK:OnEventLand(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has landed
|
|
place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventLand" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventLandingAfterEjection" ><strong>PLAYERTASK:OnEventLandingAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
|
|
|
|
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.</li>
|
|
<li>place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.</li>
|
|
<li>subplace: is always 0 for unknown reasons.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventLandingAfterEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventLandingQualityMark" ><strong>PLAYERTASK:OnEventLandingQualityMark(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Landing quality mark.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventLandingQualityMark" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventMarkAdded" ><strong>PLAYERTASK:OnEventMarkAdded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a new mark was added.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventMarkChange" ><strong>PLAYERTASK:OnEventMarkChange(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark text was changed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkChange" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventMarkRemoved" ><strong>PLAYERTASK:OnEventMarkRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark was removed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventMissionEnd" ><strong>PLAYERTASK:OnEventMissionEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventMissionEnd" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventMissionStart" ><strong>PLAYERTASK:OnEventMissionStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
|
|
<div id= "#Functions##OnEventMissionStart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventNewDynamicCargo" ><strong>PLAYERTASK:OnEventNewDynamicCargo(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventNewDynamicCargo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventParatrooperLanding" ><strong>PLAYERTASK:OnEventParatrooperLanding(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Weapon add.</p>
|
|
|
|
|
|
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventParatrooperLanding" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventPilotDead" ><strong>PLAYERTASK:OnEventPilotDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
|
|
|
|
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the pilot has died in. </p>
|
|
|
|
<div id= "#Functions##OnEventPilotDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventPlayerEnterAircraft" ><strong>PLAYERTASK:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
<strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterAircraft" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventPlayerEnterUnit" ><strong>PLAYERTASK:OnEventPlayerEnterUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
|
|
|
|
<p>Note - not Mulitplayer safe. Use PlayerEnterAircraft.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterUnit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventPlayerLeaveUnit" ><strong>PLAYERTASK:OnEventPlayerLeaveUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the player left. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerLeaveUnit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventRefueling" ><strong>PLAYERTASK:OnEventRefueling(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefueling" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventRefuelingStop" ><strong>PLAYERTASK:OnEventRefuelingStop(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefuelingStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventScore" ><strong>PLAYERTASK:OnEventScore(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
|
|
|
|
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventScore" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventShootingEnd" ><strong>PLAYERTASK:OnEventShootingEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
|
|
|
|
<p>Event will always correspond with a shooting start event.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was doing the shooting. </p>
|
|
|
|
<div id= "#Functions##OnEventShootingEnd" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventShootingStart" ><strong>PLAYERTASK:OnEventShootingStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
|
|
|
|
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is doing the shooting.
|
|
target: The unit that is being targeted.</p>
|
|
|
|
<div id= "#Functions##OnEventShootingStart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventShot" ><strong>PLAYERTASK:OnEventShot(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
|
|
|
|
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventShot" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventTakeoff" ><strong>PLAYERTASK:OnEventTakeoff(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that tookoff
|
|
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventTriggerZone" ><strong>PLAYERTASK:OnEventTriggerZone(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger zone.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventTriggerZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).OnEventUnitLost" ><strong>PLAYERTASK:OnEventUnitLost(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that is was destroyed.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventUnitLost" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).ScheduleOnce" ><strong>PLAYERTASK:ScheduleOnce(Start, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleOnce" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Schedule ID of the planned schedule.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).ScheduleRepeat" ><strong>PLAYERTASK:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleRepeat" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the interval in seconds when the scheduler will call the event function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>RandomizeFactor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies a randomization factor between 0 and 1 to randomize the Repeat.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Stop</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds when the scheduler will be stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Schedule ID of the planned schedule.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).ScheduleStop" ><strong>PLAYERTASK:ScheduleStop(SchedulerID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Stops the Schedule.</p>
|
|
|
|
<div id= "#Functions##ScheduleStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>SchedulerID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetEventPriority" ><strong>PLAYERTASK:SetEventPriority(EventPriority)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##SetEventPriority" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>EventPriority</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetProperty" ><strong>PLAYERTASK:SetProperty(Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set one property of an object.</p>
|
|
|
|
<div id= "#Functions##SetProperty" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Value</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The value that is stored. Note that the value can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).SetState" ><strong>PLAYERTASK:SetState(Object, Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##SetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that will hold the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Value</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The value to is stored in the object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).T" ><strong>PLAYERTASK: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="#(PLAYERTASK).T2" ><strong>PLAYERTASK: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="#(PLAYERTASK).T3" ><strong>PLAYERTASK: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="#(PLAYERTASK).TraceAll" ><strong>PLAYERTASK: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="#(PLAYERTASK).TraceClass" ><strong>PLAYERTASK:TraceClass(Class)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a class</p>
|
|
|
|
<div id= "#Functions##TraceClass" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).TraceClassMethod" ><strong>PLAYERTASK:TraceClassMethod(Class, Method)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a specific method of class</p>
|
|
|
|
<div id= "#Functions##TraceClassMethod" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Method</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Method.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).TraceLevel" ><strong>PLAYERTASK: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="#(PLAYERTASK).TraceOff" ><strong>PLAYERTASK:TraceOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace off.</p>
|
|
|
|
<div id= "#Functions##TraceOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing Off
|
|
BASE:TraceOff()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).TraceOn" ><strong>PLAYERTASK:TraceOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on.</p>
|
|
|
|
<div id= "#Functions##TraceOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing On
|
|
BASE:TraceOn()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK).TraceOnOff" ><strong>PLAYERTASK: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="#(PLAYERTASK).UnHandleEvent" ><strong>PLAYERTASK:UnHandleEvent(EventID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
|
|
<div id= "#Functions##UnHandleEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._F" ><strong>PLAYERTASK:_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="#(PLAYERTASK)._Serialize" ><strong>PLAYERTASK:_Serialize(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>(Internal) Serialize arguments</p>
|
|
|
|
<div id= "#Functions##_Serialize" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Text</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASK)._T" ><strong>PLAYERTASK:_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="#(PLAYERTASK).onEvent" ><strong>PLAYERTASK:onEvent(event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>The main event handling function...</p>
|
|
|
|
|
|
<p>This function captures all events generated for the class.</p>
|
|
|
|
<div id= "#Functions##onEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Event)">DCS#Event</a>
|
|
<strong><strong>event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##PLAYERTASK.Condition')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASK.Condition)">Type <strong>PLAYERTASK.Condition</strong></a></h2></div>
|
|
<div id= "#Types##PLAYERTASK.Condition" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Generic task condition.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASK.Condition).arg" ><strong>PLAYERTASK.Condition.arg</strong></a>
|
|
|
|
<p>Optional arguments passed to the condition callback function.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#function
|
|
<a id="#(PLAYERTASK.Condition).func" ><strong>PLAYERTASK.Condition.func</strong></a>
|
|
|
|
<p>Callback function to check for a condition. Should return a #boolean.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##PLAYERTASKCONTROLLER')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PLAYERTASKCONTROLLER)">Type <strong>PLAYERTASKCONTROLLER</strong></a></h2></div>
|
|
<div id= "#Types##PLAYERTASKCONTROLLER" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>PLAYERTASKCONTROLLER class.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).AccessKey" ><strong>PLAYERTASKCONTROLLER.AccessKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveClientSet" ><strong>PLAYERTASKCONTROLLER.ActiveClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveInfoMenu" ><strong>PLAYERTASKCONTROLLER.ActiveInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.ActiveTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTopMenu" ><strong>PLAYERTASKCONTROLLER.ActiveTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).AllowFlash" ><strong>PLAYERTASKCONTROLLER.AllowFlash</strong></a>
|
|
|
|
<p>Flashing directions for players allowed</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCFrequency" ><strong>PLAYERTASKCONTROLLER.BCFrequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCModulation" ><strong>PLAYERTASKCONTROLLER.BCModulation</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).BlackList" ><strong>PLAYERTASKCONTROLLER.BlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignCustomFunc" ><strong>PLAYERTASKCONTROLLER.CallsignCustomFunc</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignTranslations" ><strong>PLAYERTASKCONTROLLER.CallsignTranslations</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClassName" ><strong>PLAYERTASKCONTROLLER.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientFilter" ><strong>PLAYERTASKCONTROLLER.ClientFilter</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientSet" ><strong>PLAYERTASKCONTROLLER.ClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).ClusterRadius" ><strong>PLAYERTASKCONTROLLER.ClusterRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).Coalition" ><strong>PLAYERTASKCONTROLLER.Coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CoalitionName" ><strong>PLAYERTASKCONTROLLER.CoalitionName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).FlashPlayer" ><strong>PLAYERTASKCONTROLLER.FlashPlayer</strong></a>
|
|
|
|
<p>List of player who switched Flashing Direction Info on</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasCoordinate" ><strong>PLAYERTASKCONTROLLER.InfoHasCoordinate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasLLDDM" ><strong>PLAYERTASKCONTROLLER.InfoHasLLDDM</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InformationMenu" ><strong>PLAYERTASKCONTROLLER.InformationMenu</strong></a>
|
|
|
|
<p>Show Radio Info Menu</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).Intel" ><strong>PLAYERTASKCONTROLLER.Intel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).IsClientSet" ><strong>PLAYERTASKCONTROLLER.IsClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinInfoMenu" ><strong>PLAYERTASKCONTROLLER.JoinInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinMenu" ><strong>PLAYERTASKCONTROLLER.JoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.JoinTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTopMenu" ><strong>PLAYERTASKCONTROLLER.JoinTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).Keepnumber" ><strong>PLAYERTASKCONTROLLER.Keepnumber</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDrone" ><strong>PLAYERTASKCONTROLLER.LasingDrone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDroneSet" ><strong>PLAYERTASKCONTROLLER.LasingDroneSet</strong></a>
|
|
|
|
|
|
|
|
|
|
<p>self.PlayerMenu = {} -- #table</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.MarkerOps_Base.html##(MARKEROPS_BASE)">Core.MarkerOps_Base#MARKEROPS_BASE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerOps" ><strong>PLAYERTASKCONTROLLER.MarkerOps</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerReadOnly" ><strong>PLAYERTASKCONTROLLER.MarkerReadOnly</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuName" ><strong>PLAYERTASKCONTROLLER.MenuName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuNoTask" ><strong>PLAYERTASKCONTROLLER.MenuNoTask</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Menu.html##(MENU_MISSION)">Core.Menu#MENU_MISSION</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuParent" ><strong>PLAYERTASKCONTROLLER.MenuParent</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).Messages" ><strong>PLAYERTASKCONTROLLER.Messages</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Name" ><strong>PLAYERTASKCONTROLLER.Name</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).NoScreenOutput" ><strong>PLAYERTASKCONTROLLER.NoScreenOutput</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).PathToGoogleKey" ><strong>PLAYERTASKCONTROLLER.PathToGoogleKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerFlashMenu" ><strong>PLAYERTASKCONTROLLER.PlayerFlashMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerInfoMenu" ><strong>PLAYERTASKCONTROLLER.PlayerInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerJoinMenu" ><strong>PLAYERTASKCONTROLLER.PlayerJoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenu" ><strong>PLAYERTASKCONTROLLER.PlayerMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenuTag" ><strong>PLAYERTASKCONTROLLER.PlayerMenuTag</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerRecce.html##(PLAYERRECCE)">Ops.PlayerRecce#PLAYERRECCE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerRecce" ><strong>PLAYERTASKCONTROLLER.PlayerRecce</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PrecisionTasks" ><strong>PLAYERTASKCONTROLLER.PrecisionTasks</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).RecceSet" ><strong>PLAYERTASKCONTROLLER.RecceSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRS" ><strong>PLAYERTASKCONTROLLER.SRS</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> set up SRS </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRSQueue" ><strong>PLAYERTASKCONTROLLER.SRSQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).SceneryExplosivesAmount" ><strong>PLAYERTASKCONTROLLER.SceneryExplosivesAmount</strong></a>
|
|
|
|
<p>Kgs of TNT to explode scenery on task persistance loading</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(Scores)">#Scores</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scores" ><strong>PLAYERTASKCONTROLLER.Scores</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Functional.Scoring.html##(SCORING)">Functional.Scoring#SCORING</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scoring" ><strong>PLAYERTASKCONTROLLER.Scoring</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SeadAttributes" ><strong>PLAYERTASKCONTROLLER.SeadAttributes</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShortCallsign" ><strong>PLAYERTASKCONTROLLER.ShortCallsign</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShowMagnetic" ><strong>PLAYERTASKCONTROLLER.ShowMagnetic</strong></a>
|
|
|
|
<p>Also show magnetic angles</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetQueue" ><strong>PLAYERTASKCONTROLLER.TargetQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetRadius" ><strong>PLAYERTASKCONTROLLER.TargetRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskInfoDuration" ><strong>PLAYERTASKCONTROLLER.TaskInfoDuration</strong></a>
|
|
|
|
<p>How long to show the briefing info on the screen</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistance" ><strong>PLAYERTASKCONTROLLER.TaskPersistance</strong></a>
|
|
|
|
<p>Table for persistance data</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceFilename" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceFilename</strong></a>
|
|
|
|
<p>File name for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistancePath" ><strong>PLAYERTASKCONTROLLER.TaskPersistancePath</strong></a>
|
|
|
|
<p>File path for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceSwitch" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceSwitch</strong></a>
|
|
|
|
<p>Switch for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskQueue" ><strong>PLAYERTASKCONTROLLER.TaskQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPerPlayer" ><strong>PLAYERTASKCONTROLLER.TasksPerPlayer</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPersistable" ><strong>PLAYERTASKCONTROLLER.TasksPersistable</strong></a>
|
|
|
|
<p>List of persistable tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TransmitOnlyWithPlayers" ><strong>PLAYERTASKCONTROLLER.TransmitOnlyWithPlayers</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Type" ><strong>PLAYERTASKCONTROLLER.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseBlackList" ><strong>PLAYERTASKCONTROLLER.UseBlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseGroupNames" ><strong>PLAYERTASKCONTROLLER.UseGroupNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseSRS" ><strong>PLAYERTASKCONTROLLER.UseSRS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseTypeNames" ><strong>PLAYERTASKCONTROLLER.UseTypeNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseWhiteList" ><strong>PLAYERTASKCONTROLLER.UseWhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).WhiteList" ><strong>PLAYERTASKCONTROLLER.WhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).activehasinfomenu" ><strong>PLAYERTASKCONTROLLER.activehasinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).buddylasing" ><strong>PLAYERTASKCONTROLLER.buddylasing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).customcallsigns" ><strong>PLAYERTASKCONTROLLER.customcallsigns</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.TextAndSound.html##(TEXTANDSOUND)">Core.TextAndSound#TEXTANDSOUND</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).gettext" ><strong>PLAYERTASKCONTROLLER.gettext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).holdmenutime" ><strong>PLAYERTASKCONTROLLER.holdmenutime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).illumenu" ><strong>PLAYERTASKCONTROLLER.illumenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).lasttaskcount" ><strong>PLAYERTASKCONTROLLER.lasttaskcount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).lid" ><strong>PLAYERTASKCONTROLLER.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).locale" ><strong>PLAYERTASKCONTROLLER.locale</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).menuitemlimit" ><strong>PLAYERTASKCONTROLLER.menuitemlimit</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).noflaresmokemenu" ><strong>PLAYERTASKCONTROLLER.noflaresmokemenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).precisionbombing" ><strong>PLAYERTASKCONTROLLER.precisionbombing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).repeatonfailed" ><strong>PLAYERTASKCONTROLLER.repeatonfailed</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).taskinfomenu" ><strong>PLAYERTASKCONTROLLER.taskinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).usecluster" ><strong>PLAYERTASKCONTROLLER.usecluster</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).verbose" ><strong>PLAYERTASKCONTROLLER.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).version" ><strong>PLAYERTASKCONTROLLER.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddAcceptZone" ><strong>PLAYERTASKCONTROLLER:AddAcceptZone(AcceptZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add an accept zone to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddAcceptZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>AcceptZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the accept zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddAcceptZoneSet" ><strong>PLAYERTASKCONTROLLER:AddAcceptZoneSet(AcceptZoneSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add an accept SET_ZONE to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddAcceptZoneSet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>
|
|
<strong><strong>AcceptZoneSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a SET_ZONE to the accept zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddAgent" ><strong>PLAYERTASKCONTROLLER:AddAgent(Recce)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add agent group to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddAgent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><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>Recce</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group of agents. Can also be an <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddAgentSet" ><strong>PLAYERTASKCONTROLLER:AddAgentSet(RecceSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add agent SET_GROUP to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddAgentSet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>RecceSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>SET_GROUP of agents.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddConflictZone" ><strong>PLAYERTASKCONTROLLER:AddConflictZone(ConflictZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a conflict zone to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddConflictZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>ConflictZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the conflict zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddConflictZoneSet" ><strong>PLAYERTASKCONTROLLER:AddConflictZoneSet(ConflictZoneSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a conflict SET_ZONE to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddConflictZoneSet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>
|
|
<strong><strong>ConflictZoneSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the conflict zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddCorridorZone" ><strong>PLAYERTASKCONTROLLER:AddCorridorZone(CorridorZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add an corridor zone to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddCorridorZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>CorridorZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the corridor zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddCorridorZoneSet" ><strong>PLAYERTASKCONTROLLER:AddCorridorZoneSet(CorridorZoneSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add an corridor SET_ZONE to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddCorridorZoneSet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>
|
|
<strong><strong>CorridorZoneSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a SET_ZONE to the corridor zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddPlayerTaskToQueue" ><strong>PLAYERTASKCONTROLLER:AddPlayerTaskToQueue(PlayerTask, Silent, TaskFilter)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a PLAYERTASK object to the list of (open) tasks</p>
|
|
|
|
<div id= "#Functions##AddPlayerTaskToQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>PlayerTask</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, make no "has new task" announcement</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>TaskFilter</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, apply the white/black-list task filters here, also</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>Example to create a PLAYERTASK of type CTLD and give Players 10 minutes to complete:
|
|
|
|
local newtask = PLAYERTASK:New(AUFTRAG.Type.CTLD,ZONE:Find("Unloading"),false,0,"Combat Transport")
|
|
newtask.Time0 = timer.getAbsTime() -- inject a timestamp for T0
|
|
newtask:AddFreetext("Transport crates to the drop zone and build a vehicle in the next 10 minutes!")
|
|
|
|
-- add a condition for failure - fail after 10 minutes
|
|
newtask:AddConditionFailure(
|
|
function()
|
|
local Time = timer.getAbsTime()
|
|
if Time - newtask.Time0 > 600 then
|
|
return true
|
|
end
|
|
return false
|
|
end
|
|
)
|
|
|
|
taskmanager:AddPlayerTaskToQueue(PlayerTask) </code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddPrecisionBombingOpsGroup" ><strong>PLAYERTASKCONTROLLER:AddPrecisionBombingOpsGroup(FlightGroup, LaserCode, HoldingPoint, Alt, Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Convenience function - add done or ground allowing precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
|
|
<div id= "#Functions##AddPrecisionBombingOpsGroup" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>
|
|
<strong><strong>FlightGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
|
Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - <strong>Note</strong> might not find an LOS spot or get lost on the way. Cannot island-hop.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>LaserCode</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The lasercode to be used. Defaults to 1688.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>HoldingPoint</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Alt</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddRejectZone" ><strong>PLAYERTASKCONTROLLER:AddRejectZone(RejectZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a reject zone to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddRejectZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>RejectZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the reject zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddRejectZoneSet" ><strong>PLAYERTASKCONTROLLER:AddRejectZoneSet(RejectZoneSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a reject SET_ZONE to INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##AddRejectZoneSet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>
|
|
<strong><strong>RejectZoneSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Add a zone to the reject zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddTarget" ><strong>PLAYERTASKCONTROLLER:AddTarget(Target)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Add a target object to the target queue</p>
|
|
|
|
<div id= "#Functions##AddTarget" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><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.Positionable.html##(POSITIONABLE)">Wrapper.Positionable#POSITIONABLE</a>
|
|
<strong><strong>Target</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The target GROUP, SET_GROUP, UNIT, SET_UNIT, STATIC, SET_STATIC, AIRBASE, ZONE or COORDINATE.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CanJoinTask" ><strong>PLAYERTASKCONTROLLER:CanJoinTask(Task, Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Override this function in order to implement custom logic if a player can join a task or not.</p>
|
|
|
|
<div id= "#Functions##CanJoinTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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>Outcome True if player can join the task, false if not</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CancelTask" ><strong>PLAYERTASKCONTROLLER:CancelTask(Task, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Manually cancel a specific task</p>
|
|
|
|
<div id= "#Functions##CancelTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The task to be cancelled.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true suppress message output.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).ClearPersistedData" ><strong>PLAYERTASKCONTROLLER:ClearPersistedData()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Clear persisted data on disk.</p>
|
|
|
|
<div id= "#Functions##ClearPersistedData" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).DisableBuddyLasing" ><strong>PLAYERTASKCONTROLLER:DisableBuddyLasing()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc) with player units lasing.</p>
|
|
|
|
<div id= "#Functions##DisableBuddyLasing" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).DisablePrecisionBombing" ><strong>PLAYERTASKCONTROLLER:DisablePrecisionBombing(FlightGroup, LaserCode)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Disable precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
|
|
<div id= "#Functions##DisablePrecisionBombing" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>FlightGroup</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>LaserCode</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).DisableScoring" ><strong>PLAYERTASKCONTROLLER:DisableScoring()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove the SCORING object from this taskcontroller</p>
|
|
|
|
<div id= "#Functions##DisableScoring" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).DisableTaskInfoMenu" ><strong>PLAYERTASKCONTROLLER:DisableTaskInfoMenu()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Disable extra menu to show task detail information before joining</p>
|
|
|
|
<div id= "#Functions##DisableTaskInfoMenu" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).DisableTaskPersistance" ><strong>PLAYERTASKCONTROLLER:DisableTaskPersistance()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Disable Task persistance (for specific gound target tasks)</p>
|
|
|
|
<div id= "#Functions##DisableTaskPersistance" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnableBuddyLasing" ><strong>PLAYERTASKCONTROLLER:EnableBuddyLasing(Recce)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc) with player units lasing.</p>
|
|
|
|
<div id= "#Functions##EnableBuddyLasing" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerRecce.html##(PLAYERRECCE)">Ops.PlayerRecce#PLAYERRECCE</a>
|
|
<strong><strong>Recce</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The PLAYERRECCE object governing the lasing players.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnableMarkerOps" ><strong>PLAYERTASKCONTROLLER:EnableMarkerOps(Tag)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Allow addition of targets with user F10 map markers.</p>
|
|
|
|
<div id= "#Functions##EnableMarkerOps" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Tag</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The tagname to use to identify commands, defaults to "TASK"</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>Enable the function like so:
|
|
mycontroller:EnableMarkerOps("TASK")
|
|
Then as a player in a client slot, you can add a map marker on the F10 map. Next edit the text
|
|
in the marker to make it identifiable, e.g
|
|
|
|
TASK Name=Tanks Sochi, Text=Destroy tank group located near Sochi!
|
|
|
|
Where **TASK** is the tag that tells the controller this mark is a target location (must).
|
|
**Name=** ended by a comma **,** tells the controller the supposed menu entry name (optional). No extra spaces! End with a comma!
|
|
**Text=** tells the controller the supposed free text task description (optional, only taken if **Name=** is present first). No extra spaces!</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnablePrecisionBombing" ><strong>PLAYERTASKCONTROLLER:EnablePrecisionBombing(FlightGroup, LaserCode, HoldingPoint, Alt, Speed, MaxTravelDist)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Allow precision laser-guided bombing on statics and "high-value" ground units (MBT etc)</p>
|
|
|
|
<div id= "#Functions##EnablePrecisionBombing" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>
|
|
<strong><strong>FlightGroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The FlightGroup (e.g. drone) to be used for lasing (one unit in one group only).
|
|
Can optionally be handed as Ops.ArmyGroup#ARMYGROUP - <strong>Note</strong> might not find an LOS spot or get lost on the way. Cannot island-hop.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>LaserCode</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The lasercode to be used. Defaults to 1688.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>HoldingPoint</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Point where the drone should initially circle. If not set, defaults to BullsEye of the coalition.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Alt</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Altitude in feet. Only applies if using a FLIGHTGROUP object! Defaults to 10000.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Speed in knots. Only applies if using a FLIGHTGROUP object! Defaults to 120.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>MaxTravelDist</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Max distance to travel to traget. Only applies if using a FLIGHTGROUP object! Defaults to 100 NM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Set up precision bombing, FlightGroup as lasing unit
|
|
local FlightGroup = FLIGHTGROUP:New("LasingUnit")
|
|
FlightGroup:Activate()
|
|
taskmanager:EnablePrecisionBombing(FlightGroup,1688)
|
|
|
|
-- Alternatively, set up precision bombing, ArmyGroup as lasing unit
|
|
local ArmyGroup = ARMYGROUP:New("LasingUnit")
|
|
ArmyGroup:SetDefaultROE(ENUMS.ROE.WeaponHold)
|
|
ArmyGroup:SetDefaultInvisible(true)
|
|
ArmyGroup:Activate()
|
|
taskmanager:EnablePrecisionBombing(ArmyGroup,1688)
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnableScoring" ><strong>PLAYERTASKCONTROLLER:EnableScoring(Scoring)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set or create a SCORING object for this taskcontroller</p>
|
|
|
|
<div id= "#Functions##EnableScoring" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Functional.Scoring.html##(SCORING)">Functional.Scoring#SCORING</a>
|
|
<strong><strong>Scoring</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) the Scoring object</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnableTaskInfoMenu" ><strong>PLAYERTASKCONTROLLER:EnableTaskInfoMenu()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Enable extra menu to show task detail information before joining</p>
|
|
|
|
<div id= "#Functions##EnableTaskInfoMenu" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).EnableTaskPersistance" ><strong>PLAYERTASKCONTROLLER:EnableTaskPersistance(Path, Filename, KgsOfTNT)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Enable Task persistance (for specific gound target tasks)</p>
|
|
|
|
<div id= "#Functions##EnableTaskPersistance" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where to save the task data</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Filename</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>File name under which to save the task data</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>KgsOfTNT</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explosives kgs used to remove scenery for persistence, defaults to 300</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).New" ><strong>PLAYERTASKCONTROLLER:New(Name, Coalition, Type, ClientFilter)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create and run a new TASKCONTROLLER instance.</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>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of this controller</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of this controller, e.g. coalition.side.BLUE</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Type</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of the tasks controlled, defaults to PLAYERTASKCONTROLLER.Type.A2G</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ClientFilter</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Additional prefix filter for the SET_CLIENT. Can be handed as <a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a> also.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnAfterPlayerAbortedTask" ><strong>PLAYERTASKCONTROLLER:OnAfterPlayerAbortedTask(From, Event, To, Group, Client, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "PlayerAbortedTask" event.</p>
|
|
|
|
|
|
<p>Player aborted a task.</p>
|
|
|
|
<div id= "#Functions##OnAfterPlayerAbortedTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The player group object</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The player client object</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterPlayerJoinedTask" ><strong>PLAYERTASKCONTROLLER:OnAfterPlayerJoinedTask(From, Event, To, Group, Client, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "PlayerJoinedTask" event.</p>
|
|
|
|
|
|
<p>Player joined a task.</p>
|
|
|
|
<div id= "#Functions##OnAfterPlayerJoinedTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The player group object</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The player client object</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskAdded" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskAdded(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskAdded" event.</p>
|
|
|
|
|
|
<p>Task has been added.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskCancelled" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskCancelled(From, Event, To, Task, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskCancelled" event.</p>
|
|
|
|
|
|
<p>Task has been cancelled.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskCancelled" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true suppress message output.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnAfterTaskDone" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskDone(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskDone" event.</p>
|
|
|
|
|
|
<p>Task is done.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskFailed" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskFailed(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskFailed" event.</p>
|
|
|
|
|
|
<p>Task has failed.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskProgress" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskProgress(From, Event, To, Task, TargetCount)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskProgress" event.</p>
|
|
|
|
|
|
<p>Task target count has been reduced.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskProgress" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The current Task.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>TargetCount</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Targets left over</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnAfterTaskRepeatOnFailed" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskRepeatOnFailed(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskRepeatOnFailed" event.</p>
|
|
|
|
|
|
<p>Task has failed and will be repeated.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskRepeatOnFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskSuccess" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskSuccess(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskSuccess" event.</p>
|
|
|
|
|
|
<p>Task has been a success.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskTargetFlared" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskTargetFlared(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskTargetFlared" event.</p>
|
|
|
|
|
|
<p>Task flared.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskTargetFlared" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskTargetIlluminated" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskTargetIlluminated(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskTargetIlluminated" event.</p>
|
|
|
|
|
|
<p>Task illuminated.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskTargetIlluminated" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).OnAfterTaskTargetSmoked" ><strong>PLAYERTASKCONTROLLER:OnAfterTaskTargetSmoked(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On After "TaskTargetSmoked" event.</p>
|
|
|
|
|
|
<p>Task smoked.</p>
|
|
|
|
<div id= "#Functions##OnAfterTaskTargetSmoked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>From state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER).RemoveAcceptZone" ><strong>PLAYERTASKCONTROLLER:RemoveAcceptZone(AcceptZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove an accept zone from INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##RemoveAcceptZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>AcceptZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Remove this zone from the accept zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).RemoveConflictZone" ><strong>PLAYERTASKCONTROLLER:RemoveConflictZone(ConflictZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove a conflict zone from INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##RemoveConflictZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>ConflictZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Remove this zone from the conflict zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).RemoveCorridorZone" ><strong>PLAYERTASKCONTROLLER:RemoveCorridorZone(CorridorZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove an corridor zone from INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##RemoveCorridorZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>CorridorZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Remove this zone from the corridor zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).RemoveRejectZone" ><strong>PLAYERTASKCONTROLLER:RemoveRejectZone(RejectZone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Remove a reject zone from INTEL detection.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##RemoveRejectZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>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>RejectZone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Remove this zone from the reject zone 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetAllowFlashDirection" ><strong>PLAYERTASKCONTROLLER:SetAllowFlashDirection(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set flash directions option for player (player based info)</p>
|
|
|
|
<div id= "#Functions##SetAllowFlashDirection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set to <code>true</code> to switch on and <code>false</code> to switch off. Default is OFF.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetBriefingDuration" ><strong>PLAYERTASKCONTROLLER:SetBriefingDuration(Seconds)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set how long the briefing is shown on screen.</p>
|
|
|
|
<div id= "#Functions##SetBriefingDuration" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Seconds</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Duration in seconds. Defaults to 30 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetCallSignOptions" ><strong>PLAYERTASKCONTROLLER:SetCallSignOptions(ShortCallsign, Keepnumber, CallsignTranslations, CallsignCustomFunc, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set callsign options for TTS output.</p>
|
|
|
|
|
|
<p>See <a href="Wrapper.Group.html##(GROUP).GetCustomCallSign">Wrapper.Group#GROUP.GetCustomCallSign</a>() on how to set customized callsigns.</p>
|
|
|
|
<div id= "#Functions##SetCallSignOptions" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>ShortCallsign</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, only call out the major flight number</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Keepnumber</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, keep the <strong>customized callsign</strong> in the #GROUP name for players as-is, no amendments or numbers.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>CallsignTranslations</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Table to translate between DCS standard callsigns and bespoke ones. Does not apply if using customized
|
|
callsigns from playername or group name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(func)">#func</a>
|
|
<strong><strong>CallsignCustomFunc</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) For player names only(!). If given, this function will return the callsign. Needs to take the groupname and the playername as first two arguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(arg)">#arg</a>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Comma separated arguments to add to the custom function call after groupname and playername.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetClusterRadius" ><strong>PLAYERTASKCONTROLLER:SetClusterRadius(Radius)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set the cluster radius if you want to use target clusters rather than single group detection.</p>
|
|
|
|
|
|
<p>Note that for a controller type A2A target clustering is on by default. Also remember that the diameter of the resulting zone is double the radius.</p>
|
|
|
|
<div id= "#Functions##SetClusterRadius" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Radius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Target cluster radius in kilometers. Default is 0.5km.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetCorridorZoneFloorAndCeiling" ><strong>PLAYERTASKCONTROLLER:SetCorridorZoneFloorAndCeiling(Floor, Ceiling)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function to set corridor zone floor and ceiling in FEET.</p>
|
|
|
|
<div id= "#Functions##SetCorridorZoneFloorAndCeiling" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Floor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Floor altitude ASL in feet.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Ceiling</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ceiling altitude ASL in feet.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetCorridorZoneFloorAndCeilingMeters" ><strong>PLAYERTASKCONTROLLER:SetCorridorZoneFloorAndCeilingMeters(Floor, Ceiling)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function to set corridor zone floor and ceiling in METERS.</p>
|
|
|
|
<div id= "#Functions##SetCorridorZoneFloorAndCeilingMeters" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Floor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Floor altitude ASL in meters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Ceiling</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ceiling altitude ASL in meters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetDisableIlluminateTask" ><strong>PLAYERTASKCONTROLLER:SetDisableIlluminateTask()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Do not show menu entries to illuminate targets.</p>
|
|
|
|
<div id= "#Functions##SetDisableIlluminateTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetDisableSmokeFlareTask" ><strong>PLAYERTASKCONTROLLER:SetDisableSmokeFlareTask()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Do not show menu entries to smoke or flare targets</p>
|
|
|
|
<div id= "#Functions##SetDisableSmokeFlareTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetDisableUseTypeNames" ><strong>PLAYERTASKCONTROLLER:SetDisableUseTypeNames()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Do not show target menu entries of type names for GROUND targets</p>
|
|
|
|
<div id= "#Functions##SetDisableUseTypeNames" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetEnableIlluminateTask" ><strong>PLAYERTASKCONTROLLER:SetEnableIlluminateTask()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Show menu entries to illuminate targets.</p>
|
|
|
|
|
|
<p>Needs smoke/flare enabled.</p>
|
|
|
|
<div id= "#Functions##SetEnableIlluminateTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetEnableSmokeFlareTask" ><strong>PLAYERTASKCONTROLLER:SetEnableSmokeFlareTask()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Show menu entries to smoke or flare targets (on by default!)</p>
|
|
|
|
<div id= "#Functions##SetEnableSmokeFlareTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetEnableUseTypeNames" ><strong>PLAYERTASKCONTROLLER:SetEnableUseTypeNames()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Show target menu entries of type names for GROUND targets (off by default!), e.g.</p>
|
|
|
|
|
|
<p>"Tank Group..."</p>
|
|
|
|
<div id= "#Functions##SetEnableUseTypeNames" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetInfoShowsCoordinate" ><strong>PLAYERTASKCONTROLLER:SetInfoShowsCoordinate(OnOff, LLDDM)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Show info text on screen with a coordinate info in any case (OFF by default)</p>
|
|
|
|
<div id= "#Functions##SetInfoShowsCoordinate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Switch on = true or off = false</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>LLDDM</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Show LLDDM = true or LLDMS = 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetLocale" ><strong>PLAYERTASKCONTROLLER:SetLocale(Locale)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set locale for localization.</p>
|
|
|
|
|
|
<p>Defaults to "en"</p>
|
|
|
|
<div id= "#Functions##SetLocale" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Locale</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The locale to use</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetMarkerDeleteable" ><strong>PLAYERTASKCONTROLLER:SetMarkerDeleteable()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Allow F10 markers to be deleted by pilots.</p>
|
|
|
|
|
|
<p>Note: Marker will auto-delete when the undelying task is done.</p>
|
|
|
|
<div id= "#Functions##SetMarkerDeleteable" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetMarkerReadOnly" ><strong>PLAYERTASKCONTROLLER:SetMarkerReadOnly()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Forbid F10 markers to be deleted by pilots.</p>
|
|
|
|
|
|
<p>Note: Marker will auto-delete when the undelying task is done.</p>
|
|
|
|
<div id= "#Functions##SetMarkerReadOnly" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetMenuName" ><strong>PLAYERTASKCONTROLLER:SetMenuName(Name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set the top menu name to a custom string.</p>
|
|
|
|
<div id= "#Functions##SetMenuName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The name to use as the top menu designation.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetMenuOptions" ><strong>PLAYERTASKCONTROLLER:SetMenuOptions(InfoMenu, ItemLimit, HoldTime)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set menu build fine-tuning options</p>
|
|
|
|
<div id= "#Functions##SetMenuOptions" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>InfoMenu</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code> this option will allow to show the Task Info-Menu also when a player has an active task.
|
|
Since the menu isn't refreshed if a player holds an active task, the info in there might be stale.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ItemLimit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of items per task type to show, default 5. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>HoldTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Minimum number of seconds between menu refreshes (called every 30 secs) if a player has <strong>no active task</strong>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetParentMenu" ><strong>PLAYERTASKCONTROLLER:SetParentMenu(Menu)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set the top menu to be a sub-menu of another MENU entry.</p>
|
|
|
|
<div id= "#Functions##SetParentMenu" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Menu.html##(MENU_MISSION)">Core.Menu#MENU_MISSION</a>
|
|
<strong><strong>Menu</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetSEADAttributes" ><strong>PLAYERTASKCONTROLLER:SetSEADAttributes(Attributes)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Change the list of attributes, which are considered on GROUP or SET_GROUP level of a target to create SEAD player tasks.</p>
|
|
|
|
<div id= "#Functions##SetSEADAttributes" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Attributes</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of attribute types considered to lead to a SEAD type player task.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>Default attribute types are: GROUP.Attribute.GROUND_SAM, GROUP.Attribute.GROUND_AAA, and GROUP.Attribute.GROUND_EWR.
|
|
If you want to e.g. exclude AAA, so target groups with this attribute are assigned CAS or BAI tasks, and not SEAD, use this function as follows:
|
|
|
|
`mycontroller:SetSEADAttributes({GROUP.Attribute.GROUND_SAM, GROUP.Attribute.GROUND_EWR})`
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetSRS" ><strong>PLAYERTASKCONTROLLER:SetSRS(Frequency, Modulation, PathToSRS, Gender, Culture, Port, Voice, Volume, PathToGoogleKey, AccessKey, Coordinate, Backend)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set SRS TTS details - see <a href="Sound.SRS.html">Sound.SRS</a> for details.<code>SetSRS()</code> will try to use as many attributes configured with <a href="Sound.SRS.html##(MSRS).LoadConfigFile">Sound.SRS#MSRS.LoadConfigFile</a>() as possible.</p>
|
|
|
|
<div id= "#Functions##SetSRS" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Frequency</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Modulation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>PathToSRS</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Defaults to "C:\Program Files\DCS-SimpleRadio-Standalone\ExternalAudio"</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Gender</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Defaults to "male"</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Culture</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Defaults to "en-US"</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Port</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Defaults to 5002</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Voice</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Use a specifc voice with the <a href="Sound.SRS.html##(SetVoice)">Sound.SRS#SetVoice</a> function, e.g, <code>:SetVoice("Microsoft Hedda Desktop")</code>.
|
|
Note that this must be installed on your windows system. Can also be Google voice types, if you are using Google TTS.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Volume</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Volume - between 0.0 (silent) and 1.0 (loudest)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>PathToGoogleKey</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Path to your google key if you want to use google TTS; if you use a config file for MSRS, hand in nil here.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>AccessKey</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Your Google API access key. This is necessary if DCS-gRPC is used as backend; if you use a config file for MSRS, hand in nil here.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>Coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coordinate from which the controller radio is sending</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Backend</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) MSRS Backend to be used, can be MSRS.Backend.SRSEXE or MSRS.Backend.GRPC; if you use a config file for MSRS, hand in nil here.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetSRSBroadcast" ><strong>PLAYERTASKCONTROLLER:SetSRSBroadcast(Frequency, Modulation)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set SRS Broadcast - for the announcement to joining players which SRS frequency, modulation to use.</p>
|
|
|
|
|
|
<p>Use in case you want to set this differently to the standard SRS.</p>
|
|
|
|
<div id= "#Functions##SetSRSBroadcast" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Frequency</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Frequency to be used. Can also be given as a table of multiple frequencies, e.g. 271 or {127,251}. There needs to be exactly the same number of modulations!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Modulation</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Modulation to be used. Can also be given as a table of multiple modulations, e.g. radio.modulation.AM or {radio.modulation.FM,radio.modulation.AM}. There needs to be exactly the same number of frequencies!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetShowRadioInfoMenu" ><strong>PLAYERTASKCONTROLLER:SetShowRadioInfoMenu(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set to show a menu entry to retrieve the radio frequencies used.</p>
|
|
|
|
<div id= "#Functions##SetShowRadioInfoMenu" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set to <code>true</code> to switch on and <code>false</code> to switch off. Default is OFF.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetTargetRadius" ><strong>PLAYERTASKCONTROLLER:SetTargetRadius(Radius)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set target radius.</p>
|
|
|
|
|
|
<p>Determines the zone radius to distinguish CAS from BAI tasks and to find enemies if the TARGET object is a COORDINATE.</p>
|
|
|
|
<div id= "#Functions##SetTargetRadius" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Radius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Radius to use in meters. Defaults to 500 meters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetTaskBlackList" ><strong>PLAYERTASKCONTROLLER:SetTaskBlackList(BlackList)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set up a (negative) blacklist of forbidden task types.</p>
|
|
|
|
|
|
<p>These types will <strong>not</strong> be generated.</p>
|
|
|
|
<div id= "#Functions##SetTaskBlackList" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>BlackList</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of task types that cannot be generated. Use to restrict available 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>Currently, the following task types will be generated, if detection has been set up:
|
|
A2A - AUFTRAG.Type.INTERCEPT
|
|
A2S - AUFTRAG.Type.ANTISHIP
|
|
A2G - AUFTRAG.Type.CAS, AUFTRAG.Type.BAI, AUFTRAG.Type.SEAD, AUFTRAG.Type.BOMBING, AUFTRAG.Type.PRECISIONBOMBING, AUFTRAG.Type.BOMBRUNWAY
|
|
A2GS - A2G + A2S
|
|
If you don't want SEAD tasks generated, use as follows where "mycontroller" is your PLAYERTASKCONTROLLER object:
|
|
|
|
`mycontroller:SetTaskBlackList({AUFTRAG.Type.SEAD})`
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetTaskRepetition" ><strong>PLAYERTASKCONTROLLER:SetTaskRepetition(OnOff, Repeats)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set repetition options for tasks.</p>
|
|
|
|
<div id= "#Functions##SetTaskRepetition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set to <code>true</code> to switch on and <code>false</code> to switch off (defaults to true)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Repeats</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of repeats (defaults to 5)</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>`taskmanager:SetTaskRepetition(true, 5)`</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetTaskWhiteList" ><strong>PLAYERTASKCONTROLLER:SetTaskWhiteList(WhiteList)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set up a (positive) whitelist of allowed task types.</p>
|
|
|
|
|
|
<p>Only these types will be generated.</p>
|
|
|
|
<div id= "#Functions##SetTaskWhiteList" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>WhiteList</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of task types that can be generated. Use to restrict available 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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>Currently, the following task types will be generated, if detection has been set up:
|
|
A2A - AUFTRAG.Type.INTERCEPT
|
|
A2S - AUFTRAG.Type.ANTISHIP
|
|
A2G - AUFTRAG.Type.CAS, AUFTRAG.Type.BAI, AUFTRAG.Type.SEAD, AUFTRAG.Type.BOMBING, AUFTRAG.Type.PRECISIONBOMBING, AUFTRAG.Type.BOMBRUNWAY
|
|
A2GS - A2G + A2S
|
|
If you don't want SEAD tasks generated, use as follows where "mycontroller" is your PLAYERTASKCONTROLLER object:
|
|
|
|
`mycontroller:SetTaskWhiteList({AUFTRAG.Type.CAS, AUFTRAG.Type.BAI, AUFTRAG.Type.BOMBING, AUFTRAG.Type.BOMBRUNWAY})`
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetTransmitOnlyWithPlayers" ><strong>PLAYERTASKCONTROLLER:SetTransmitOnlyWithPlayers(Switch)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] For SRS - Switch to only transmit if there are players on the server.</p>
|
|
|
|
<div id= "#Functions##SetTransmitOnlyWithPlayers" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Switch</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, only send SRS if there are alive Players.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetupIntel" ><strong>PLAYERTASKCONTROLLER:SetupIntel(RecceName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set up INTEL detection</p>
|
|
|
|
<div id= "#Functions##SetupIntel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>RecceName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>This name will be used to build a detection group set. All groups with this string somewhere in their group name will be added as Recce.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SuppressScreenOutput" ><strong>PLAYERTASKCONTROLLER:SuppressScreenOutput(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Switch screen output.</p>
|
|
|
|
<div id= "#Functions##SuppressScreenOutput" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p> Switch screen output off (true) or on (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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SwitchDetectStatics" ><strong>PLAYERTASKCONTROLLER:SwitchDetectStatics(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Set up detection of STATIC objects.</p>
|
|
|
|
|
|
<p>You need to set up detection with <a href="##(PLAYERTASKCONTROLLER).SetupIntel">PLAYERTASKCONTROLLER.SetupIntel</a>() <strong>before</strong> using this.</p>
|
|
|
|
<div id= "#Functions##SwitchDetectStatics" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set to <code>true</code>for on and <code>false</code>for off.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SwitchMagenticAngles" ><strong>PLAYERTASKCONTROLLER:SwitchMagenticAngles(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Switch showing additional magnetic angles</p>
|
|
|
|
<div id= "#Functions##SwitchMagenticAngles" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, set to on (default), if nil or false, set to off</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SwitchUseGroupNames" ><strong>PLAYERTASKCONTROLLER:SwitchUseGroupNames(OnOff)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[User] Switch usage of target names for menu entries on or off</p>
|
|
|
|
<div id= "#Functions##SwitchUseGroupNames" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>OnOff</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, set to on (default), if nil or false, set to off</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._AbortTask" ><strong>PLAYERTASKCONTROLLER:_AbortTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Abort Task</p>
|
|
|
|
<div id= "#Functions##_AbortTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._ActiveTaskInfo" ><strong>PLAYERTASKCONTROLLER:_ActiveTaskInfo(Task, Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Show active task info</p>
|
|
|
|
<div id= "#Functions##_ActiveTaskInfo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._AddPersistenceData" ><strong>PLAYERTASKCONTROLLER:_AddPersistenceData(Task)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##_AddPersistenceData" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(PLAYERTASK)">#PLAYERTASK</a>
|
|
<strong><strong>Task</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="#(PLAYERTASKCONTROLLER)._AddTask" ><strong>PLAYERTASKCONTROLLER:_AddTask(Target)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Add a task to the task queue</p>
|
|
|
|
<div id= "#Functions##_AddTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.Target.html##(TARGET)">Ops.Target#TARGET</a>
|
|
<strong><strong>Target</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CalcGroupFuturePosition" ><strong>PLAYERTASKCONTROLLER:_CalcGroupFuturePosition(group, seconds)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Calculate group future position after given seconds.</p>
|
|
|
|
<div id= "#Functions##_CalcGroupFuturePosition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group to calculate for.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>seconds</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Time interval in seconds. Default is <code>self.prediction</code>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Calculated future position of the cluster.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckPlayerHasTask" ><strong>PLAYERTASKCONTROLLER:_CheckPlayerHasTask(PlayerName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check task queue for a specific player name</p>
|
|
|
|
<div id= "#Functions##_CheckPlayerHasTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>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>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>outcome</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckPrecisionTasks" ><strong>PLAYERTASKCONTROLLER:_CheckPrecisionTasks()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check precision task queue</p>
|
|
|
|
<div id= "#Functions##_CheckPrecisionTasks" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckTargetQueue" ><strong>PLAYERTASKCONTROLLER:_CheckTargetQueue()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check target queue</p>
|
|
|
|
<div id= "#Functions##_CheckTargetQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckTaskQueue" ><strong>PLAYERTASKCONTROLLER:_CheckTaskQueue()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check task queue</p>
|
|
|
|
<div id= "#Functions##_CheckTaskQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckTaskTypeAllowed" ><strong>PLAYERTASKCONTROLLER:_CheckTaskTypeAllowed(Type)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check for allowed task type, if there is a (positive) whitelist</p>
|
|
|
|
<div id= "#Functions##_CheckTaskTypeAllowed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Type</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>Outcome</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CheckTaskTypeDisallowed" ><strong>PLAYERTASKCONTROLLER:_CheckTaskTypeDisallowed(Type)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Check for allowed task type, if there is a (negative) blacklist</p>
|
|
|
|
<div id= "#Functions##_CheckTaskTypeDisallowed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Type</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>Outcome</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CreateActiveTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER:_CreateActiveTaskMenuTemplate()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] _CreateActiveTaskMenuTemplate</p>
|
|
|
|
<div id= "#Functions##_CreateActiveTaskMenuTemplate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._CreateJoinMenuTemplate" ><strong>PLAYERTASKCONTROLLER:_CreateJoinMenuTemplate()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] _CreateJoinMenuTemplate</p>
|
|
|
|
<div id= "#Functions##_CreateJoinMenuTemplate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._EventHandler" ><strong>PLAYERTASKCONTROLLER:_EventHandler(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Event handling</p>
|
|
|
|
<div id= "#Functions##_EventHandler" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._FindLasingDroneForTaskID" ><strong>PLAYERTASKCONTROLLER:_FindLasingDroneForTaskID(ID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Find matching drone for precision bombing task, if any is assigned.</p>
|
|
|
|
<div id= "#Functions##_FindLasingDroneForTaskID" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>ID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Task ID to look 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><a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Drone</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._FlareTask" ><strong>PLAYERTASKCONTROLLER:_FlareTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Flare task location</p>
|
|
|
|
<div id= "#Functions##_FlareTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._FlashInfo" ><strong>PLAYERTASKCONTROLLER:_FlashInfo()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Flashing directional info for a client</p>
|
|
|
|
<div id= "#Functions##_FlashInfo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._GetAvailableTaskTypes" ><strong>PLAYERTASKCONTROLLER:_GetAvailableTaskTypes()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Get task types for the menu</p>
|
|
|
|
<div id= "#Functions##_GetAvailableTaskTypes" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>TaskTypes</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._GetPlayerName" ><strong>PLAYERTASKCONTROLLER:_GetPlayerName(Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Get player name</p>
|
|
|
|
<div id= "#Functions##_GetPlayerName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><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>Client</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>playername</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>ttsplayername</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._GetTasksPerType" ><strong>PLAYERTASKCONTROLLER:_GetTasksPerType()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Get task per type for the menu</p>
|
|
|
|
<div id= "#Functions##_GetTasksPerType" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>TasksPerTypes</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._GetTextForSpeech" ><strong>PLAYERTASKCONTROLLER:_GetTextForSpeech(text)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Get text for text-to-speech.</p>
|
|
|
|
|
|
<p>Numbers are spaced out, e.g. "Heading 180" becomes "Heading 1 8 0 ".</p>
|
|
|
|
<div id= "#Functions##_GetTextForSpeech" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>text</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Original text.</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>Spoken text.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._IlluminateTask" ><strong>PLAYERTASKCONTROLLER:_IlluminateTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Illuminate task location</p>
|
|
|
|
<div id= "#Functions##_IlluminateTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._InitLocalization" ><strong>PLAYERTASKCONTROLLER:_InitLocalization()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Init localization</p>
|
|
|
|
<div id= "#Functions##_InitLocalization" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._IsAttributeSead" ><strong>PLAYERTASKCONTROLLER:_IsAttributeSead(Attribute)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Function the check against SeadAttributes</p>
|
|
|
|
<div id= "#Functions##_IsAttributeSead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Attribute</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>IsSead</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._JoinTask" ><strong>PLAYERTASKCONTROLLER:_JoinTask(Task, Force, Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Join a player to a task</p>
|
|
|
|
<div id= "#Functions##_JoinTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Force</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Assign task even if client already has one</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._LoadTasksPersisted" ><strong>PLAYERTASKCONTROLLER:_LoadTasksPersisted()</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##_LoadTasksPersisted" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._MarkTask" ><strong>PLAYERTASKCONTROLLER:_MarkTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Mark task on F10 map</p>
|
|
|
|
<div id= "#Functions##_MarkTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._RemoveMenuEntriesForTask" ><strong>PLAYERTASKCONTROLLER:_RemoveMenuEntriesForTask(Task, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] _RemoveMenuEntriesForTask</p>
|
|
|
|
<div id= "#Functions##_RemoveMenuEntriesForTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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="##(PLAYERTASK)">#PLAYERTASK</a>
|
|
<strong><strong>Task</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="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._SaveTasksPersisted" ><strong>PLAYERTASKCONTROLLER:_SaveTasksPersisted()</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##_SaveTasksPersisted" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._SendMessageToClients" ><strong>PLAYERTASKCONTROLLER:_SendMessageToClients(Text, Seconds)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Send message to SET_CLIENT of players</p>
|
|
|
|
<div id= "#Functions##_SendMessageToClients" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Text</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the text to be send</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Seconds</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) Seconds to show, default 10</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._ShowRadioInfo" ><strong>PLAYERTASKCONTROLLER:_ShowRadioInfo(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##_ShowRadioInfo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>Group</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>Client</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="#(PLAYERTASKCONTROLLER)._SmokeTask" ><strong>PLAYERTASKCONTROLLER:_SmokeTask(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Smoke task location</p>
|
|
|
|
<div id= "#Functions##_SmokeTask" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._SwitchFlashing" ><strong>PLAYERTASKCONTROLLER:_SwitchFlashing(Group, Client)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] Switch flashing info for a client</p>
|
|
|
|
<div id= "#Functions##_SwitchFlashing" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>Group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._SwitchMenuForClient" ><strong>PLAYERTASKCONTROLLER:_SwitchMenuForClient(Client, MenuType, Delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] _SwitchMenuForClient</p>
|
|
|
|
<div id= "#Functions##_SwitchMenuForClient" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Client.html##(CLIENT)">Wrapper.Client#CLIENT</a>
|
|
<strong><strong>Client</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The client</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>MenuType</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>Delay</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._UpdateJoinMenuTemplate" ><strong>PLAYERTASKCONTROLLER:_UpdateJoinMenuTemplate()</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<p> TODO - New Menu Manager
|
|
- [Internal] _UpdateJoinMenuTemplate
|
|
@param #PLAYERTASKCONTROLLER self
|
|
@return #PLAYERTASKCONTROLLER self</p>
|
|
|
|
<div id= "#Functions##_UpdateJoinMenuTemplate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._UpdateTargetsAlive" ><strong>PLAYERTASKCONTROLLER:_UpdateTargetsAlive(Task, TargetsLeft)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##_UpdateTargetsAlive" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Ops.PlayerTask.html##(PLASERTASK)">Ops.PlayerTask#PLASERTASK</a>
|
|
<strong><strong>Task</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>TargetsLeft</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="#(PLAYERTASKCONTROLLER).onafterStart" ><strong>PLAYERTASKCONTROLLER:onafterStart(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after start call</p>
|
|
|
|
<div id= "#Functions##onafterStart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterStatus" ><strong>PLAYERTASKCONTROLLER:onafterStatus(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after Status call</p>
|
|
|
|
<div id= "#Functions##onafterStatus" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterStop" ><strong>PLAYERTASKCONTROLLER:onafterStop(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after Stop call</p>
|
|
|
|
<div id= "#Functions##onafterStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskAdded" ><strong>PLAYERTASKCONTROLLER:onafterTaskAdded(From, Event, To, Task, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task added</p>
|
|
|
|
<div id= "#Functions##onafterTaskAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskCancelled" ><strong>PLAYERTASKCONTROLLER:onafterTaskCancelled(From, Event, To, Task, Silent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task cancelled</p>
|
|
|
|
<div id= "#Functions##onafterTaskCancelled" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>Silent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, suppress message output on cancel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskDone" ><strong>PLAYERTASKCONTROLLER:onafterTaskDone(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task done</p>
|
|
|
|
<div id= "#Functions##onafterTaskDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskFailed" ><strong>PLAYERTASKCONTROLLER:onafterTaskFailed(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task failed</p>
|
|
|
|
<div id= "#Functions##onafterTaskFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskRepeatOnFailed" ><strong>PLAYERTASKCONTROLLER:onafterTaskRepeatOnFailed(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task failed, repeat planned</p>
|
|
|
|
<div id= "#Functions##onafterTaskRepeatOnFailed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).onafterTaskSuccess" ><strong>PLAYERTASKCONTROLLER:onafterTaskSuccess(From, Event, To, Task)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>[Internal] On after task success</p>
|
|
|
|
<div id= "#Functions##onafterTaskSuccess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>PLAYERTASKCONTROLLER</p>
|
|
</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>
|
|
<a href="Ops.PlayerTask.html##(PLAYERTASK)">Ops.PlayerTask#PLAYERTASK</a>
|
|
<strong><strong>Task</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="##(PLAYERTASKCONTROLLER)">#PLAYERTASKCONTROLLER</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).AccessKey" ><strong>PLAYERTASKCONTROLLER.AccessKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveClientSet" ><strong>PLAYERTASKCONTROLLER.ActiveClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveInfoMenu" ><strong>PLAYERTASKCONTROLLER.ActiveInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.ActiveTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTopMenu" ><strong>PLAYERTASKCONTROLLER.ActiveTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).AllowFlash" ><strong>PLAYERTASKCONTROLLER.AllowFlash</strong></a>
|
|
|
|
<p>Flashing directions for players allowed</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCFrequency" ><strong>PLAYERTASKCONTROLLER.BCFrequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCModulation" ><strong>PLAYERTASKCONTROLLER.BCModulation</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).BlackList" ><strong>PLAYERTASKCONTROLLER.BlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignCustomFunc" ><strong>PLAYERTASKCONTROLLER.CallsignCustomFunc</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignTranslations" ><strong>PLAYERTASKCONTROLLER.CallsignTranslations</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClassName" ><strong>PLAYERTASKCONTROLLER.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientFilter" ><strong>PLAYERTASKCONTROLLER.ClientFilter</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientSet" ><strong>PLAYERTASKCONTROLLER.ClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).ClusterRadius" ><strong>PLAYERTASKCONTROLLER.ClusterRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).Coalition" ><strong>PLAYERTASKCONTROLLER.Coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CoalitionName" ><strong>PLAYERTASKCONTROLLER.CoalitionName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).FlashPlayer" ><strong>PLAYERTASKCONTROLLER.FlashPlayer</strong></a>
|
|
|
|
<p>List of player who switched Flashing Direction Info on</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasCoordinate" ><strong>PLAYERTASKCONTROLLER.InfoHasCoordinate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasLLDDM" ><strong>PLAYERTASKCONTROLLER.InfoHasLLDDM</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InformationMenu" ><strong>PLAYERTASKCONTROLLER.InformationMenu</strong></a>
|
|
|
|
<p>Show Radio Info Menu</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).Intel" ><strong>PLAYERTASKCONTROLLER.Intel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).IsClientSet" ><strong>PLAYERTASKCONTROLLER.IsClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinInfoMenu" ><strong>PLAYERTASKCONTROLLER.JoinInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinMenu" ><strong>PLAYERTASKCONTROLLER.JoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.JoinTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTopMenu" ><strong>PLAYERTASKCONTROLLER.JoinTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).Keepnumber" ><strong>PLAYERTASKCONTROLLER.Keepnumber</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDrone" ><strong>PLAYERTASKCONTROLLER.LasingDrone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDroneSet" ><strong>PLAYERTASKCONTROLLER.LasingDroneSet</strong></a>
|
|
|
|
|
|
|
|
|
|
<p>self.PlayerMenu = {} -- #table</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.MarkerOps_Base.html##(MARKEROPS_BASE)">Core.MarkerOps_Base#MARKEROPS_BASE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerOps" ><strong>PLAYERTASKCONTROLLER.MarkerOps</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerReadOnly" ><strong>PLAYERTASKCONTROLLER.MarkerReadOnly</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuName" ><strong>PLAYERTASKCONTROLLER.MenuName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuNoTask" ><strong>PLAYERTASKCONTROLLER.MenuNoTask</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Menu.html##(MENU_MISSION)">Core.Menu#MENU_MISSION</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuParent" ><strong>PLAYERTASKCONTROLLER.MenuParent</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).Messages" ><strong>PLAYERTASKCONTROLLER.Messages</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Name" ><strong>PLAYERTASKCONTROLLER.Name</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).NoScreenOutput" ><strong>PLAYERTASKCONTROLLER.NoScreenOutput</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).PathToGoogleKey" ><strong>PLAYERTASKCONTROLLER.PathToGoogleKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerFlashMenu" ><strong>PLAYERTASKCONTROLLER.PlayerFlashMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerInfoMenu" ><strong>PLAYERTASKCONTROLLER.PlayerInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerJoinMenu" ><strong>PLAYERTASKCONTROLLER.PlayerJoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenu" ><strong>PLAYERTASKCONTROLLER.PlayerMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenuTag" ><strong>PLAYERTASKCONTROLLER.PlayerMenuTag</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerRecce.html##(PLAYERRECCE)">Ops.PlayerRecce#PLAYERRECCE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerRecce" ><strong>PLAYERTASKCONTROLLER.PlayerRecce</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PrecisionTasks" ><strong>PLAYERTASKCONTROLLER.PrecisionTasks</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).RecceSet" ><strong>PLAYERTASKCONTROLLER.RecceSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRS" ><strong>PLAYERTASKCONTROLLER.SRS</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> set up SRS </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRSQueue" ><strong>PLAYERTASKCONTROLLER.SRSQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).SceneryExplosivesAmount" ><strong>PLAYERTASKCONTROLLER.SceneryExplosivesAmount</strong></a>
|
|
|
|
<p>Kgs of TNT to explode scenery on task persistance loading</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(Scores)">#Scores</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scores" ><strong>PLAYERTASKCONTROLLER.Scores</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Functional.Scoring.html##(SCORING)">Functional.Scoring#SCORING</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scoring" ><strong>PLAYERTASKCONTROLLER.Scoring</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SeadAttributes" ><strong>PLAYERTASKCONTROLLER.SeadAttributes</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShortCallsign" ><strong>PLAYERTASKCONTROLLER.ShortCallsign</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShowMagnetic" ><strong>PLAYERTASKCONTROLLER.ShowMagnetic</strong></a>
|
|
|
|
<p>Also show magnetic angles</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetQueue" ><strong>PLAYERTASKCONTROLLER.TargetQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetRadius" ><strong>PLAYERTASKCONTROLLER.TargetRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskInfoDuration" ><strong>PLAYERTASKCONTROLLER.TaskInfoDuration</strong></a>
|
|
|
|
<p>How long to show the briefing info on the screen</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistance" ><strong>PLAYERTASKCONTROLLER.TaskPersistance</strong></a>
|
|
|
|
<p>Table for persistance data</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceFilename" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceFilename</strong></a>
|
|
|
|
<p>File name for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistancePath" ><strong>PLAYERTASKCONTROLLER.TaskPersistancePath</strong></a>
|
|
|
|
<p>File path for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceSwitch" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceSwitch</strong></a>
|
|
|
|
<p>Switch for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskQueue" ><strong>PLAYERTASKCONTROLLER.TaskQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPerPlayer" ><strong>PLAYERTASKCONTROLLER.TasksPerPlayer</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPersistable" ><strong>PLAYERTASKCONTROLLER.TasksPersistable</strong></a>
|
|
|
|
<p>List of persistable tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TransmitOnlyWithPlayers" ><strong>PLAYERTASKCONTROLLER.TransmitOnlyWithPlayers</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Type" ><strong>PLAYERTASKCONTROLLER.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseBlackList" ><strong>PLAYERTASKCONTROLLER.UseBlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseGroupNames" ><strong>PLAYERTASKCONTROLLER.UseGroupNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseSRS" ><strong>PLAYERTASKCONTROLLER.UseSRS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseTypeNames" ><strong>PLAYERTASKCONTROLLER.UseTypeNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseWhiteList" ><strong>PLAYERTASKCONTROLLER.UseWhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).WhiteList" ><strong>PLAYERTASKCONTROLLER.WhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).activehasinfomenu" ><strong>PLAYERTASKCONTROLLER.activehasinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).buddylasing" ><strong>PLAYERTASKCONTROLLER.buddylasing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).customcallsigns" ><strong>PLAYERTASKCONTROLLER.customcallsigns</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.TextAndSound.html##(TEXTANDSOUND)">Core.TextAndSound#TEXTANDSOUND</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).gettext" ><strong>PLAYERTASKCONTROLLER.gettext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).holdmenutime" ><strong>PLAYERTASKCONTROLLER.holdmenutime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).illumenu" ><strong>PLAYERTASKCONTROLLER.illumenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).lasttaskcount" ><strong>PLAYERTASKCONTROLLER.lasttaskcount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).lid" ><strong>PLAYERTASKCONTROLLER.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).locale" ><strong>PLAYERTASKCONTROLLER.locale</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).menuitemlimit" ><strong>PLAYERTASKCONTROLLER.menuitemlimit</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).noflaresmokemenu" ><strong>PLAYERTASKCONTROLLER.noflaresmokemenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).precisionbombing" ><strong>PLAYERTASKCONTROLLER.precisionbombing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).repeatonfailed" ><strong>PLAYERTASKCONTROLLER.repeatonfailed</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).taskinfomenu" ><strong>PLAYERTASKCONTROLLER.taskinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).usecluster" ><strong>PLAYERTASKCONTROLLER.usecluster</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).verbose" ><strong>PLAYERTASKCONTROLLER.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).version" ><strong>PLAYERTASKCONTROLLER.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddEndState" ><strong>PLAYERTASKCONTROLLER:AddEndState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds an End state.</p>
|
|
|
|
<div id= "#Functions##AddEndState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddProcess" ><strong>PLAYERTASKCONTROLLER:AddProcess(From, Event, Process, ReturnEvents)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the default <a href="##(FSM_PROCESS)">#FSM_PROCESS</a> template with key ProcessName providing the ProcessClass and the process object when it is assigned to a <a href="Wrapper.Controllable.html">Wrapper.Controllable</a> by the task.</p>
|
|
|
|
<div id= "#Functions##AddProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>
|
|
<strong><strong>Process</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>An sub-process FSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>ReturnEvents</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The SubFSM.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddScore" ><strong>PLAYERTASKCONTROLLER:AddScore(State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScore" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddScoreProcess" ><strong>PLAYERTASKCONTROLLER:AddScoreProcess(From, Event, State, ScoreText, Score)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Adds a score for the FSM_PROCESS to be achieved.</p>
|
|
|
|
<div id= "#Functions##AddScoreProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the From State of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the Event of the main process.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ScoreText</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a text describing the score that is given according the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Score</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>is a number providing the score of the status.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).AddTransition" ><strong>PLAYERTASKCONTROLLER:AddTransition(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a new transition rule to the FSM.</p>
|
|
|
|
|
|
<p>A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.</p>
|
|
|
|
<div id= "#Functions##AddTransition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Can contain a string indicating the From state or a table of strings containing multiple From states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>To</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetCurrentState" ><strong>PLAYERTASKCONTROLLER:GetCurrentState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</p>
|
|
|
|
<div id= "#Functions##GetCurrentState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetEndStates" ><strong>PLAYERTASKCONTROLLER:GetEndStates()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the End states.</p>
|
|
|
|
<div id= "#Functions##GetEndStates" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>End states.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetProcess" ><strong>PLAYERTASKCONTROLLER:GetProcess(From, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetProcesses" ><strong>PLAYERTASKCONTROLLER:GetProcesses()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the SubFSM rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetProcesses" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub processes.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetScores" ><strong>PLAYERTASKCONTROLLER:GetScores()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the scores defined.</p>
|
|
|
|
<div id= "#Functions##GetScores" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Scores.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetStartState" ><strong>PLAYERTASKCONTROLLER:GetStartState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##GetStartState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A string containing the start state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetState" ><strong>PLAYERTASKCONTROLLER:GetState()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get current state.</p>
|
|
|
|
<div id= "#Functions##GetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current FSM state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetSubs" ><strong>PLAYERTASKCONTROLLER:GetSubs()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table with the Subs defined.</p>
|
|
|
|
<div id= "#Functions##GetSubs" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub processes.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetTransitions" ><strong>PLAYERTASKCONTROLLER:GetTransitions()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns a table of the transition rules defined within the FSM.</p>
|
|
|
|
<div id= "#Functions##GetTransitions" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Transitions.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).Is" ><strong>PLAYERTASKCONTROLLER:Is(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##Is" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).LoadCallBacks" ><strong>PLAYERTASKCONTROLLER:LoadCallBacks(CallBackTable)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Load call backs.</p>
|
|
|
|
<div id= "#Functions##LoadCallBacks" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>CallBackTable</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of call backs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).New" ><strong>PLAYERTASKCONTROLLER:New()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creates a new FSM object.</p>
|
|
|
|
<div id= "#Functions##New" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(FSM)">#FSM</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetProcess" ><strong>PLAYERTASKCONTROLLER:SetProcess(From, Event, Fsm)</strong></a></h2>
|
|
</div>
|
|
|
|
|
|
|
|
<div id= "#Functions##SetProcess" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>From</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Fsm</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetStartState" ><strong>PLAYERTASKCONTROLLER:SetStartState(State)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sets the start state of the FSM.</p>
|
|
|
|
<div id= "#Functions##SetStartState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A string defining the start state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._add_to_map" ><strong>PLAYERTASKCONTROLLER:_add_to_map(Map, Event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add to map.</p>
|
|
|
|
<div id= "#Functions##_add_to_map" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Map</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event table.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._call_handler" ><strong>PLAYERTASKCONTROLLER:_call_handler(step, trigger, params, EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Call handler.</p>
|
|
|
|
<div id= "#Functions##_call_handler" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>step</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Step "onafter", "onbefore", "onenter", "onleave".</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>trigger</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Trigger.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>params</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parameters.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._create_transition" ><strong>PLAYERTASKCONTROLLER:_create_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create transition.</p>
|
|
|
|
<div id= "#Functions##_create_transition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._delayed_transition" ><strong>PLAYERTASKCONTROLLER:_delayed_transition(EventName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delayed transition.</p>
|
|
|
|
<div id= "#Functions##_delayed_transition" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#function:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._eventmap" ><strong>PLAYERTASKCONTROLLER:_eventmap(Events, EventStructure)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Event map.</p>
|
|
|
|
<div id= "#Functions##_eventmap" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Events</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Events.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>EventStructure</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._gosub" ><strong>PLAYERTASKCONTROLLER:_gosub(ParentFrom, ParentEvent)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Go sub.</p>
|
|
|
|
<div id= "#Functions##_gosub" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ParentFrom</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent from state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>ParentEvent</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parent event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Subs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._handler" ><strong>PLAYERTASKCONTROLLER:_handler(EventName, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Handler.</p>
|
|
|
|
<div id= "#Functions##_handler" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>EventName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Arguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._isendstate" ><strong>PLAYERTASKCONTROLLER:_isendstate(Current)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Is end state.</p>
|
|
|
|
<div id= "#Functions##_isendstate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Current</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Current state name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>FSM parent.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._submap" ><strong>PLAYERTASKCONTROLLER:_submap(subs, sub, name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sub maps.</p>
|
|
|
|
<div id= "#Functions##_submap" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>subs</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Subs.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>sub</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Sub.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>name</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).can" ><strong>PLAYERTASKCONTROLLER:can(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if can do an event.</p>
|
|
|
|
<div id= "#Functions##can" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM can do the event.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>To state.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).cannot" ><strong>PLAYERTASKCONTROLLER:cannot(e)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if cannot do an event.</p>
|
|
|
|
<div id= "#Functions##cannot" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>e</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM cannot do the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).is" ><strong>PLAYERTASKCONTROLLER:is(State, state)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##is" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>state</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).AccessKey" ><strong>PLAYERTASKCONTROLLER.AccessKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveClientSet" ><strong>PLAYERTASKCONTROLLER.ActiveClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveInfoMenu" ><strong>PLAYERTASKCONTROLLER.ActiveInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.ActiveTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ActiveTopMenu" ><strong>PLAYERTASKCONTROLLER.ActiveTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).AllowFlash" ><strong>PLAYERTASKCONTROLLER.AllowFlash</strong></a>
|
|
|
|
<p>Flashing directions for players allowed</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCFrequency" ><strong>PLAYERTASKCONTROLLER.BCFrequency</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).BCModulation" ><strong>PLAYERTASKCONTROLLER.BCModulation</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).BlackList" ><strong>PLAYERTASKCONTROLLER.BlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignCustomFunc" ><strong>PLAYERTASKCONTROLLER.CallsignCustomFunc</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).CallsignTranslations" ><strong>PLAYERTASKCONTROLLER.CallsignTranslations</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClassName" ><strong>PLAYERTASKCONTROLLER.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientFilter" ><strong>PLAYERTASKCONTROLLER.ClientFilter</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).ClientSet" ><strong>PLAYERTASKCONTROLLER.ClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).ClusterRadius" ><strong>PLAYERTASKCONTROLLER.ClusterRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).Coalition" ><strong>PLAYERTASKCONTROLLER.Coalition</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).CoalitionName" ><strong>PLAYERTASKCONTROLLER.CoalitionName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).FlashPlayer" ><strong>PLAYERTASKCONTROLLER.FlashPlayer</strong></a>
|
|
|
|
<p>List of player who switched Flashing Direction Info on</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasCoordinate" ><strong>PLAYERTASKCONTROLLER.InfoHasCoordinate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InfoHasLLDDM" ><strong>PLAYERTASKCONTROLLER.InfoHasLLDDM</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).InformationMenu" ><strong>PLAYERTASKCONTROLLER.InformationMenu</strong></a>
|
|
|
|
<p>Show Radio Info Menu</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).Intel" ><strong>PLAYERTASKCONTROLLER.Intel</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).IsClientSet" ><strong>PLAYERTASKCONTROLLER.IsClientSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinInfoMenu" ><strong>PLAYERTASKCONTROLLER.JoinInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinMenu" ><strong>PLAYERTASKCONTROLLER.JoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENUMANAGER)">Core.ClientMenu#CLIENTMENUMANAGER</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTaskMenuTemplate" ><strong>PLAYERTASKCONTROLLER.JoinTaskMenuTemplate</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).JoinTopMenu" ><strong>PLAYERTASKCONTROLLER.JoinTopMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).Keepnumber" ><strong>PLAYERTASKCONTROLLER.Keepnumber</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDrone" ><strong>PLAYERTASKCONTROLLER.LasingDrone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).LasingDroneSet" ><strong>PLAYERTASKCONTROLLER.LasingDroneSet</strong></a>
|
|
|
|
|
|
|
|
|
|
<p>self.PlayerMenu = {} -- #table</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.MarkerOps_Base.html##(MARKEROPS_BASE)">Core.MarkerOps_Base#MARKEROPS_BASE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerOps" ><strong>PLAYERTASKCONTROLLER.MarkerOps</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).MarkerReadOnly" ><strong>PLAYERTASKCONTROLLER.MarkerReadOnly</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuName" ><strong>PLAYERTASKCONTROLLER.MenuName</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.ClientMenu.html##(CLIENTMENU)">Core.ClientMenu#CLIENTMENU</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuNoTask" ><strong>PLAYERTASKCONTROLLER.MenuNoTask</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Menu.html##(MENU_MISSION)">Core.Menu#MENU_MISSION</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).MenuParent" ><strong>PLAYERTASKCONTROLLER.MenuParent</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).Messages" ><strong>PLAYERTASKCONTROLLER.Messages</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Name" ><strong>PLAYERTASKCONTROLLER.Name</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).NoScreenOutput" ><strong>PLAYERTASKCONTROLLER.NoScreenOutput</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).PathToGoogleKey" ><strong>PLAYERTASKCONTROLLER.PathToGoogleKey</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerFlashMenu" ><strong>PLAYERTASKCONTROLLER.PlayerFlashMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerInfoMenu" ><strong>PLAYERTASKCONTROLLER.PlayerInfoMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerJoinMenu" ><strong>PLAYERTASKCONTROLLER.PlayerJoinMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenu" ><strong>PLAYERTASKCONTROLLER.PlayerMenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerMenuTag" ><strong>PLAYERTASKCONTROLLER.PlayerMenuTag</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.PlayerRecce.html##(PLAYERRECCE)">Ops.PlayerRecce#PLAYERRECCE</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PlayerRecce" ><strong>PLAYERTASKCONTROLLER.PlayerRecce</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).PrecisionTasks" ><strong>PLAYERTASKCONTROLLER.PrecisionTasks</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).RecceSet" ><strong>PLAYERTASKCONTROLLER.RecceSet</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRS" ><strong>PLAYERTASKCONTROLLER.SRS</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> set up SRS </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SRSQueue" ><strong>PLAYERTASKCONTROLLER.SRSQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).SceneryExplosivesAmount" ><strong>PLAYERTASKCONTROLLER.SceneryExplosivesAmount</strong></a>
|
|
|
|
<p>Kgs of TNT to explode scenery on task persistance loading</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(Scores)">#Scores</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scores" ><strong>PLAYERTASKCONTROLLER.Scores</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Functional.Scoring.html##(SCORING)">Functional.Scoring#SCORING</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).Scoring" ><strong>PLAYERTASKCONTROLLER.Scoring</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PLAYERTASKCONTROLLER).SeadAttributes" ><strong>PLAYERTASKCONTROLLER.SeadAttributes</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShortCallsign" ><strong>PLAYERTASKCONTROLLER.ShortCallsign</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).ShowMagnetic" ><strong>PLAYERTASKCONTROLLER.ShowMagnetic</strong></a>
|
|
|
|
<p>Also show magnetic angles</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetQueue" ><strong>PLAYERTASKCONTROLLER.TargetQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TargetRadius" ><strong>PLAYERTASKCONTROLLER.TargetRadius</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskInfoDuration" ><strong>PLAYERTASKCONTROLLER.TaskInfoDuration</strong></a>
|
|
|
|
<p>How long to show the briefing info on the screen</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistance" ><strong>PLAYERTASKCONTROLLER.TaskPersistance</strong></a>
|
|
|
|
<p>Table for persistance data</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceFilename" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceFilename</strong></a>
|
|
|
|
<p>File name for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistancePath" ><strong>PLAYERTASKCONTROLLER.TaskPersistancePath</strong></a>
|
|
|
|
<p>File path for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskPersistanceSwitch" ><strong>PLAYERTASKCONTROLLER.TaskPersistanceSwitch</strong></a>
|
|
|
|
<p>Switch for persisting tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TaskQueue" ><strong>PLAYERTASKCONTROLLER.TaskQueue</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Utilities.FiFo.html##(FIFO)">Utilities.FiFo#FIFO</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPerPlayer" ><strong>PLAYERTASKCONTROLLER.TasksPerPlayer</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).TasksPersistable" ><strong>PLAYERTASKCONTROLLER.TasksPersistable</strong></a>
|
|
|
|
<p>List of persistable tasks</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).TransmitOnlyWithPlayers" ><strong>PLAYERTASKCONTROLLER.TransmitOnlyWithPlayers</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).Type" ><strong>PLAYERTASKCONTROLLER.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseBlackList" ><strong>PLAYERTASKCONTROLLER.UseBlackList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseGroupNames" ><strong>PLAYERTASKCONTROLLER.UseGroupNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseSRS" ><strong>PLAYERTASKCONTROLLER.UseSRS</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseTypeNames" ><strong>PLAYERTASKCONTROLLER.UseTypeNames</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).UseWhiteList" ><strong>PLAYERTASKCONTROLLER.UseWhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).WhiteList" ><strong>PLAYERTASKCONTROLLER.WhiteList</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).activehasinfomenu" ><strong>PLAYERTASKCONTROLLER.activehasinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).buddylasing" ><strong>PLAYERTASKCONTROLLER.buddylasing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(PLAYERTASKCONTROLLER).customcallsigns" ><strong>PLAYERTASKCONTROLLER.customcallsigns</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.TextAndSound.html##(TEXTANDSOUND)">Core.TextAndSound#TEXTANDSOUND</a>
|
|
<a id="#(PLAYERTASKCONTROLLER).gettext" ><strong>PLAYERTASKCONTROLLER.gettext</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).holdmenutime" ><strong>PLAYERTASKCONTROLLER.holdmenutime</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).illumenu" ><strong>PLAYERTASKCONTROLLER.illumenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).lasttaskcount" ><strong>PLAYERTASKCONTROLLER.lasttaskcount</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).lid" ><strong>PLAYERTASKCONTROLLER.lid</strong></a>
|
|
|
|
<p>Class id string for output to DCS log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).locale" ><strong>PLAYERTASKCONTROLLER.locale</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PLAYERTASKCONTROLLER).menuitemlimit" ><strong>PLAYERTASKCONTROLLER.menuitemlimit</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).noflaresmokemenu" ><strong>PLAYERTASKCONTROLLER.noflaresmokemenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).precisionbombing" ><strong>PLAYERTASKCONTROLLER.precisionbombing</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).repeatonfailed" ><strong>PLAYERTASKCONTROLLER.repeatonfailed</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).taskinfomenu" ><strong>PLAYERTASKCONTROLLER.taskinfomenu</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).usecluster" ><strong>PLAYERTASKCONTROLLER.usecluster</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PLAYERTASKCONTROLLER).verbose" ><strong>PLAYERTASKCONTROLLER.verbose</strong></a>
|
|
|
|
<p>Switch verbosity.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PLAYERTASKCONTROLLER).version" ><strong>PLAYERTASKCONTROLLER.version</strong></a>
|
|
|
|
<p>PLAYERTASK class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).ClearState" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).CreateEventBirth" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).CreateEventCrash" ><strong>PLAYERTASKCONTROLLER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventCrash" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventDead" ><strong>PLAYERTASKCONTROLLER:CreateEventDead(EventTime, Initiator, IniObjectCategory)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Dead Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>IniObjectCategory</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventDynamicCargoLoaded" ><strong>PLAYERTASKCONTROLLER:CreateEventDynamicCargoLoaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoLoaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventDynamicCargoRemoved" ><strong>PLAYERTASKCONTROLLER:CreateEventDynamicCargoRemoved(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventDynamicCargoUnloaded" ><strong>PLAYERTASKCONTROLLER:CreateEventDynamicCargoUnloaded(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.</p>
|
|
|
|
<div id= "#Functions##CreateEventDynamicCargoUnloaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventNewDynamicCargo" ><strong>PLAYERTASKCONTROLLER:CreateEventNewDynamicCargo(DynamicCargo)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.</p>
|
|
|
|
<div id= "#Functions##CreateEventNewDynamicCargo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.DynamicCargo.html##(DYNAMICCARGO)">Wrapper.DynamicCargo#DYNAMICCARGO</a>
|
|
<strong><strong>DynamicCargo</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the dynamic cargo object</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventPlayerEnterAircraft" ><strong>PLAYERTASKCONTROLLER:CreateEventPlayerEnterAircraft(PlayerUnit)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a <code>S_EVENT_PLAYER_ENTER_AIRCRAFT</code> event.</p>
|
|
|
|
<div id= "#Functions##CreateEventPlayerEnterAircraft" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
|
<strong><strong>PlayerUnit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The aircraft unit the player entered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).CreateEventRemoveUnit" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).CreateEventTakeoff" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).CreateEventUnitLost" ><strong>PLAYERTASKCONTROLLER:CreateEventUnitLost(EventTime, Initiator)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Creation of a Crash Event.</p>
|
|
|
|
<div id= "#Functions##CreateEventUnitLost" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Time)">DCS#Time</a>
|
|
<strong><strong>EventTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The time stamp of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Object)">DCS#Object</a>
|
|
<strong><strong>Initiator</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The initiating object of the event.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).E" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).EventDispatcher" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).EventRemoveAll" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).F" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).F2" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).F3" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).GetClassID" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).GetClassName" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).GetClassNameAndID" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).GetEventPriority" ><strong>PLAYERTASKCONTROLLER:GetEventPriority()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##GetEventPriority" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetParent" ><strong>PLAYERTASKCONTROLLER:GetParent(Child, FromClass)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>This is the worker method to retrieve the Parent class.</p>
|
|
|
|
|
|
<p>Note that the Parent class must be passed to call the parent class method.</p>
|
|
|
|
<pre><code>self:GetParent(self):ParentMethod()
|
|
</code></pre>
|
|
|
|
|
|
|
|
<div id= "#Functions##GetParent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>Child</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>This is the Child class from which the Parent class needs to be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(BASE)">#BASE</a>
|
|
<strong><strong>FromClass</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The class from which to get the parent.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetProperties" ><strong>PLAYERTASKCONTROLLER:GetProperties()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get all of the properties of an object in a table.</p>
|
|
|
|
<div id= "#Functions##GetProperties" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of values, indexed by keys.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetProperty" ><strong>PLAYERTASKCONTROLLER:GetProperty(Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get one property of an object by the key.</p>
|
|
|
|
<div id= "#Functions##GetProperty" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value The value that is stored. Note that the value can be a #string, but it can also be any other type! Nil if not found. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).GetState" ><strong>PLAYERTASKCONTROLLER:GetState(Object, Key)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a Value given a Key from the Object.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##GetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that holds the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).HandleEvent" ><strong>PLAYERTASKCONTROLLER:HandleEvent(EventID, EventFunction)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Subscribe to a DCS Event.</p>
|
|
|
|
<div id= "#Functions##HandleEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>EventFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(optional) The function to be called when the event occurs for the unit.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).I" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).Inherit" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).IsInstanceOf" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).IsTrace" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).New" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).OnEvent" ><strong>PLAYERTASKCONTROLLER:OnEvent(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an Event for an object is triggered.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that triggered the event. </p>
|
|
|
|
<div id= "#Functions##OnEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventBDA" ><strong>PLAYERTASKCONTROLLER:OnEventBDA(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>BDA.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventBDA" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventBaseCaptured" ><strong>PLAYERTASKCONTROLLER:OnEventBaseCaptured(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a ground unit captures either an airbase or a farp.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that captured the base
|
|
place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction. </p>
|
|
|
|
<div id= "#Functions##OnEventBaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventBirth" ><strong>PLAYERTASKCONTROLLER:OnEventBirth(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any object is spawned into the mission.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was spawned </p>
|
|
|
|
<div id= "#Functions##OnEventBirth" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventCrash" ><strong>PLAYERTASKCONTROLLER:OnEventCrash(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft crashes into the ground and is completely destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that has crashed </p>
|
|
|
|
<div id= "#Functions##OnEventCrash" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDead" ><strong>PLAYERTASKCONTROLLER:OnEventDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an object is dead.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is dead. </p>
|
|
|
|
<div id= "#Functions##OnEventDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDetailedFailure" ><strong>PLAYERTASKCONTROLLER:OnEventDetailedFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Unknown precisely what creates this event, likely tied into newer damage model.</p>
|
|
|
|
|
|
<p>Will update this page when new information become available.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that had the failure.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventDetailedFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDiscardChairAfterEjection" ><strong>PLAYERTASKCONTROLLER:OnEventDiscardChairAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Discard chair after ejection.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventDiscardChairAfterEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDynamicCargoLoaded" ><strong>PLAYERTASKCONTROLLER:OnEventDynamicCargoLoaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoLoaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDynamicCargoRemoved" ><strong>PLAYERTASKCONTROLLER:OnEventDynamicCargoRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a dynamic cargo crate is removed.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventDynamicCargoUnloaded" ><strong>PLAYERTASKCONTROLLER:OnEventDynamicCargoUnloaded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventDynamicCargoUnloaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventEjection" ><strong>PLAYERTASKCONTROLLER:OnEventEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a pilot ejects from an aircraft
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has ejected </p>
|
|
|
|
<div id= "#Functions##OnEventEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventEngineShutdown" ><strong>PLAYERTASKCONTROLLER:OnEventEngineShutdown(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft shuts down its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is stopping its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineShutdown" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventEngineStartup" ><strong>PLAYERTASKCONTROLLER:OnEventEngineStartup(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any aircraft starts its engines.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is starting its engines. </p>
|
|
|
|
<div id= "#Functions##OnEventEngineStartup" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventHit" ><strong>PLAYERTASKCONTROLLER:OnEventHit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever an object is hit by a weapon.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit object the fired the weapon
|
|
weapon: Weapon object that hit the target
|
|
target: The Object that was hit. </p>
|
|
|
|
<div id= "#Functions##OnEventHit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventHumanFailure" ><strong>PLAYERTASKCONTROLLER:OnEventHumanFailure(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any system fails on a human controlled aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that had the failure </p>
|
|
|
|
<div id= "#Functions##OnEventHumanFailure" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventKill" ><strong>PLAYERTASKCONTROLLER:OnEventKill(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs on the death of a unit.</p>
|
|
|
|
|
|
<p>Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that killed the target</li>
|
|
<li>target: Target Object</li>
|
|
<li>weapon: Weapon Object</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventKill" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventLand" ><strong>PLAYERTASKCONTROLLER:OnEventLand(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft lands at an airbase, farp or ship
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
|
|
<p>initiator : The unit that has landed
|
|
place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventLand" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventLandingAfterEjection" ><strong>PLAYERTASKCONTROLLER:OnEventLandingAfterEjection(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.</p>
|
|
|
|
|
|
<p>Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.</li>
|
|
<li>place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.</li>
|
|
<li>subplace: is always 0 for unknown reasons.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventLandingAfterEjection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventLandingQualityMark" ><strong>PLAYERTASKCONTROLLER:OnEventLandingQualityMark(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Landing quality mark.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventLandingQualityMark" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventMarkAdded" ><strong>PLAYERTASKCONTROLLER:OnEventMarkAdded(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a new mark was added.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkAdded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventMarkChange" ><strong>PLAYERTASKCONTROLLER:OnEventMarkChange(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark text was changed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkChange" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventMarkRemoved" ><strong>PLAYERTASKCONTROLLER:OnEventMarkRemoved(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mark was removed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
MarkID: ID of the mark. </p>
|
|
|
|
<div id= "#Functions##OnEventMarkRemoved" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventMissionEnd" ><strong>PLAYERTASKCONTROLLER:OnEventMissionEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission ends
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventMissionEnd" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventMissionStart" ><strong>PLAYERTASKCONTROLLER:OnEventMissionStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a mission starts
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes. </p>
|
|
|
|
<div id= "#Functions##OnEventMissionStart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventNewDynamicCargo" ><strong>PLAYERTASKCONTROLLER:OnEventNewDynamicCargo(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.</p>
|
|
|
|
|
|
<p><strong>* NOTE *</strong> this is a workarounf for DCS not creating these events as of Aug 2024.</p>
|
|
|
|
<div id= "#Functions##OnEventNewDynamicCargo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventParatrooperLanding" ><strong>PLAYERTASKCONTROLLER:OnEventParatrooperLanding(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Weapon add.</p>
|
|
|
|
|
|
<p>Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventParatrooperLanding" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventPilotDead" ><strong>PLAYERTASKCONTROLLER:OnEventPilotDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the pilot of an aircraft is killed.</p>
|
|
|
|
|
|
<p>Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the pilot has died in. </p>
|
|
|
|
<div id= "#Functions##OnEventPilotDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventPlayerEnterAircraft" ><strong>PLAYERTASKCONTROLLER:OnEventPlayerEnterAircraft(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when a player enters a slot and takes control of an aircraft.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
<strong>NOTE</strong>: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterAircraft" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventPlayerEnterUnit" ><strong>PLAYERTASKCONTROLLER:OnEventPlayerEnterUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player assumes direct control of a unit.</p>
|
|
|
|
|
|
<p>Note - not Mulitplayer safe. Use PlayerEnterAircraft.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is being taken control of. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerEnterUnit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventPlayerLeaveUnit" ><strong>PLAYERTASKCONTROLLER:OnEventPlayerLeaveUnit(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any player relieves control of a unit to the AI.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that the player left. </p>
|
|
|
|
<div id= "#Functions##OnEventPlayerLeaveUnit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventRefueling" ><strong>PLAYERTASKCONTROLLER:OnEventRefueling(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft connects with a tanker and begins taking on fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefueling" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventRefuelingStop" ><strong>PLAYERTASKCONTROLLER:OnEventRefuelingStop(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft is finished taking fuel.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was receiving fuel. </p>
|
|
|
|
<div id= "#Functions##OnEventRefuelingStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventScore" ><strong>PLAYERTASKCONTROLLER:OnEventScore(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any modification to the "Score" as seen on the debrief menu would occur.</p>
|
|
|
|
|
|
<p>There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventScore" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventShootingEnd" ><strong>PLAYERTASKCONTROLLER:OnEventShootingEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit stops firing its weapon.</p>
|
|
|
|
|
|
<p>Event will always correspond with a shooting start event.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that was doing the shooting. </p>
|
|
|
|
<div id= "#Functions##OnEventShootingEnd" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventShootingStart" ><strong>PLAYERTASKCONTROLLER:OnEventShootingStart(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when any unit begins firing a weapon that has a high rate of fire.</p>
|
|
|
|
|
|
<p>Most common with aircraft cannons (GAU-8), autocannons, and machine guns.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that is doing the shooting.
|
|
target: The unit that is being targeted.</p>
|
|
|
|
<div id= "#Functions##OnEventShootingStart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventShot" ><strong>PLAYERTASKCONTROLLER:OnEventShot(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs whenever any unit in a mission fires a weapon.</p>
|
|
|
|
|
|
<p>But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart.
|
|
Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventShot" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventTakeoff" ><strong>PLAYERTASKCONTROLLER:OnEventTakeoff(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when an aircraft takes off from an airbase, farp, or ship.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.
|
|
initiator : The unit that tookoff
|
|
place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships </p>
|
|
|
|
<div id= "#Functions##OnEventTakeoff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventTriggerZone" ><strong>PLAYERTASKCONTROLLER:OnEventTriggerZone(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger zone.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<div id= "#Functions##OnEventTriggerZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).OnEventUnitLost" ><strong>PLAYERTASKCONTROLLER:OnEventUnitLost(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Occurs when the game thinks an object is destroyed.</p>
|
|
|
|
|
|
<p>Have a look at the class <a href="Core.Event.html##(EVENT)">Core.Event#EVENT</a> as these are just the prototypes.</p>
|
|
|
|
<ul>
|
|
<li>initiator: The unit that is was destroyed.</li>
|
|
</ul>
|
|
|
|
|
|
<div id= "#Functions##OnEventUnitLost" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The EventData structure.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).ScheduleOnce" ><strong>PLAYERTASKCONTROLLER:ScheduleOnce(Start, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleOnce" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Schedule ID of the planned schedule.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).ScheduleRepeat" ><strong>PLAYERTASKCONTROLLER:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleRepeat" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Repeat</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the interval in seconds when the scheduler will call the event function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>RandomizeFactor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies a randomization factor between 0 and 1 to randomize the Repeat.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Stop</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds when the scheduler will be stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Schedule ID of the planned schedule.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).ScheduleStop" ><strong>PLAYERTASKCONTROLLER:ScheduleStop(SchedulerID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Stops the Schedule.</p>
|
|
|
|
<div id= "#Functions##ScheduleStop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>SchedulerID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetEventPriority" ><strong>PLAYERTASKCONTROLLER:SetEventPriority(EventPriority)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the Class <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
|
|
<p>The Event processing Priority is a number from 1 to 10,
|
|
reflecting the order of the classes subscribed to the Event to be processed.</p>
|
|
|
|
<div id= "#Functions##SetEventPriority" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>EventPriority</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The <a href="Core.Event.html">Core.Event</a> processing Priority.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetProperty" ><strong>PLAYERTASKCONTROLLER:SetProperty(Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set one property of an object.</p>
|
|
|
|
<div id= "#Functions##SetProperty" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Value</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The value that is stored. Note that the value can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).SetState" ><strong>PLAYERTASKCONTROLLER:SetState(Object, Key, Value)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a state or property of the Object given a Key and a Value.</p>
|
|
|
|
|
|
<p>Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.</p>
|
|
|
|
<div id= "#Functions##SetState" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Object</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The object that will hold the Value set by the Key.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Key</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>Value</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The value to is stored in the object.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The Value set. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).T" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).T2" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).T3" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).TraceAll" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).TraceClass" ><strong>PLAYERTASKCONTROLLER:TraceClass(Class)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a class</p>
|
|
|
|
<div id= "#Functions##TraceClass" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).TraceClassMethod" ><strong>PLAYERTASKCONTROLLER:TraceClassMethod(Class, Method)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set tracing for a specific method of class</p>
|
|
|
|
<div id= "#Functions##TraceClassMethod" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Class</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Class name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Method</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Method.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).TraceLevel" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).TraceOff" ><strong>PLAYERTASKCONTROLLER:TraceOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace off.</p>
|
|
|
|
<div id= "#Functions##TraceOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing Off
|
|
BASE:TraceOff()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).TraceOn" ><strong>PLAYERTASKCONTROLLER:TraceOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set trace on.</p>
|
|
|
|
<div id= "#Functions##TraceOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>-- Switch the tracing On
|
|
BASE:TraceOn()</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER).TraceOnOff" ><strong>PLAYERTASKCONTROLLER: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="#(PLAYERTASKCONTROLLER).UnHandleEvent" ><strong>PLAYERTASKCONTROLLER:UnHandleEvent(EventID)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>UnSubscribe to a DCS event.</p>
|
|
|
|
<div id= "#Functions##UnHandleEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTS)">Core.Event#EVENTS</a>
|
|
<strong><strong>EventID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(BASE)">#BASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._F" ><strong>PLAYERTASKCONTROLLER:_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="#(PLAYERTASKCONTROLLER)._Serialize" ><strong>PLAYERTASKCONTROLLER:_Serialize(Arguments)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>(Internal) Serialize arguments</p>
|
|
|
|
<div id= "#Functions##_Serialize" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>Arguments</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Text</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(PLAYERTASKCONTROLLER)._T" ><strong>PLAYERTASKCONTROLLER:_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="#(PLAYERTASKCONTROLLER).onEvent" ><strong>PLAYERTASKCONTROLLER:onEvent(event)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>The main event handling function...</p>
|
|
|
|
|
|
<p>This function captures all events generated for the class.</p>
|
|
|
|
<div id= "#Functions##onEvent" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Event)">DCS#Event</a>
|
|
<strong><strong>event</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##PersistenceData')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(PersistenceData)">Type <strong>PersistenceData</strong></a></h2></div>
|
|
<div id= "#Types##PersistenceData" 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">
|
|
|
|
#number
|
|
<a id="#(PersistenceData).ID" ><strong>PersistenceData.ID</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PersistenceData).InitialTargets" ><strong>PersistenceData.InitialTargets</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PersistenceData).Name" ><strong>PersistenceData.Name</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(PersistenceData).Targetsleft" ><strong>PersistenceData.Targetsleft</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(PersistenceData).Task" ><strong>PersistenceData.Task</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(PersistenceData).Type" ><strong>PersistenceData.Type</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(PersistenceData).updated" ><strong>PersistenceData.updated</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##SeadAttributes')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(SeadAttributes)">Type <strong>SeadAttributes</strong></a></h2></div>
|
|
<div id= "#Types##SeadAttributes" 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">
|
|
|
|
#number
|
|
<a id="#(SeadAttributes).AAA" ><strong>SeadAttributes.AAA</strong></a>
|
|
|
|
<p>GROUP.Attribute.GROUND_AAA</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(SeadAttributes).EWR" ><strong>SeadAttributes.EWR</strong></a>
|
|
|
|
<p>GROUP.Attribute.GROUND_EWR </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(SeadAttributes).SAM" ><strong>SeadAttributes.SAM</strong></a>
|
|
|
|
<p>GROUP.Attribute.GROUND_SAM </p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##Type')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Type)">Type <strong>Type</strong></a></h2></div>
|
|
<div id= "#Types##Type" 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">
|
|
|
|
#string
|
|
<a id="#(Type).A2A" ><strong>Type.A2A</strong></a>
|
|
|
|
<p>Air-to-Air Controller</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(Type).A2G" ><strong>Type.A2G</strong></a>
|
|
|
|
<p>Air-to-Ground Controller</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(Type).A2GS" ><strong>Type.A2GS</strong></a>
|
|
|
|
<p>Air-to-Ground-and-Ship Controller</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(Type).A2S" ><strong>Type.A2S</strong></a>
|
|
|
|
<p>Air-to-Ship Controller</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
<script>
|
|
function myLoadFunction() {
|
|
document.getElementById("myHeader").style.backgroundImage = "url('../Images/OPS_PlayerTask.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>
|