mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
28370 lines
981 KiB
HTML
28370 lines
981 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html>
|
|
<head>
|
|
<!-- Global site tag (gtag.js) - Google Analytics -->
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-97385487-1"></script>
|
|
<script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'UA-97385487-1');</script>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous">
|
|
<link rel="stylesheet" href="https://www.w3schools.com/lib/w3-theme-indigo.css">
|
|
<link rel="stylesheet" href="../Highlight/styles/github.css">
|
|
<script src="../Highlight/highlight.pack.js"></script>
|
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
<link rel="stylesheet" href="w3.css" type="text/css"/>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
|
|
|
|
<style>
|
|
.picturebox {
|
|
height:100px;
|
|
}
|
|
|
|
</style>
|
|
</head>
|
|
<body onload="myLoadFunction()" >
|
|
<div id="myHeader" class="w3-container sticky w3-border-white w3-bottombar" style="background-image:url('../Images/MOOSE.JPG');">
|
|
<h1>
|
|
<i class="fa fa-bars w3-text-white fa-2x" onclick="w3_open()"></i>
|
|
</h1>
|
|
</div>
|
|
<div id="main">
|
|
<nav class="w3-sidenav w3-theme-l5 w3-animate-left" style="display:none">
|
|
<a href="javascript:void(0)"
|
|
onclick="w3_close()"
|
|
class="w3-closenav w3-large">Close ×</a>
|
|
<div class="w3-row">
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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/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>
|
|
<p><strong>Core</strong> - SCHEDULEDISPATCHER dispatches the different schedules.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Scheduler.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Scheduler.html">Core.Scheduler</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Prepares and handles the execution of functions over scheduled time (intervals).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Sets.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Set.html">Core.Set</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Define collections of objects to perform bulk actions and logically group objects.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Core_Settings.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Settings.html">Core.Settings</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Core</strong> - Manages various settings for 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/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/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.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/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/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 airtraffic in your missions.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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/Suppression.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Suppression.html">Functional.Suppression</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Suppress fire of ground units when they get hit.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Warehouse.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Warehouse.html">Functional.Warehouse</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Simulation of logistic operations.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/Capture_Zones.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneCaptureCoalition.html">Functional.ZoneCaptureCoalition</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</strong> - Models the process to zone guarding and capturing.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoal.html">Functional.ZoneGoal</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Functional</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</strong> - Base class that models processes to achieve goals involving a Zone for a Coalition.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/OPS_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_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_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_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/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.STTS.html">Utilities.STTS</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - DCS Simple Text-To-Speech (STTS).</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/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.Templates.html">Utilities.Templates</a></strong></h2></div>
|
|
</div>
|
|
<div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p>
|
|
<p><strong>Utilities</strong> - Templates.</p>
|
|
</p></div>
|
|
</div>
|
|
</div>
|
|
<div class="w3-col s12 m6 l4">
|
|
<div class="w3-card-4 w3-white w3-margin-16">
|
|
<div class="w3-display-container w3-text-white w3-text-shadow">
|
|
<img src= "../Images/MOOSE.JPG" alt="Image">
|
|
<div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="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\Warehouse.JPG" alt="Banner Image"/>
|
|
<div id="content">
|
|
<div class="w3-container w3-theme-d5" id="module_title">
|
|
<h1>Module <strong>Functional.Warehouse</strong></h1>
|
|
</div>
|
|
<div class="w3-container w3-white" id="module_description">
|
|
|
|
<p><strong>Functional</strong> - Simulation of logistic operations.</p>
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
<h2>Features:</h2>
|
|
|
|
<ul>
|
|
<li>Holds (virtual) assets in stock and spawns them upon request.</li>
|
|
<li>Manages requests of assets from other warehouses.</li>
|
|
<li>Queueing system with optional prioritization of requests.</li>
|
|
<li>Realistic transportation of assets between warehouses.</li>
|
|
<li>Different means of automatic transportation (planes, helicopters, APCs, self propelled).</li>
|
|
<li>Strategic components such as capturing, defending and destroying warehouses and their associated infrastructure.</li>
|
|
<li>Intelligent spawning of aircraft on airports (only if enough parking spots are available).</li>
|
|
<li>Possibility to hook into events and customize actions.</li>
|
|
<li>Persistence of assets. Warehouse assets can be saved and loaded from file.</li>
|
|
<li>Can be easily interfaced to other MOOSE classes.</li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
<h2>Youtube Videos:</h2>
|
|
|
|
<ul>
|
|
<li><a href="https://www.youtube.com/watch?v=e98jzLi5fGk">Warehouse Trailer</a></li>
|
|
<li><a href="https://www.youtube.com/watch?v=YeuGL0duEgY">DCS Warehouse Airbase Resources Proof Of Concept</a></li>
|
|
</ul>
|
|
|
|
<hr/>
|
|
|
|
<h2>Missions:</h2>
|
|
|
|
<hr/>
|
|
|
|
<p>The MOOSE warehouse concept simulates the organization and implementation of complex operations regarding the flow of assets between the point of origin and the point of consumption
|
|
in order to meet requirements of a potential conflict. In particular, this class is concerned with maintaining army supply lines while disrupting those of the enemy, since an armed
|
|
force without resources and transportation is defenseless.</p>
|
|
|
|
<hr/>
|
|
|
|
<h3>Author: <strong>funkyfranky</strong></h3>
|
|
<h3>Co-author: FlightControl (cargo dispatcher classes)</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##WAREHOUSE')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>WAREHOUSE</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
<p>Have your assets at the right place at the right time - or not!</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The Warehouse Concept</h1>
|
|
|
|
<p>The MOOSE warehouse adds a new logistic component to the DCS World.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##WAREHOUSE" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<a id="WAREHOUSE" ><strong>WAREHOUSE</strong></a>
|
|
|
|
<p>Have your assets at the right place at the right time - or not!</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>The Warehouse Concept</h1>
|
|
|
|
<p>The MOOSE warehouse adds a new logistic component to the DCS World.</p>
|
|
|
|
|
|
<p><em>Assets</em>, i.e. ground, airborne and naval units, can be transferred from one place
|
|
to another in a realistic and highly automatic fashion. In contrast to a "DCS warehouse" these assets have a physical representation in game. In particular,
|
|
this means they can be destroyed during the transport and add more life to the DCS world.</p>
|
|
|
|
<p>This comes along with some additional interesting strategic aspects since capturing/defending and destroying/protecting an enemy or your
|
|
own warehouse becomes of critical importance for the development of a conflict.</p>
|
|
|
|
<p>In essence, creating an efficient network of warehouses is vital for the success of a battle or even the whole war. Likewise, of course, cutting off the enemy
|
|
of important supply lines by capturing or destroying warehouses or their associated infrastructure is equally important.</p>
|
|
|
|
<h2>What is a warehouse?</h2>
|
|
|
|
<p>A warehouse is an abstract object represented by a physical (static) building that can hold virtual assets in stock.
|
|
It can (but it must not) be associated with a particular airbase. The associated airbase can be an airdrome, a Helipad/FARP or a ship.</p>
|
|
|
|
<p>If another warehouse requests assets, the corresponding troops are spawned at the warehouse and being transported to the requestor or go their
|
|
by themselfs. Once arrived at the requesting warehouse, the assets go into the stock of the requestor and can be activated/deployed when necessary.</p>
|
|
|
|
<h2>What assets can be stored?</h2>
|
|
|
|
<p>Any kind of ground, airborne or naval asset can be stored and are spawned upon request.
|
|
The fact that the assets live only virtually in stock and are put into the game only when needed has a positive impact on the game performance.
|
|
It also alliviates the problem of limited parking spots at smaller airbases.</p>
|
|
|
|
<h2>What means of transportation are available?</h2>
|
|
|
|
<p>Firstly, all mobile assets can be send from warehouse to another on their own.</p>
|
|
|
|
<ul>
|
|
<li>Ground vehicles will use the road infrastructure. So a good road connection for both warehouses is important but also off road connections can be added if necessary.</li>
|
|
<li>Airborne units get a flightplan from the airbase of the sending warehouse to the airbase of the receiving warehouse. This already implies that for airborne
|
|
assets both warehouses need an airbase. If either one of the warehouses does not have an associated airbase, direct transportation of airborne assets is not possible.</li>
|
|
<li>Naval units can be exchanged between warehouses which possess a port, which can be defined by the user. Also shipping lanes must be specified manually but the user since DCS does not provide these.</li>
|
|
<li>Trains (would) use the available railroad infrastructure and both warehouses must have a connection to the railroad. Unfortunately, however, trains are not yet implemented to
|
|
a reasonable degree in DCS at the moment and hence cannot be used yet.</li>
|
|
</ul>
|
|
|
|
<p>Furthermore, ground assets can be transferred between warehouses by transport units. These are APCs, helicopters and airplanes. The transportation process is modeled
|
|
in a realistic way by using the corresponding cargo dispatcher classes, i.e.</p>
|
|
|
|
<ul>
|
|
<li><a href="AI.AI_Cargo_Dispatcher_APC.html##(AI_DISPATCHER_APC)">AI.AI_Cargo_Dispatcher_APC#AI_DISPATCHER_APC</a></li>
|
|
<li><a href="AI.AI_Cargo_Dispatcher_Helicopter.html##(AI_DISPATCHER_HELICOPTER)">AI.AI_Cargo_Dispatcher_Helicopter#AI_DISPATCHER_HELICOPTER</a></li>
|
|
<li><a href="AI.AI_Cargo_Dispatcher_Airplane.html##(AI_DISPATCHER_AIRPLANE)">AI.AI_Cargo_Dispatcher_Airplane#AI_DISPATCHER_AIRPLANE</a></li>
|
|
</ul>
|
|
|
|
<p>Depending on which cargo dispatcher is used (ground or airbore), similar considerations like in the self propelled case are necessary. Howver, note that
|
|
the dispatchers as of yet cannot use user defined off road paths for example since they are classes of their own and use a different routing logic.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Creating a Warehouse</h1>
|
|
|
|
<p>A MOOSE warehouse must be represented in game by a physical <em>static</em> object. For example, the mission editor already has warehouse as static object available.
|
|
This would be a good first choice but any static object will do.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Static.png" alt="Banner Image"/></p>
|
|
|
|
<p>The positioning of the warehouse static object is very important for a couple of reasons. Firstly, a warehouse needs a good infrastructure so that spawned assets
|
|
have a proper road connection or can reach the associated airbase easily.</p>
|
|
|
|
<h2>Constructor and Start</h2>
|
|
|
|
<p>Once the static warehouse object is placed in the mission editor it can be used as a MOOSE warehouse by the <a href="##(WAREHOUSE).New">WAREHOUSE.New</a>(<em>warehousestatic</em>, <em>alias</em>) constructor,
|
|
like for example:</p>
|
|
|
|
<pre><code>warehouseBatumi=WAREHOUSE:New(STATIC:FindByName("Warehouse Batumi"), "My optional Warehouse Alias")
|
|
warehouseBatumi:Start()
|
|
</code></pre>
|
|
|
|
<p>The first parameter <em>warehousestatic</em> is the static MOOSE object. By default, the name of the warehouse will be the same as the name given to the static object.
|
|
The second parameter <em>alias</em> is optional and can be used to choose a more convenient name if desired. This will be the name the warehouse calls itself when reporting messages.</p>
|
|
|
|
<p>Note that a warehouse also needs to be started in order to be in service. This is done with the <a href="##(WAREHOUSE).Start">WAREHOUSE.Start</a>() or <a href="##(WAREHOUSE).__Start">WAREHOUSE.__Start</a>(<em>delay</em>) functions.
|
|
The warehouse is now fully operational and requests are being processed.</p>
|
|
|
|
<h1>Adding Assets</h1>
|
|
|
|
<p>Assets can be added to the warehouse stock by using the <a href="##(WAREHOUSE).AddAsset">WAREHOUSE.AddAsset</a>(<em>group</em>, <em>ngroups</em>, <em>forceattribute</em>, <em>forcecargobay</em>, <em>forceweight</em>, <em>loadradius</em>, <em>skill</em>, <em>liveries</em>, <em>assignment</em>) function.
|
|
The parameter <em>group</em> has to be a MOOSE <a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>. This is also the only mandatory parameters. All other parameters are optional and can be used for fine tuning if
|
|
nessary. The parameter <em>ngroups</em> specifies how many clones of this group are added to the stock.</p>
|
|
|
|
<pre><code>infrantry=GROUP:FindByName("Some Infantry Group")
|
|
warehouseBatumi:AddAsset(infantry, 5)
|
|
</code></pre>
|
|
|
|
<p>This will add five infantry groups to the warehouse stock. Note that the group should normally be a late activated template group,
|
|
which was defined in the mission editor. But you can also add other groups which are already spawned and present in the mission.</p>
|
|
|
|
<p>Also note that the coalition of the template group (red, blue or neutral) does not matter. The coalition of the assets is determined by the coalition of the warehouse owner.
|
|
In other words, it is no problem to add red groups to blue warehouses and vice versa. The assets will automatically have the coalition of the warehouse.</p>
|
|
|
|
<p>You can add assets with a delay by using the <a href="##(WAREHOUSE).__AddAsset">WAREHOUSE.__AddAsset</a>(<em>delay</em>, <em>group</em>, <em>ngroups</em>, <em>forceattribute</em>, <em>forcecargobay</em>, <em>forceweight</em>, <em>loadradius</em>, <em>skill</em>, <em>liveries</em>, <em>assignment</em>),
|
|
where <em>delay</em> is the delay in seconds before the asset is added.</p>
|
|
|
|
<p>In game, the warehouse will get a mark which is regularly updated and showing the currently available assets in stock.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Stock-Marker.png" alt="Banner Image"/></p>
|
|
|
|
<h2>Optional Parameters for Fine Tuning</h2>
|
|
|
|
<p>By default, the generalized attribute of the asset is determined automatically from the DCS descriptor attributes. However, this might not always result in the desired outcome.
|
|
Therefore, it is possible, to force a generalized attribute for the asset with the third optional parameter <em>forceattribute</em>, which is of type <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
<h3>Setting the Generalized Attibute</h3>
|
|
<p>For example, a UH-1H Huey has in DCS the attibute of an attack helicopter. But of course, it can also transport cargo. If you want to use it for transportation, you can specify this
|
|
manually when the asset is added</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Huey", 5, WAREHOUSE.Attribute.AIR_TRANSPORTHELO)
|
|
</code></pre>
|
|
|
|
<p>This becomes important when assets are requested from other warehouses as described below. In this case, the five Hueys are now marked as transport helicopters and
|
|
not attack helicopters. This is also particularly useful when adding assets to a warehouse with the intention of using them to transport other units that are part of
|
|
a subsequent request (see below). Setting the attribute will help to ensure that warehouse module can find the correct unit when attempting to service a request in its
|
|
queue. For example, if we want to add an Amphibious Landing Ship, even though most are indeed armed, it's recommended to do the following:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Landing Ship", 1, WAREHOUSE.Attribute.NAVAL_UNARMEDSHIP)
|
|
</code></pre>
|
|
|
|
<p>Then when adding the request, you can simply specify WAREHOUSE.TransportType.SHIP (which corresponds to NAVAL_UNARMEDSHIP) as the TransportType.</p>
|
|
|
|
<h3>Setting the Cargo Bay Weight Limit</h3>
|
|
<p>You can ajust the cargo bay weight limit, in case it is not calculated correctly automatically. For example, the cargo bay of a C-17A is much smaller in DCS than that of a C-130, which is
|
|
unrealistic. This can be corrected by the <em>forcecargobay</em> parmeter which is here set to 77,000 kg</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("C-17A", nil, nil, 77000)
|
|
</code></pre>
|
|
|
|
<p>The size of the cargo bay is only important when the group is used as transport carrier for other assets.</p>
|
|
|
|
<h3>Setting the Weight</h3>
|
|
<p>If an asset shall be transported by a carrier it important to note that - as in real life - a carrier can only carry cargo up to a certain weight. The weight of the
|
|
units is automatically determined from the DCS descriptor table.
|
|
However, in the current DCS version (2.5.3) a mortar unit has a weight of 5 tons. This confuses the transporter logic, because it appears to be too have for, e.g. all APCs.</p>
|
|
|
|
<p>As a workaround, you can manually adjust the weight by the optional <em>forceweight</em> parameter:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Mortar Alpha", nil, nil, nil, 210)
|
|
</code></pre>
|
|
|
|
<p> In this case we set it to 210 kg. Note, the weight value set is meant for <em>each</em> unit in the group. Therefore, a group consisting of three mortars will have a total weight
|
|
of 630 kg. This is important as groups cannot be split between carrier units when transporting, i.e. the total weight of the whole group must be smaller than the
|
|
cargo bay of the transport carrier.</p>
|
|
|
|
<h3>Setting the Load Radius</h3>
|
|
<p>Boading and loading of cargo into a carrier is modeled in a realistic fashion in the AI_CARGO\DISPATCHER classes, which are used inernally by the WAREHOUSE class.
|
|
Meaning that troops (cargo) will board, i.e. run or drive to the carrier, and only once they are in close proximity to the transporter they will be loaded (disappear).</p>
|
|
|
|
<p>Unfortunately, there are some situations where problems can occur. For example, in DCS tanks have the strong tentendcy not to drive around obstacles but rather to roll over them.
|
|
I have seen cases where an aircraft of the same coalition as the tank was in its way and the tank drove right through the plane waiting on a parking spot and destroying it.</p>
|
|
|
|
<p>As a workaround it is possible to set a larger load radius so that the cargo units are despawned further away from the carrier via the optional <strong>loadradius</strong> parameter:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Leopard 2", nil, nil, nil, nil, 250)
|
|
</code></pre>
|
|
|
|
<p>Adding the asset like this will cause the units to be loaded into the carrier already at a distance of 250 meters.</p>
|
|
|
|
<h3>Setting the AI Skill</h3>
|
|
|
|
<p>By default, the asset has the skill of its template group. The optional parameter <em>skill</em> allows to set a different skill when the asset is added. See the
|
|
<a href="https://wiki.hoggitworld.com/view/DCS_enum_AI">hoggit page</a> possible values of this enumerator.
|
|
For example you can use</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Leopard 2", nil, nil, nil, nil, nil, AI.Skill.EXCELLENT)
|
|
</code></pre>
|
|
|
|
<p>do set the skill of the asset to excellent.</p>
|
|
|
|
<h3>Setting Liveries</h3>
|
|
|
|
<p>By default ,the asset uses the livery of its template group. The optional parameter <em>liveries</em> allows to define one or multiple liveries.
|
|
If multiple liveries are given in form of a table of livery names, each asset gets a random one.</p>
|
|
|
|
<p>For example</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Mi-8", nil, nil, nil, nil, nil, nil, "China UN")
|
|
</code></pre>
|
|
|
|
<p>would spawn the asset with a Chinese UN livery.</p>
|
|
|
|
<p>Or</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Mi-8", nil, nil, nil, nil, nil, nil, {"China UN", "German"})
|
|
</code></pre>
|
|
|
|
<p>would spawn the asset with either a Chinese UN or German livery. Mind the curly brackets <strong>{}</strong> when you want to specify multiple liveries.</p>
|
|
|
|
<p>Four each unit type, the livery names can be found in the DCS root folder under Bazar\Liveries. You have to use the name of the livery subdirectory. The names of the liveries
|
|
as displayed in the mission editor might be different and won't work in general.</p>
|
|
|
|
<h3>Setting an Assignment</h3>
|
|
|
|
<p>Assets can be added with a specific assignment given as a text, e.g.</p>
|
|
|
|
<pre><code>warehouseBatumi:AddAsset("Mi-8", nil, nil, nil, nil, nil, nil, nil, "Go to Warehouse Kobuleti")
|
|
</code></pre>
|
|
|
|
<p>This is helpful to establish supply chains once an asset has arrived at its (first) destination and is meant to be forwarded to another warehouse.</p>
|
|
|
|
<h2>Retrieving the Asset</h2>
|
|
|
|
<p>Once a an asset is added to a warehouse, the <a href="##(WAREHOUSE).NewAsset">WAREHOUSE.NewAsset</a> event is triggered. You can hook into this event with the <a href="##(WAREHOUSE).OnAfterNewAsset">WAREHOUSE.OnAfterNewAsset</a>(<em>asset</em>, <em>assignment</em>) function.</p>
|
|
|
|
<p>The first parameter <em>asset</em> is a table of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a> and contains a lot of information about the asset. The seconed parameter <em>assignment</em> is optional and is the specific
|
|
assignment the asset got when it was added.</p>
|
|
|
|
<p>Note that the assignment is can also be the assignment that was specified when adding a request (see next section). Once an asset that was requested from another warehouse and an assignment
|
|
was specified in the <a href="##(WAREHOUSE).AddRequest">WAREHOUSE.AddRequest</a> function, the assignment can be checked when the asset has arrived and is added to the receiving warehouse.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Requesting Assets</h1>
|
|
|
|
<p>Assets of the warehouse can be requested by other MOOSE warehouses. A request will first be scrutinized to check if can be fulfilled at all. If the request is valid, it is
|
|
put into the warehouse queue and processed as soon as possible.</p>
|
|
|
|
<p>Requested assets spawn in various "Rule of Engagement Rules" (ROE) and Alerts modes. If your assets will cross into dangerous areas, be sure to change these states. You can do this in <a href="##(WAREHOUSE)">#WAREHOUSE</a>(*From, *Event, *To, *group, *asset, *request)) function.</p>
|
|
|
|
<p>Initial Spawn states is as follows:
|
|
GROUND: ROE, "Return Fire" Alarm, "Green"
|
|
AIR: ROE, "Return Fire" Reaction to Threat, "Passive Defense"
|
|
NAVAL ROE, "Return Fire" Alarm,"N/A"</p>
|
|
|
|
<p>A request can be added by the <a href="##(WAREHOUSE).AddRequest">WAREHOUSE.AddRequest</a>(<em>warehouse</em>, <em>AssetDescriptor</em>, <em>AssetDescriptorValue</em>, <em>nAsset</em>, <em>TransportType</em>, <em>nTransport</em>, <em>Prio</em>, <em>Assignment</em>) function.
|
|
The parameters are</p>
|
|
|
|
<ul>
|
|
<li><em>warehouse</em>: The requesting MOOSE <a href="##(WAREHOUSE)">#WAREHOUSE</a>. Assets will be delivered there.</li>
|
|
<li><em>AssetDescriptor</em>: The descriptor to describe the asset "type". See the <a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a> enumerator. For example, assets requested by their generalized attibute.</li>
|
|
<li><em>AssetDescriptorValue</em>: The value of the asset descriptor.</li>
|
|
<li><em>nAsset</em>: (Optional) Number of asset group requested. Default is one group.</li>
|
|
<li><em>TransportType</em>: (Optional) The transport method used to deliver the assets to the requestor. Default is that assets go to the requesting warehouse on their own.</li>
|
|
<li><em>nTransport</em>: (Optional) Number of asset groups used to transport the cargo assets from A to B. Default is one group.</li>
|
|
<li><em>Prio</em>: (Optional) A number between 1 (high) and 100 (low) describing the priority of the request. Request with high priority are processed first. Default is 50, i.e. medium priority.</li>
|
|
<li><em>Assignment</em>: (Optional) A free to choose string describing the assignment. For self requests, this can be used to assign the spawned groups to specific tasks.</li>
|
|
</ul>
|
|
|
|
<h2>Requesting by Generalized Attribute</h2>
|
|
|
|
<p>Generalized attributes are similar to <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">DCS attributes</a>. However, they are a bit more general and
|
|
an asset can only have one generalized attribute by which it is characterized.</p>
|
|
|
|
<p>For example:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseKobuleti, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 5, WAREHOUSE.TransportType.APC, 2)
|
|
</code></pre>
|
|
|
|
<p>Here, warehouse Kobuleti requests 5 infantry groups from warehouse Batumi. These "cargo" assets should be transported from Batumi to Kobuleti by 2 APCS.
|
|
Note that the warehouse at Batumi needs to have at least five infantry groups and two APC groups in their stock if the request can be processed.
|
|
If either to few infantry or APC groups are available when the request is made, the request is held in the warehouse queue until enough cargo and
|
|
transport assets are available.</p>
|
|
|
|
<p>Also note that the above request is for five infantry groups. So any group in stock that has the generalized attribute "GROUND_INFANTRY" can be selected for the request.</p>
|
|
|
|
<h3>Generalized Attributes</h3>
|
|
|
|
<p>Currently implemented are:</p>
|
|
|
|
<ul>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_TRANSPORTPLANE">WAREHOUSE.Attribute.AIR_TRANSPORTPLANE</a> Airplane with transport capability. This can be used to transport other assets.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_AWACS">WAREHOUSE.Attribute.AIR_AWACS</a> Airborne Early Warning and Control System.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_FIGHTER">WAREHOUSE.Attribute.AIR_FIGHTER</a> Fighter, interceptor, ... airplane.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_BOMBER">WAREHOUSE.Attribute.AIR_BOMBER</a> Aircraft which can be used for strategic bombing.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_TANKER">WAREHOUSE.Attribute.AIR_TANKER</a> Airplane which can refuel other aircraft.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_TRANSPORTHELO">WAREHOUSE.Attribute.AIR_TRANSPORTHELO</a> Helicopter with transport capability. This can be used to transport other assets.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_ATTACKHELO">WAREHOUSE.Attribute.AIR_ATTACKHELO</a> Attack helicopter.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_UAV">WAREHOUSE.Attribute.AIR_UAV</a> Unpiloted Aerial Vehicle, e.g. drones.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).AIR_OTHER">WAREHOUSE.Attribute.AIR_OTHER</a> Any airborne unit that does not fall into any other airborne category.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_APC">WAREHOUSE.Attribute.GROUND_APC</a> Infantry carriers, in particular Amoured Personell Carrier. This can be used to transport other assets.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_TRUCK">WAREHOUSE.Attribute.GROUND_TRUCK</a> Unarmed ground vehicles, which has the DCS "Truck" attribute.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_INFANTRY">WAREHOUSE.Attribute.GROUND_INFANTRY</a> Ground infantry assets.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_IFV">WAREHOUSE.Attribute.GROUND_IFV</a> Ground infantry fighting vehicle.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_ARTILLERY">WAREHOUSE.Attribute.GROUND_ARTILLERY</a> Artillery assets.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_TANK">WAREHOUSE.Attribute.GROUND_TANK</a> Tanks (modern or old).</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_TRAIN">WAREHOUSE.Attribute.GROUND_TRAIN</a> Trains. Not that trains are <strong>not</strong> yet properly implemented in DCS and cannot be used currently.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_EWR">WAREHOUSE.Attribute.GROUND_EWR</a> Early Warning Radar.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_AAA">WAREHOUSE.Attribute.GROUND_AAA</a> Anti-Aircraft Artillery.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_SAM">WAREHOUSE.Attribute.GROUND_SAM</a> Surface-to-Air Missile system or components.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).GROUND_OTHER">WAREHOUSE.Attribute.GROUND_OTHER</a> Any ground unit that does not fall into any other ground category.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).NAVAL_AIRCRAFTCARRIER">WAREHOUSE.Attribute.NAVAL_AIRCRAFTCARRIER</a> Aircraft carrier.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).NAVAL_WARSHIP">WAREHOUSE.Attribute.NAVAL_WARSHIP</a> War ship, i.e. cruisers, destroyers, firgates and corvettes.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).NAVAL_ARMEDSHIP">WAREHOUSE.Attribute.NAVAL_ARMEDSHIP</a> Any armed ship that is not an aircraft carrier, a cruiser, destroyer, firgatte or corvette.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).NAVAL_UNARMEDSHIP">WAREHOUSE.Attribute.NAVAL_UNARMEDSHIP</a> Any unarmed naval vessel.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).NAVAL_OTHER">WAREHOUSE.Attribute.NAVAL_OTHER</a> Any naval unit that does not fall into any other naval category.</li>
|
|
<li><a href="##(WAREHOUSE.Attribute).OTHER_UNKNOWN">WAREHOUSE.Attribute.OTHER_UNKNOWN</a> Anything that does not fall into any other category.</li>
|
|
</ul>
|
|
|
|
<h2>Requesting a Specific Unit Type</h2>
|
|
|
|
<p>A more specific request could look like:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseKobuleti, WAREHOUSE.Descriptor.UNITTYPE, "A-10C", 2)
|
|
</code></pre>
|
|
|
|
<p>Here, Kobuleti requests a specific unit type, in particular two groups of A-10Cs. Note that the spelling is important as it must exacly be the same as
|
|
what one get's when using the DCS unit type.</p>
|
|
|
|
<h2>Requesting a Specific Group</h2>
|
|
|
|
<p>An even more specific request would be:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseKobuleti, WAREHOUSE.Descriptor.GROUPNAME, "Group Name as in ME", 3)
|
|
</code></pre>
|
|
|
|
<p>In this case three groups named "Group Name as in ME" are requested. This explicitly request the groups named like that in the Mission Editor.</p>
|
|
|
|
<h2>Requesting a General Category</h2>
|
|
|
|
<p>On the other hand, very general and unspecifc requests can be made by the categroy descriptor. The descriptor value parameter can be any <a href="https://wiki.hoggitworld.com/view/DCS_Class_Group">group category</a>, i.e.</p>
|
|
|
|
<ul>
|
|
<li>Group.Category.AIRPLANE for fixed wing aircraft,</li>
|
|
<li>Group.Category.HELICOPTER for helicopters,</li>
|
|
<li>Group.Category.GROUND for all ground troops,</li>
|
|
<li>Group.Category.SHIP for naval assets,</li>
|
|
<li>Group.Category.TRAIN for trains (not implemented and not working in DCS yet).</li>
|
|
</ul>
|
|
|
|
<p>For example,</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseKobuleti, WAREHOUSE.Descriptor.CATEGORY, Group.Category.GROUND, 10)
|
|
</code></pre>
|
|
|
|
<p>means that Kubuleti requests 10 ground groups and does not care which ones. This could be a mix of infantry, APCs, trucks etc.</p>
|
|
|
|
<p><strong>Note</strong> that these general requests should be made with <em>great care</em> due to the fact, that depending on what a warehouse has in stock a lot of different unit types can be spawned.</p>
|
|
|
|
<h2>Requesting Relative Quantities</h2>
|
|
|
|
<p>In addition to requesting absolute numbers of assets it is possible to request relative amounts of assets currently in stock. To this end the <a href="##(WAREHOUSE).Quantity">WAREHOUSE.Quantity</a> enumerator
|
|
was introduced:</p>
|
|
|
|
<ul>
|
|
<li><a href="##(WAREHOUSE.Quantity).ALL">WAREHOUSE.Quantity.ALL</a></li>
|
|
<li><a href="##(WAREHOUSE.Quantity).HALF">WAREHOUSE.Quantity.HALF</a></li>
|
|
<li><a href="##(WAREHOUSE.Quantity).QUARTER">WAREHOUSE.Quantity.QUARTER</a></li>
|
|
<li><a href="##(WAREHOUSE.Quantity).THIRD">WAREHOUSE.Quantity.THIRD</a></li>
|
|
<li><a href="##(WAREHOUSE.Quantity).THREEQUARTERS">WAREHOUSE.Quantity.THREEQUARTERS</a></li>
|
|
</ul>
|
|
|
|
<p>For example,</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseKobuleti, WAREHOUSE.Descriptor.CATEGORY, Group.Category.HELICOPTER, WAREHOUSE.Quantity.HALF)
|
|
</code></pre>
|
|
|
|
<p>means that Kobuleti warehouse requests half of all available helicopters which Batumi warehouse currently has in stock.</p>
|
|
|
|
<h1>Employing Assets - The Self Request</h1>
|
|
|
|
<p>Transferring assets from one warehouse to another is important but of course once the the assets are at the "right" place it is equally important that they
|
|
can be employed for specific tasks and assignments.</p>
|
|
|
|
<p>Assets in the warehouses stock can be used for user defined tasks quite easily. They can be spawned into the game by a "<strong><em>self request</em></strong>", i.e. the warehouse
|
|
requests the assets from itself:</p>
|
|
|
|
<pre><code>warehouseBatumi:AddRequest(warehouseBatumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 5)
|
|
</code></pre>
|
|
|
|
<p>Note that the <em>sending</em> and <em>requesting</em> warehouses are <em>identical</em> in this case.</p>
|
|
|
|
<p>This would simply spawn five infantry groups in the spawn zone of the Batumi warehouse if/when they are available.</p>
|
|
|
|
<h2>Accessing the Assets</h2>
|
|
|
|
<p>If a warehouse requests assets from itself, it triggers the event <strong>SelfReqeuest</strong>. The mission designer can capture this event with the associated
|
|
<a href="##(WAREHOUSE).OnAfterSelfRequest">WAREHOUSE.OnAfterSelfRequest</a>(<em>From</em>, <em>Event</em>, <em>To</em>, <em>groupset</em>, <em>request</em>) function.</p>
|
|
|
|
<pre><code>--- OnAfterSelfRequest user function. Access groups spawned from the warehouse for further tasking.
|
|
-- @param #WAREHOUSE self
|
|
-- @param #string From From state.
|
|
-- @param #string Event Event.
|
|
-- @param #string To To state.
|
|
-- @param Core.Set#SET_GROUP groupset The set of cargo groups that was delivered to the warehouse itself.
|
|
-- @param #WAREHOUSE.Pendingitem request Pending self request.
|
|
function WAREHOUSE:OnAfterSelfRequest(From, Event, To, groupset, request)
|
|
local groupset=groupset --Core.Set#SET_GROUP
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
for _,group in pairs(groupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
group:SmokeGreen()
|
|
end
|
|
|
|
end
|
|
</code></pre>
|
|
|
|
<p>The variable <em>groupset</em> is a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> object and holds all asset groups from the request. The code above shows, how the mission designer can access the groups
|
|
for further tasking. Here, the groups are only smoked but, of course, you can use them for whatever assignment you fancy.</p>
|
|
|
|
<p>Note that airborne groups are spawned in <strong>uncontrolled state</strong> and need to be activated first before they can begin with their assigned tasks and missions.
|
|
This can be done with the <a href="Wrapper.Controllable.html##(CONTROLLABLE).StartUncontrolled">Wrapper.Controllable#CONTROLLABLE.StartUncontrolled</a> function as demonstrated in the example section below.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Infrastructure</h1>
|
|
|
|
<p>A good infrastructure is important for a warehouse to be efficient. Therefore, the location of a warehouse should be chosen with care.
|
|
This can also help to avoid many DCS related issues such as units getting stuck in buildings, blocking taxi ways etc.</p>
|
|
|
|
<h2>Spawn Zone</h2>
|
|
|
|
<p>By default, the zone were ground assets are spawned is a circular zone around the physical location of the warehouse with a radius of 200 meters. However, the location of the
|
|
spawn zone can be set by the <a href="##(WAREHOUSE).SetSpawnZone">WAREHOUSE.SetSpawnZone</a>(<em>zone</em>) functions. It is advisable to choose a zone which is clear of obstacles.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Batumi.png" alt="Banner Image"/></p>
|
|
|
|
<p>The parameter <em>zone</em> is a MOOSE <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> object. So one can, e.g., use trigger zones defined in the mission editor. If a cicular zone is not desired, one
|
|
can use a polygon zone (see <a href="Core.Zone.html##(ZONE_POLYGON)">Core.Zone#ZONE_POLYGON</a>).</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_SpawnPolygon.png" alt="Banner Image"/></p>
|
|
|
|
<h2>Road Connections</h2>
|
|
|
|
<p>Ground assets will use a road connection to travel from one warehouse to another. Therefore, a proper road connection is necessary.</p>
|
|
|
|
<p>By default, the closest point on road to the center of the spawn zone is chosen as road connection automatically. But only, if distance between the spawn zone
|
|
and the road connection is less than 3 km.</p>
|
|
|
|
<p>The user can set the road connection manually with the <a href="##(WAREHOUSE).SetRoadConnection">WAREHOUSE.SetRoadConnection</a> function. This is only functional for self propelled assets at the moment
|
|
and not if using the AI dispatcher classes since these have a different logic to find the route.</p>
|
|
|
|
<h2>Off Road Connections</h2>
|
|
|
|
<p>For ground troops it is also possible to define off road paths between warehouses if no proper road connection is available or should not be used.</p>
|
|
|
|
<p>An off road path can be defined via the <a href="##(WAREHOUSE).AddOffRoadPath">WAREHOUSE.AddOffRoadPath</a>(<em>remotewarehouse</em>, <em>group</em>, <em>oneway</em>) function, where
|
|
<em>remotewarehouse</em> is the warehouse to which the path leads.
|
|
The parameter <em>group</em> is a <em>late activated</em> template group. The waypoints of this group are used to define the path between the two warehouses.
|
|
By default, the reverse paths is automatically added to get <em>from</em> the remote warehouse <em>to</em> this warehouse unless the parameter <em>oneway</em> is set to <em>true</em>.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Off-Road_Paths.png" alt="Banner Image"/></p>
|
|
|
|
<p><strong>Note</strong> that if an off road connection is defined between two warehouses this becomes the default path, i.e. even if there is a path <em>on road</em> possible
|
|
this will not be used.</p>
|
|
|
|
<p>Also note that you can define multiple off road connections between two warehouses. If there are multiple paths defined, the connection is chosen randomly.
|
|
It is also possible to add the same path multiple times. By this you can influence the probability of the chosen path. For example Path1(A->B) has been
|
|
added two times while Path2(A->B) was added only once. Hence, the group will choose Path1 with a probability of 66.6 % while Path2 is only chosen with
|
|
a probability of 33.3 %.</p>
|
|
|
|
<h2>Rail Connections</h2>
|
|
|
|
<p>A rail connection is automatically defined as the closest point on a railway measured from the center of the spawn zone. But only, if the distance is less than 3 km.</p>
|
|
|
|
<p>The mission designer can manually specify a rail connection with the <a href="##(WAREHOUSE).SetRailConnection">WAREHOUSE.SetRailConnection</a> function.</p>
|
|
|
|
<p><strong>NOTE</strong> however, that trains in DCS are currently not implemented in a way so that they can be used.</p>
|
|
|
|
<h2>Air Connections</h2>
|
|
|
|
<p>In order to use airborne assets, a warehouse needs to have an associated airbase. This can be an airdrome, a FARP/HELOPAD or a ship.</p>
|
|
|
|
<p>If there is an airbase within 3 km range of the warehouse it is automatically set as the associated airbase. A user can set an airbase manually
|
|
with the <a href="##(WAREHOUSE).SetAirbase">WAREHOUSE.SetAirbase</a> function. Keep in mind that sometimes ground units need to walk/drive from the spawn zone to the airport
|
|
to get to their transport carriers.</p>
|
|
|
|
<h2>Naval Connections</h2>
|
|
|
|
<p>Natively, DCS does not have the concept of a port/habour or shipping lanes. So in order to have a meaningful transfer of naval units between warehouses, these have to be
|
|
defined by the mission designer.</p>
|
|
|
|
<h3>Defining a Port</h3>
|
|
|
|
<p>A port in this context is the zone where all naval assets are spawned. This zone can be defined with the function <a href="##(WAREHOUSE).SetPortZone">WAREHOUSE.SetPortZone</a>(<em>zone</em>), where the parameter
|
|
<em>zone</em> is a MOOSE zone. So again, this can be create from a trigger zone defined in the mission editor or if a general shape is desired by a <a href="Core.Zone.html##(ZONE_POLYGON)">Core.Zone#ZONE_POLYGON</a>.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_PortZone.png" alt="Banner Image"/></p>
|
|
|
|
<h3>Defining Shipping Lanes</h3>
|
|
|
|
<p>A shipping lane between to warehouses can be defined by the <a href="##(WAREHOUSE).AddShippingLane">WAREHOUSE.AddShippingLane</a>(<em>remotewarehouse</em>, <em>group</em>, <em>oneway</em>) function. The first parameter <em>remotewarehouse</em>
|
|
is the warehouse which should be connected to the present warehouse.</p>
|
|
|
|
<p>The parameter <em>group</em> should be a late activated group defined in the mission editor. The waypoints of this group are used as waypoints of the shipping lane.</p>
|
|
|
|
<p>By default, the reverse lane is automatically added to the remote warehouse. This can be disabled by setting the <em>oneway</em> parameter to <em>true</em>.</p>
|
|
|
|
<p>Similar to off road connections, you can also define multiple shipping lanes between two warehouse ports. If there are multiple lanes defined, one is chosen randomly.
|
|
It is possible to add the same lane multiple times. By this you can influence the probability of the chosen lane. For example Lane_1(A->B) has been
|
|
added two times while Lane_2(A->B) was added only once. Therefore, the ships will choose Lane_1 with a probability of 66.6 % while Path_2 is only chosen with
|
|
a probability of 33.3 %.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_ShippingLane.png" alt="Banner Image"/></p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Why is my request not processed?</h1>
|
|
|
|
<p>For each request, the warehouse class logic does a lot of consistency and validation checks under the hood.
|
|
This helps to circumvent a lot of DCS issues and shortcomings. For example, it is checked that enough free
|
|
parking spots at an airport are available <em>before</em> the assets are spawned.
|
|
However, this also means that sometimes a request is deemed to be <em>invalid</em> in which case they are deleted
|
|
from the queue or considered to be valid but cannot be executed at this very moment.</p>
|
|
|
|
<h2>Invalid Requests</h2>
|
|
|
|
<p>Invalid request are requests which can <strong>never</strong> be processes because there is some logical or physical argument against it.
|
|
(Or simply because that feature was not implemented (yet).)</p>
|
|
|
|
<ul>
|
|
<li>All airborne assets need an associated airbase of any kind on the sending <em>and</em> receiving warehouse.</li>
|
|
<li>Airplanes need an airdrome at the sending and receiving warehouses.</li>
|
|
<li>Not enough parking spots of the right terminal type at the sending warehouse. This avoids planes spawning on runways or on top of each other.</li>
|
|
<li>No parking spots of the right terminal type at the receiving warehouse. This avoids DCS despawning planes on landing if they have no valid parking spot.</li>
|
|
<li>Ground assets need a road connection between both warehouses or an off-road path needs to be added manually.</li>
|
|
<li>Ground assets cannot be send directly to ships, i.e. warehouses on ships.</li>
|
|
<li>Naval units need a user defined shipping lane between both warehouses.</li>
|
|
<li>Warehouses need a user defined port zone to spawn naval assets.</li>
|
|
<li>The receiving warehouse is destroyed or stopped.</li>
|
|
<li>If transport by airplane, both warehouses must have and airdrome.</li>
|
|
<li>If transport by APC, both warehouses must have a road connection.</li>
|
|
<li>If transport by helicopter, the sending airbase must have an associated airbase (airdrome or FARP).</li>
|
|
</ul>
|
|
|
|
<p>All invalid requests are cancelled and <strong>removed</strong> from the warehouse queue!</p>
|
|
|
|
<h2>Temporarily Unprocessable Requests</h2>
|
|
|
|
<p>Temporarily unprocessable requests are possible in principle, but cannot be processed at the given time the warehouse checks its queue.</p>
|
|
|
|
<ul>
|
|
<li>No enough parking spaces are available for all requested assets but the airbase has enough parking spots in total so that this request is possible once other aircraft have taken off.</li>
|
|
<li>The requesting warehouse is not in state "Running" (could be paused, not yet started or under attack).</li>
|
|
<li>Not enough cargo assets available at this moment.</li>
|
|
<li>Not enough free parking spots for all cargo or transport airborne assets at the moment.</li>
|
|
<li>Not enough transport assets to carry all cargo assets.</li>
|
|
</ul>
|
|
|
|
<p>Temporarily unprocessable requests are held in the queue. If at some point in time, the situation changes so that these requests can be processed, they are executed.</p>
|
|
|
|
<h2>Cargo Bay and Weight Limitations</h2>
|
|
|
|
<p>The transportation of cargo is handled by the AI_Dispatcher classes. These take the cargo bay of a carrier and the weight of
|
|
the cargo into account so that a carrier can only load a realistic amount of cargo.</p>
|
|
|
|
<p>However, if troops are supposed to be transported between warehouses, there is one important limitations one has to keep in mind.
|
|
This is that <strong>cargo asset groups cannot be split</strong> and divided into separate carrier units!</p>
|
|
|
|
<p>For example, a TPz Fuchs has a cargo bay large enough to carry up to 10 soldiers at once, which is a realistic number.
|
|
If a group consisting of more than ten soldiers needs to be transported, it cannot be loaded into the APC.
|
|
Even if two APCs are available, which could in principle carry up to 20 soldiers, a group of, let's say 12 soldiers will not
|
|
be split into a group of ten soldiers using the first APC and a group two soldiers using the second APC.</p>
|
|
|
|
<p>In other words, <strong>there must be at least one carrier unit available that has a cargo bay large enough to load the heaviest cargo group!</strong>
|
|
The warehouse logic will automatically search all available transport assets for a large enough carrier.
|
|
But if none is available, the request will be queued until a suitable carrier becomes available.</p>
|
|
|
|
<p>The only realistic solution in this case is to either provide a transport carrier with a larger cargo bay or to reduce the number of soldiers
|
|
in the group.</p>
|
|
|
|
<p>A better way would be to have two groups of max. 10 soldiers each and one TPz Fuchs for transport. In this case, the first group is
|
|
loaded and transported to the receiving warehouse. Once this is done, the carrier will drive back and pick up the remaining
|
|
group.</p>
|
|
|
|
<p>As an artificial workaround one can manually set the cargo bay size to a larger value or alternatively reduce the weight of the cargo
|
|
when adding the assets via the <a href="##(WAREHOUSE).AddAsset">WAREHOUSE.AddAsset</a> function. This might even be unavoidable if, for example, a SAM group
|
|
should be transported since SAM sites only work when all units are in the same group.</p>
|
|
|
|
<h2>Processing Speed</h2>
|
|
|
|
<p>A warehouse has a limited speed to process requests. Each time the status of the warehouse is updated only one requests is processed.
|
|
The time interval between status updates is 30 seconds by default and can be adjusted via the <a href="##(WAREHOUSE).SetStatusUpdate">WAREHOUSE.SetStatusUpdate</a>(<em>interval</em>) function.
|
|
However, the status is also updated on other occasions, e.g. when a new request was added.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Strategic Considerations</h1>
|
|
|
|
<p>Due to the fact that a warehouse holds (or can hold) a lot of valuable assets, it makes a (potentially) juicy target for enemy attacks.
|
|
There are several interesting situations, which can occur.</p>
|
|
|
|
<h2>Capturing a Warehouses Airbase</h2>
|
|
|
|
<p>If a warehouse has an associated airbase, it can be captured by the enemy. In this case, the warehouse looses its ability so employ all airborne assets and is also cut-off
|
|
from supply by airplanes. Supply of ground troops via helicopters is still possible, because they deliver the troops into the spawn zone.</p>
|
|
|
|
<p>Technically, the capturing of the airbase is triggered by the DCS <a href="https://wiki.hoggitworld.com/view/DCS_event_base_captured">S_EVENT_BASE_CAPTURED</a> event.
|
|
So the capturing takes place when only enemy ground units are in the airbase zone whilst no ground units of the present airbase owner are in that zone.</p>
|
|
|
|
<p>The warehouse will also create an event <strong>AirbaseCaptured</strong>, which can be captured by the <a href="##(WAREHOUSE).OnAfterAirbaseCaptured">WAREHOUSE.OnAfterAirbaseCaptured</a> function. So the warehouse chief can react on
|
|
this attack and for example deploy ground groups to re-capture its airbase.</p>
|
|
|
|
<p>When an airbase is re-captured the event <strong>AirbaseRecaptured</strong> is triggered and can be captured by the <a href="##(WAREHOUSE).OnAfterAirbaseRecaptured">WAREHOUSE.OnAfterAirbaseRecaptured</a> function.
|
|
This can be used to put the defending assets back into the warehouse stock.</p>
|
|
|
|
<h2>Capturing the Warehouse</h2>
|
|
|
|
<p>A warehouse can be captured by the enemy coalition. If enemy ground troops enter the warehouse zone the event <strong>Attacked</strong> is triggered which can be captured by the
|
|
<a href="##(WAREHOUSE).OnAfterAttacked">WAREHOUSE.OnAfterAttacked</a> event. By default the warehouse zone circular zone with a radius of 500 meters located at the center of the physical warehouse.
|
|
The warehouse zone can be set via the <a href="##(WAREHOUSE).SetWarehouseZone">WAREHOUSE.SetWarehouseZone</a>(<em>zone</em>) function. The parameter <em>zone</em> must also be a circular zone.</p>
|
|
|
|
<p>The <a href="##(WAREHOUSE).OnAfterAttacked">WAREHOUSE.OnAfterAttacked</a> function can be used by the mission designer to react to the enemy attack. For example by deploying some or all ground troops
|
|
currently in stock to defend the warehouse. Note that the warehouse also has a self defence option which can be enabled by the <a href="##(WAREHOUSE).SetAutoDefenceOn">WAREHOUSE.SetAutoDefenceOn</a>()
|
|
function. In this case, the warehouse will automatically spawn all ground troops. If the spawn zone is further away from the warehouse zone, all mobile troops
|
|
are routed to the warehouse zone. The self request which is triggered on an automatic defence has the assignment "AutoDefence". So you can use this to
|
|
give orders to the groups that were spawned using the <a href="##(WAREHOUSE).OnAfterSelfRequest">WAREHOUSE.OnAfterSelfRequest</a> function.</p>
|
|
|
|
<p>If only ground troops of the enemy coalition are present in the warehouse zone, the warehouse and all its assets falls into the hands of the enemy.
|
|
In this case the event <strong>Captured</strong> is triggered which can be captured by the <a href="##(WAREHOUSE).OnAfterCaptured">WAREHOUSE.OnAfterCaptured</a> function.</p>
|
|
|
|
<p>The warehouse turns to the capturing coalition, i.e. its physical representation, and all assets as well. In particular, all requests to the warehouse will
|
|
spawn assets belonging to the new owner.</p>
|
|
|
|
<p>If the enemy troops could be defeated, i.e. no more troops of the opposite coalition are in the warehouse zone, the event <strong>Defeated</strong> is triggered and
|
|
the <a href="##(WAREHOUSE).OnAfterDefeated">WAREHOUSE.OnAfterDefeated</a> function can be used to adapt to the new situation. For example putting back all spawned defender troops back into
|
|
the warehouse stock. Note that if the automatic defence is enabled, all defenders are automatically put back into the warehouse on the <strong>Defeated</strong> event.</p>
|
|
|
|
<h2>Destroying a Warehouse</h2>
|
|
|
|
<p>If an enemy destroy the physical warehouse structure, the warehouse will of course stop all its services. In principle, all assets contained in the warehouse are
|
|
gone as well. So a warehouse should be properly defended.</p>
|
|
|
|
<p>Upon destruction of the warehouse, the event <strong>Destroyed</strong> is triggered, which can be captured by the <a href="##(WAREHOUSE).OnAfterDestroyed">WAREHOUSE.OnAfterDestroyed</a> function.
|
|
So the mission designer can intervene at this point and for example choose to spawn all or particular types of assets before the warehouse is gone for good.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Hook in and Take Control</h1>
|
|
|
|
<p>The Finite State Machine implementation allows mission designers to hook into important events and add their own code.
|
|
Most of these events have already been mentioned but here is the list at a glance:</p>
|
|
|
|
<ul>
|
|
<li>"NotReadyYet" --> "Start" --> "Running" (Starting the warehouse)</li>
|
|
<li>"*" --> "Status" --> "*" (status updated in regular intervals)</li>
|
|
<li>"*" --> "AddAsset" --> "*" (adding a new asset to the warehouse stock)</li>
|
|
<li>"*" --> "NewAsset" --> "*" (a new asset has been added to the warehouse stock)</li>
|
|
<li>"*" --> "AddRequest" --> "*" (adding a request for the warehouse assets)</li>
|
|
<li>"Running" --> "Request" --> "*" (a request is processed when the warehouse is running)</li>
|
|
<li>"Attacked" --> "Request" --> "*" (a request is processed when the warehouse is attacked)</li>
|
|
<li>"*" --> "Arrived" --> "*" (asset group has arrived at its destination)</li>
|
|
<li>"*" --> "Delivered" --> "*" (all assets of a request have been delivered)</li>
|
|
<li>"Running" --> "SelfRequest" --> "*" (warehouse is requesting asset from itself when running)</li>
|
|
<li>"Attacked" --> "SelfRequest" --> "*" (warehouse is requesting asset from itself while under attack)</li>
|
|
<li>"*" --> "Attacked" --> "Attacked" (warehouse is being attacked)</li>
|
|
<li>"Attacked" --> "Defeated" --> "Running" (an attack was defeated)</li>
|
|
<li>"Attacked" --> "Captured" --> "Running" (warehouse was captured by the enemy)</li>
|
|
<li>"*" --> "AirbaseCaptured" --> "*" (airbase belonging to the warehouse was captured by the enemy)</li>
|
|
<li>"*" --> "AirbaseRecaptured" --> "*" (airbase was re-captured)</li>
|
|
<li>"*" --> "AssetSpawned" --> "*" (an asset has been spawned into the world)</li>
|
|
<li>"*" --> "AssetLowFuel" --> "*" (an asset is running low on fuel)</li>
|
|
<li>"*" --> "AssetDead" --> "*" (a whole asset, i.e. all its units/groups, is dead)</li>
|
|
<li>"*" --> "Destroyed" --> "Destroyed" (warehouse was destroyed)</li>
|
|
<li>"Running" --> "Pause" --> "Paused" (warehouse is paused)</li>
|
|
<li>"Paused" --> "Unpause" --> "Running" (warehouse is unpaused)</li>
|
|
<li>"*" --> "Stop" --> "Stopped" (warehouse is stopped)</li>
|
|
</ul>
|
|
|
|
<p>The transitions are of the general form "From State" --> "Event" --> "To State". The "<em>" star denotes that the transition is possible from *any</em> state.
|
|
Some transitions, however, are only allowed from certain "From States". For example, no requests can be processed if the warehouse is in "Paused" or "Destroyed" or "Stopped" state.</p>
|
|
|
|
<p>Mission designers can capture the events with OnAfterEvent functions, e.g. <a href="##(WAREHOUSE).OnAfterDelivered">WAREHOUSE.OnAfterDelivered</a> or <a href="##(WAREHOUSE).OnAfterAirbaseCaptured">WAREHOUSE.OnAfterAirbaseCaptured</a>.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Persistence of Assets</h1>
|
|
|
|
<p>Assets in stock of a warehouse can be saved to a file on your hard drive and then loaded from that file at a later point. This enables to restart the mission
|
|
and restore the warehouse stock.</p>
|
|
|
|
<h2>Prerequisites</h2>
|
|
|
|
<p><strong>Important</strong> By default, DCS does not allow for writing data to files. Therefore, one first has to comment out the line "sanitizeModule('io')", i.e.</p>
|
|
|
|
<pre><code>do
|
|
sanitizeModule('os')
|
|
--sanitizeModule('io')
|
|
sanitizeModule('lfs')
|
|
require = nil
|
|
loadlib = nil
|
|
end
|
|
</code></pre>
|
|
|
|
<p>in the file "MissionScripting.lua", which is located in the subdirectory "Scripts" of your DCS installation root directory.</p>
|
|
|
|
<h3>Don't!</h3>
|
|
|
|
<p>Do not use <strong>semi-colons</strong> or <strong>equal signs</strong> in the group names of your assets as these are used as separators in the saved and loaded files texts.
|
|
If you do, it will cause problems and give you a headache!</p>
|
|
|
|
<h2>Save Assets</h2>
|
|
|
|
<p>Saving asset data to file is achieved by the <a href="##(WAREHOUSE).Save">WAREHOUSE.Save</a>(<em>path</em>, <em>filename</em>) function. The parameter <em>path</em> specifies the path on the file system where the
|
|
warehouse data is saved. If you do not specify a path, the file is saved your the DCS installation root directory.
|
|
The parameter <em>filename</em> is optional and defines the name of the saved file. By default this is automatically created from the warehouse id and name, for example
|
|
"Warehouse-1234_Batumi.txt".</p>
|
|
|
|
<pre><code>warehouseBatumi:Save("D:\\My Warehouse Data\\")
|
|
</code></pre>
|
|
|
|
<p>This will save all asset data to in "D:\My Warehouse Data\Warehouse-1234_Batumi.txt".</p>
|
|
|
|
<h3>Automatic Save at Mission End</h3>
|
|
|
|
<p>The assets can be saved automatically when the mission is ended via the <a href="##(WAREHOUSE).SetSaveOnMissionEnd">WAREHOUSE.SetSaveOnMissionEnd</a>(<em>path</em>, <em>filename</em>) function, i.e.</p>
|
|
|
|
<pre><code>warehouseBatumi:SetSaveOnMissionEnd("D:\\My Warehouse Data\\")
|
|
</code></pre>
|
|
|
|
<h2>Load Assets</h2>
|
|
|
|
<p>Loading assets data from file is achieved by the <a href="##(WAREHOUSE).Load">WAREHOUSE.Load</a>(<em>path</em>, <em>filename</em>) function. The parameter <em>path</em> specifies the path on the file system where the
|
|
warehouse data is loaded from. If you do not specify a path, the file is loaded from your the DCS installation root directory.
|
|
The parameter <em>filename</em> is optional and defines the name of the file to load. By default this is automatically generated from the warehouse id and name, for example
|
|
"Warehouse-1234_Batumi.txt".</p>
|
|
|
|
<p>Note that the warehouse <strong>must not be started</strong> and in the <em>Running</em> state in order to load the assets. In other words, loading should happen after the
|
|
<a href="##(WAREHOUSE).New">WAREHOUSE.New</a> command is specified in the code but before the <a href="##(WAREHOUSE).Start">WAREHOUSE.Start</a> command is given.</p>
|
|
|
|
<p>Loading the assets is done by</p>
|
|
|
|
<pre><code>warehouseBatumi:New(STATIC:FindByName("Warehouse Batumi"))
|
|
warehouseBatumi:Load("D:\\My Warehouse Data\\")
|
|
warehouseBatumi:Start()
|
|
</code></pre>
|
|
|
|
<p>This sequence loads all assets from file. If a warehouse was captured in the last mission, it also respawns the static warehouse structure with the right coalition.
|
|
However, it due to DCS limitations it is not possible to set the airbase coalition. This has to be done manually in the mission editor. Or alternatively, one could
|
|
spawn some ground units via a self request and let them capture the airbase.</p>
|
|
|
|
<hr/>
|
|
|
|
<h1>Examples</h1>
|
|
|
|
<p>This section shows some examples how the WAREHOUSE class is used in practice. This is one of the best ways to explain things, in my opinion.</p>
|
|
|
|
<p>But first, let me introduce a convenient way to define several warehouses in a table. This is absolutely <em>not necessary</em> but quite handy if you have
|
|
multiple WAREHOUSE objects in your mission.</p>
|
|
|
|
<h2>Example 0: Setting up a Warehouse Array</h2>
|
|
|
|
<p>If you have multiple warehouses, you can put them in a table. This makes it easier to access them or to loop over them.</p>
|
|
|
|
<pre><code>-- Define Warehouses.
|
|
local warehouse={}
|
|
-- Blue warehouses
|
|
warehouse.Senaki = WAREHOUSE:New(STATIC:FindByName("Warehouse Senaki"), "Senaki") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Batumi = WAREHOUSE:New(STATIC:FindByName("Warehouse Batumi"), "Batumi") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Kobuleti = WAREHOUSE:New(STATIC:FindByName("Warehouse Kobuleti"), "Kobuleti") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Kutaisi = WAREHOUSE:New(STATIC:FindByName("Warehouse Kutaisi"), "Kutaisi") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Berlin = WAREHOUSE:New(STATIC:FindByName("Warehouse Berlin"), "Berlin") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.London = WAREHOUSE:New(STATIC:FindByName("Warehouse London"), "London") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Stennis = WAREHOUSE:New(STATIC:FindByName("Warehouse Stennis"), "Stennis") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Pampa = WAREHOUSE:New(STATIC:FindByName("Warehouse Pampa"), "Pampa") --Functional.Warehouse#WAREHOUSE
|
|
-- Red warehouses
|
|
warehouse.Sukhumi = WAREHOUSE:New(STATIC:FindByName("Warehouse Sukhumi"), "Sukhumi") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Gudauta = WAREHOUSE:New(STATIC:FindByName("Warehouse Gudauta"), "Gudauta") --Functional.Warehouse#WAREHOUSE
|
|
warehouse.Sochi = WAREHOUSE:New(STATIC:FindByName("Warehouse Sochi"), "Sochi") --Functional.Warehouse#WAREHOUSE
|
|
</code></pre>
|
|
|
|
<p>Remarks:</p>
|
|
|
|
<ul>
|
|
<li>I defined the array as local, i.e. local warehouse={}. This is personal preference and sometimes causes trouble with the lua garbage collection. You can also define it as a global array/table!</li>
|
|
<li>The "--Functional.Warehouse#WAREHOUSE" at the end is only to have the LDT intellisense working correctly. If you don't use LDT (which you should!), it can be omitted.</li>
|
|
</ul>
|
|
|
|
<p><strong>NOTE</strong> that all examples below need this bit or code at the beginning - or at least the warehouses which are used.</p>
|
|
|
|
<p>The example mission is based on the same template mission, which has defined a lot of airborne, ground and naval assets as templates. Only few of those are used here.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Assets.png" alt="Banner Image"/></p>
|
|
|
|
<h2>Example 1: Self Request</h2>
|
|
|
|
<p>Ground troops are taken from the Batumi warehouse stock and spawned in its spawn zone. After a short delay, they are added back to the warehouse stock.
|
|
Also a new request is made. Hence, the groups will be spawned, added back to the warehouse, spawned again and so on and so forth...</p>
|
|
|
|
<pre><code>-- Start warehouse Batumi.
|
|
warehouse.Batumi:Start()
|
|
|
|
-- Add five groups of infantry as assets.
|
|
warehouse.Batumi:AddAsset(GROUP:FindByName("Infantry Platoon Alpha"), 5)
|
|
|
|
-- Add self request for three infantry at Batumi.
|
|
warehouse.Batumi:AddRequest(warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 3)
|
|
|
|
|
|
--- Self request event. Triggered once the assets are spawned in the spawn zone or at the airbase.
|
|
function warehouse.Batumi:OnAfterSelfRequest(From, Event, To, groupset, request)
|
|
local mygroupset=groupset --Core.Set#SET_GROUP
|
|
|
|
-- Loop over all groups spawned from that request.
|
|
for _,group in pairs(mygroupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
|
|
-- Gree smoke on spawned group.
|
|
group:SmokeGreen()
|
|
|
|
-- Put asset back to stock after 10 seconds.
|
|
warehouse.Batumi:__AddAsset(10, group)
|
|
end
|
|
|
|
-- Add new self request after 20 seconds.
|
|
warehouse.Batumi:__AddRequest(20, warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 3)
|
|
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 2: Self propelled Ground Troops</h2>
|
|
|
|
<p>Warehouse Berlin, which is a FARP near Batumi, requests infantry and troop transports from the warehouse at Batumi.
|
|
The groups are spawned at Batumi and move by themselves from Batumi to Berlin using the roads.
|
|
Once the troops have arrived at Berlin, the troops are automatically added to the warehouse stock of Berlin.
|
|
While on the road, Batumi has requested back two APCs from Berlin. Since Berlin does not have the assets in stock,
|
|
the request is queued. After the troops have arrived, Berlin is sending back the APCs to Batumi.</p>
|
|
|
|
<pre><code>-- Start Warehouse at Batumi.
|
|
warehouse.Batumi:Start()
|
|
|
|
-- Add 20 infantry groups and ten APCs as assets at Batumi.
|
|
warehouse.Batumi:AddAsset("Infantry Platoon Alpha", 20)
|
|
warehouse.Batumi:AddAsset("TPz Fuchs", 10)
|
|
|
|
-- Start Warehouse Berlin.
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Warehouse Berlin requests 10 infantry groups and 5 APCs from warehouse Batumi.
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 10)
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_APC, 5)
|
|
|
|
-- Request from Batumi for 2 APCs. Initially these are not in stock. When they become available, the request is executed.
|
|
warehouse.Berlin:AddRequest(warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_APC, 2)
|
|
</code></pre>
|
|
|
|
<h2>Example 3: Self Propelled Airborne Assets</h2>
|
|
|
|
<p>Warehouse Senaki receives a high priority request from Kutaisi for one Yak-52s. At the same time, Kobuleti requests half of
|
|
all available Yak-52s. Request from Kutaisi is first executed and then Kobuleti gets half of the remaining assets.
|
|
Additionally, London requests one third of all available UH-1H Hueys from Senaki.
|
|
Once the units have arrived they are added to the stock of the receiving warehouses and can be used for further assignments.</p>
|
|
|
|
<pre><code>-- Start warehouses
|
|
warehouse.Senaki:Start()
|
|
warehouse.Kutaisi:Start()
|
|
warehouse.Kobuleti:Start()
|
|
warehouse.London:Start()
|
|
|
|
-- Add assets to Senaki warehouse.
|
|
warehouse.Senaki:AddAsset("Yak-52", 10)
|
|
warehouse.Senaki:AddAsset("Huey", 6)
|
|
|
|
-- Kusaisi requests 3 Yak-52 form Senaki while Kobuleti wants all the rest.
|
|
warehouse.Senaki:AddRequest(warehouse.Kutaisi, WAREHOUSE.Descriptor.GROUPNAME, "Yak-52", 1, nil, nil, 10)
|
|
warehouse.Senaki:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.GROUPNAME, "Yak-52", WAREHOUSE.Quantity.HALF, nil, nil, 70)
|
|
|
|
-- FARP London wants 1/3 of the six available Hueys.
|
|
warehouse.Senaki:AddRequest(warehouse.London, WAREHOUSE.Descriptor.GROUPNAME, "Huey", WAREHOUSE.Quantity.THIRD)
|
|
</code></pre>
|
|
|
|
<h2>Example 4: Transport of Assets by APCs</h2>
|
|
|
|
<p>Warehouse at FARP Berlin requests five infantry groups from Batumi. These assets shall be transported using two APC groups.
|
|
Infantry and APC are spawned in the spawn zone at Batumi. The APCs have a cargo bay large enough to pick up four of the
|
|
five infantry groups in the first run and will bring them to Berlin. There, they unboard and walk to the warehouse where they will be added to the stock.
|
|
Meanwhile the APCs go back to Batumi and one will pick up the last remaining soldiers.
|
|
Once the APCs have completed their mission, they return to Batumi and are added back to stock.</p>
|
|
|
|
<pre><code>-- Start Warehouse at Batumi.
|
|
warehouse.Batumi:Start()
|
|
|
|
-- Start Warehouse Berlin.
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Add 20 infantry groups and five APCs as assets at Batumi.
|
|
warehouse.Batumi:AddAsset("Infantry Platoon Alpha", 20)
|
|
warehouse.Batumi:AddAsset("TPz Fuchs", 5)
|
|
|
|
-- Warehouse Berlin requests 5 infantry groups from warehouse Batumi using 2 APCs for transport.
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 5, WAREHOUSE.TransportType.APC, 2)
|
|
</code></pre>
|
|
|
|
<h2>Example 5: Transport of Assets by Helicopters</h2>
|
|
|
|
<p> Warehouse at FARP Berlin requests five infantry groups from Batumi. They shall be transported by all available transport helicopters.
|
|
Note that the UH-1H Huey in DCS is an attack and not a transport helo. So the warehouse logic would be default also
|
|
register it as an <a href="##(WAREHOUSE.Attribute).AIR_ATTACKHELICOPTER">WAREHOUSE.Attribute.AIR_ATTACKHELICOPTER</a>. In order to use it as a transport we need to force
|
|
it to be added as transport helo.
|
|
Also note that even though all (here five) helos are requested, only two of them are employed because this number is sufficient to
|
|
transport all requested assets in one go.</p>
|
|
|
|
<pre><code>-- Start Warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Add 20 infantry groups as assets at Batumi.
|
|
warehouse.Batumi:AddAsset("Infantry Platoon Alpha", 20)
|
|
|
|
-- Add five Hueys for transport. Note that a Huey in DCS is an attack and not a transport helo. So we force this attribute!
|
|
warehouse.Batumi:AddAsset("Huey", 5, WAREHOUSE.Attribute.AIR_TRANSPORTHELO)
|
|
|
|
-- Warehouse Berlin requests 5 infantry groups from warehouse Batumi using all available helos for transport.
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 5, WAREHOUSE.TransportType.HELICOPTER, WAREHOUSE.Quantity.ALL)
|
|
</code></pre>
|
|
|
|
<h2>Example 6: Transport of Assets by Airplanes</h2>
|
|
|
|
<p>Warehoues Kobuleti requests all (three) APCs from Batumi using one airplane for transport.
|
|
The available C-130 is able to carry one APC at a time. So it has to commute three times between Batumi and Kobuleti to deliver all requested cargo assets.
|
|
Once the cargo is delivered, the C-130 transport returns to Batumi and is added back to stock.</p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Kobuleti:Start()
|
|
|
|
-- Add assets to Batumi warehouse.
|
|
warehouse.Batumi:AddAsset("C-130", 1)
|
|
warehouse.Batumi:AddAsset("TPz Fuchs", 3)
|
|
|
|
warehouse.Batumi:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_APC, WAREHOUSE.Quantity.ALL, WAREHOUSE.TransportType.AIRPLANE)
|
|
</code></pre>
|
|
|
|
<h2>Example 7: Capturing Airbase and Warehouse</h2>
|
|
|
|
<p>A red BMP has made it through our defence lines and drives towards our unprotected airbase at Senaki.
|
|
Once the BMP captures the airbase (DCS <a href="https://wiki.hoggitworld.com/view/DCS_event_base_captured">S_EVENT_BASE_CAPTURED</a> is evaluated)
|
|
the warehouse at Senaki lost its air infrastructure and it is not possible any more to spawn airborne units. All requests for airborne units are rejected and cancelled in this case.</p>
|
|
|
|
<p>The red BMP then drives further to the warehouse. Once it enters the warehouse zone (500 m radius around the warehouse building), the warehouse is
|
|
considered to be under attack. This triggers the event <strong>Attacked</strong>. The <a href="##(WAREHOUSE).OnAfterAttacked">WAREHOUSE.OnAfterAttacked</a> function can be used to react to this situation.
|
|
Here, we only broadcast a distress call and launch a flare. However, it would also be reasonable to spawn all or selected ground troops in order to defend
|
|
the warehouse. Note, that the warehouse has a self defence option which can be activated via the <a href="##(WAREHOUSE).SetAutoDefenceOn">WAREHOUSE.SetAutoDefenceOn</a>() function. If activated,
|
|
<em>all</em> ground assets are automatically spawned and assigned to defend the warehouse. Once/if the attack is defeated, these assets go automatically back
|
|
into the warehouse stock.</p>
|
|
|
|
<p>If the red coalition manages to capture our warehouse, all assets go into their possession. Now red tries to steal three F/A-18 flights and send them to
|
|
Sukhumi. These aircraft will be spawned and begin to taxi. However, ...</p>
|
|
|
|
<p>A blue Bradley is in the area and will attempt to recapture the warehouse. It might also catch the red F/A-18s before they take off.</p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Senaki:Start()
|
|
warehouse.Sukhumi:Start()
|
|
|
|
-- Add some assets.
|
|
warehouse.Senaki:AddAsset("TPz Fuchs", 5)
|
|
warehouse.Senaki:AddAsset("Infantry Platoon Alpha", 10)
|
|
warehouse.Senaki:AddAsset("F/A-18C 2ship", 10)
|
|
|
|
-- Enable auto defence, i.e. spawn all group troups into the spawn zone.
|
|
--warehouse.Senaki:SetAutoDefenceOn()
|
|
|
|
-- Activate Red BMP trying to capture the airfield and the warehouse.
|
|
local red1=GROUP:FindByName("Red BMP-80 Senaki"):Activate()
|
|
|
|
-- The red BMP first drives to the airbase which gets captured and changes from blue to red.
|
|
-- This triggers the "AirbaseCaptured" event where you can hook in and do things.
|
|
function warehouse.Senaki:OnAfterAirbaseCaptured(From, Event, To, Coalition)
|
|
-- This request cannot be processed since the warehouse has lost its airbase. In fact it is deleted from the queue.
|
|
warehouse.Senaki:AddRequest(warehouse.Senaki,WAREHOUSE.Descriptor.CATEGORY, Group.Category.AIRPLANE, 1)
|
|
end
|
|
|
|
-- Now the red BMP also captures the warehouse. This triggers the "Captured" event where you can hook in.
|
|
-- So now the warehouse and the airbase are both red and aircraft can be spawned again.
|
|
function warehouse.Senaki:OnAfterCaptured(From, Event, To, Coalition, Country)
|
|
-- These units will be spawned as red units because the warehouse has just been captured.
|
|
if Coalition==coalition.side.RED then
|
|
-- Sukhumi tries to "steals" three F/A-18 from Senaki and brings them to Sukhumi.
|
|
-- Well, actually the aircraft wont make it because blue1 will kill it on the taxi way leaving a blood bath. But that's life!
|
|
warehouse.Senaki:AddRequest(warehouse.Sukhumi, WAREHOUSE.Descriptor.CATEGORY, Group.Category.AIRPLANE, 3)
|
|
warehouse.Senaki.warehouse:SmokeRed()
|
|
elseif Coalition==coalition.side.BLUE then
|
|
warehouse.Senaki.warehouse:SmokeBlue()
|
|
end
|
|
|
|
-- Activate a blue vehicle to re-capture the warehouse. It will drive to the warehouse zone and kill the red intruder.
|
|
local blue1=GROUP:FindByName("blue1"):Activate()
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 8: Destroying a Warehouse</h2>
|
|
|
|
<p>FARP Berlin requests a Huey from Batumi warehouse. This helo is deployed and will be delivered.
|
|
After 30 seconds into the mission we create and (artificial) big explosion - or a terrorist attack if you like - which completely destroys the
|
|
the warehouse at Batumi. All assets are gone and requests cannot be processed anymore.</p>
|
|
|
|
<pre><code>-- Start Batumi and Berlin warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Add some assets.
|
|
warehouse.Batumi:AddAsset("Huey", 5, WAREHOUSE.Attribute.AIR_TRANSPORTHELO)
|
|
warehouse.Berlin:AddAsset("Huey", 5, WAREHOUSE.Attribute.AIR_TRANSPORTHELO)
|
|
|
|
-- Big explosion at the warehose. It has a very nice damage model by the way :)
|
|
local function DestroyWarehouse()
|
|
warehouse.Batumi:GetCoordinate():Explosion(999)
|
|
end
|
|
SCHEDULER:New(nil, DestroyWarehouse, {}, 30)
|
|
|
|
-- First request is okay since warehouse is still alive.
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.AIR_TRANSPORTHELO, 1)
|
|
|
|
-- These requests should both not be processed any more since the warehouse at Batumi is destroyed.
|
|
warehouse.Batumi:__AddRequest(35, warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.AIR_TRANSPORTHELO, 1)
|
|
warehouse.Berlin:__AddRequest(40, warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.AIR_TRANSPORTHELO, 1)
|
|
</code></pre>
|
|
|
|
<h2>Example 9: Self Propelled Naval Assets</h2>
|
|
|
|
<p>Kobuleti requests all naval assets from Batumi.
|
|
However, before naval assets can be exchanged, both warehouses need a port and at least one shipping lane defined by the user.
|
|
See the <a href="##(WAREHOUSE).SetPortZone">WAREHOUSE.SetPortZone</a>() and <a href="##(WAREHOUSE).AddShippingLane">WAREHOUSE.AddShippingLane</a>() functions.
|
|
We do not want to spawn them all at once, because this will probably be a disaster
|
|
in the port zone. Therefore, each ship is spawned with a delay of five minutes.</p>
|
|
|
|
<p>Batumi has quite a selection of different ships (for testing).</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Naval_Assets.png" alt="Banner Image"/></p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Kobuleti:Start()
|
|
|
|
-- Define ports. These are polygon zones created by the waypoints of late activated units.
|
|
warehouse.Batumi:SetPortZone(ZONE_POLYGON:NewFromGroupName("Warehouse Batumi Port Zone", "Warehouse Batumi Port Zone"))
|
|
warehouse.Kobuleti:SetPortZone(ZONE_POLYGON:NewFromGroupName("Warehouse Kobuleti Port Zone", "Warehouse Kobuleti Port Zone"))
|
|
|
|
-- Shipping lane. Again, the waypoints of late activated units are taken as points defining the shipping lane.
|
|
-- Some units will take lane 1 while others will take lane two. But both lead from Batumi to Kobuleti port.
|
|
warehouse.Batumi:AddShippingLane(warehouse.Kobuleti, GROUP:FindByName("Warehouse Batumi-Kobuleti Shipping Lane 1"))
|
|
warehouse.Batumi:AddShippingLane(warehouse.Kobuleti, GROUP:FindByName("Warehouse Batumi-Kobuleti Shipping Lane 2"))
|
|
|
|
-- Large selection of available naval units in DCS.
|
|
warehouse.Batumi:AddAsset("Speedboat")
|
|
warehouse.Batumi:AddAsset("Perry")
|
|
warehouse.Batumi:AddAsset("Normandy")
|
|
warehouse.Batumi:AddAsset("Stennis")
|
|
warehouse.Batumi:AddAsset("Carl Vinson")
|
|
warehouse.Batumi:AddAsset("Tarawa")
|
|
warehouse.Batumi:AddAsset("SSK 877")
|
|
warehouse.Batumi:AddAsset("SSK 641B")
|
|
warehouse.Batumi:AddAsset("Grisha")
|
|
warehouse.Batumi:AddAsset("Molniya")
|
|
warehouse.Batumi:AddAsset("Neustrashimy")
|
|
warehouse.Batumi:AddAsset("Rezky")
|
|
warehouse.Batumi:AddAsset("Moskva")
|
|
warehouse.Batumi:AddAsset("Pyotr Velikiy")
|
|
warehouse.Batumi:AddAsset("Kuznetsov")
|
|
warehouse.Batumi:AddAsset("Zvezdny")
|
|
warehouse.Batumi:AddAsset("Yakushev")
|
|
warehouse.Batumi:AddAsset("Elnya")
|
|
warehouse.Batumi:AddAsset("Ivanov")
|
|
warehouse.Batumi:AddAsset("Yantai")
|
|
warehouse.Batumi:AddAsset("Type 052C")
|
|
warehouse.Batumi:AddAsset("Guangzhou")
|
|
|
|
-- Get Number of ships at Batumi.
|
|
local nships=warehouse.Batumi:GetNumberOfAssets(WAREHOUSE.Descriptor.CATEGORY, Group.Category.SHIP)
|
|
|
|
-- Send one ship every 3 minutes (ships do not evade each other well, so we need a bit space between them).
|
|
for i=1, nships do
|
|
warehouse.Batumi:__AddRequest(180*(i-1)+10, warehouse.Kobuleti, WAREHOUSE.Descriptor.CATEGORY, Group.Category.SHIP, 1)
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 10: Warehouse on Aircraft Carrier</h2>
|
|
|
|
<p>This example shows how to spawn assets from a warehouse located on an aircraft carrier. The warehouse must still be represented by a
|
|
physical static object. However, on a carrier space is limit so we take a smaller static. In priciple one could also take something
|
|
like a windsock.</p>
|
|
|
|
<p><img src="..\Presentations\WAREHOUSE\Warehouse_Carrier.png" alt="Banner Image"/></p>
|
|
|
|
<p>USS Stennis requests F/A-18s from Batumi. At the same time Kobuleti requests F/A-18s from the Stennis which currently does not have any.
|
|
So first, Batumi delivers the fighters to the Stennis. After they arrived they are deployed again and send to Kobuleti.</p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Stennis:Start()
|
|
warehouse.Kobuleti:Start()
|
|
|
|
-- Add F/A-18 2-ship flight to Batmi.
|
|
warehouse.Batumi:AddAsset("F/A-18C 2ship", 1)
|
|
|
|
-- USS Stennis requests F/A-18 from Batumi.
|
|
warehouse.Batumi:AddRequest(warehouse.Stennis, WAREHOUSE.Descriptor.GROUPNAME, "F/A-18C 2ship")
|
|
|
|
-- Kobuleti requests F/A-18 from USS Stennis.
|
|
warehouse.Stennis:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.GROUPNAME, "F/A-18C 2ship")
|
|
</code></pre>
|
|
|
|
<h2>Example 11: Aircraft Carrier - Rescue Helo and Escort</h2>
|
|
|
|
<p>After 10 seconds we make a self request for a rescue helicopter. Note, that the <a href="##(WAREHOUSE).AddRequest">WAREHOUSE.AddRequest</a> function has a parameter which lets you
|
|
specify an "Assignment". This can be later used to identify the request and take the right actions.</p>
|
|
|
|
<p>Once the request is processed, the <a href="##(WAREHOUSE).OnAfterSelfRequest">WAREHOUSE.OnAfterSelfRequest</a> function is called. This is where we hook in and postprocess the spawned assets.
|
|
In particular, we use the <a href="AI.AI_Formation.html##(AI_FORMATION)">AI.AI_Formation#AI_FORMATION</a> class to make some nice escorts for our carrier.</p>
|
|
|
|
<p>When the resue helo is spawned, we can check that this is the correct asset and make the helo go into formation with the carrier.
|
|
Once the helo runs out of fuel, it will automatically return to the ship and land. For the warehouse, this means that the "cargo", i.e. the helicopter
|
|
has been delivered - assets can be delivered to other warehouses and to the same warehouse - hence a <em>self</em> request.
|
|
When that happens, the <strong>Delivered</strong> event is triggered and the <a href="##(WAREHOUSE).OnAfterDelivered">WAREHOUSE.OnAfterDelivered</a> function called. This can now be used to spawn
|
|
a fresh helo. Effectively, there we created an infinite, never ending loop. So a rescue helo will be up at all times.</p>
|
|
|
|
<p>After 30 and 45 seconds requests for five groups of armed speedboats are made. These will be spawned in the port zone right behind the carrier.
|
|
The first five groups will go port of the carrier an form a left wing formation. The seconds groups will to the analogue on the starboard side.
|
|
<strong>Note</strong> that in order to spawn naval assets a warehouse needs a port (zone). Since the carrier and hence the warehouse is mobile, we define a moving
|
|
zone as <a href="Core.Zone.html##(ZONE_UNIT)">Core.Zone#ZONE_UNIT</a> with the carrier as reference unit. The "port" of the Stennis at its stern so all naval assets are spawned behind the carrier.</p>
|
|
|
|
<pre><code>-- Start warehouse on USS Stennis.
|
|
warehouse.Stennis:Start()
|
|
|
|
-- Aircraft carrier gets a moving zone right behind it as port.
|
|
warehouse.Stennis:SetPortZone(ZONE_UNIT:New("Warehouse Stennis Port Zone", UNIT:FindByName("USS Stennis"), 100, {rho=250, theta=180, relative_to_unit=true}))
|
|
|
|
-- Add speedboat assets.
|
|
warehouse.Stennis:AddAsset("Speedboat", 10)
|
|
warehouse.Stennis:AddAsset("CH-53E", 1)
|
|
|
|
-- Self request of speed boats.
|
|
warehouse.Stennis:__AddRequest(10, warehouse.Stennis, WAREHOUSE.Descriptor.GROUPNAME, "CH-53E", 1, nil, nil, nil, "Rescue Helo")
|
|
warehouse.Stennis:__AddRequest(30, warehouse.Stennis, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.NAVAL_ARMEDSHIP, 5, nil, nil, nil, "Speedboats Left")
|
|
warehouse.Stennis:__AddRequest(45, warehouse.Stennis, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.NAVAL_ARMEDSHIP, 5, nil, nil, nil, "Speedboats Right")
|
|
|
|
--- Function called after self request
|
|
function warehouse.Stennis:OnAfterSelfRequest(From, Event, To,_groupset, request)
|
|
local groupset=_groupset --Core.Set#SET_GROUP
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
-- USS Stennis is the mother ship.
|
|
local Mother=UNIT:FindByName("USS Stennis")
|
|
|
|
-- Get assignment of the request.
|
|
local assignment=warehouse.Stennis:GetAssignment(request)
|
|
|
|
if assignment=="Speedboats Left" then
|
|
|
|
-- Define AI Formation object.
|
|
-- Note that this has to be a global variable or the garbage collector will remove it for some reason!
|
|
CarrierFormationLeft = AI_FORMATION:New(Mother, groupset, "Left Formation with Carrier", "Escort Carrier.")
|
|
|
|
-- Formation parameters.
|
|
CarrierFormationLeft:FormationLeftWing(200 ,50, 0, 0, 500, 50)
|
|
CarrierFormationLeft:__Start(2)
|
|
|
|
for _,group in pairs(groupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
group:FlareRed()
|
|
end
|
|
|
|
elseif assignment=="Speedboats Right" then
|
|
|
|
-- Define AI Formation object.
|
|
-- Note that this has to be a global variable or the garbage collector will remove it for some reason!
|
|
CarrierFormationRight = AI_FORMATION:New(Mother, groupset, "Right Formation with Carrier", "Escort Carrier.")
|
|
|
|
-- Formation parameters.
|
|
CarrierFormationRight:FormationRightWing(200 ,50, 0, 0, 500, 50)
|
|
CarrierFormationRight:__Start(2)
|
|
|
|
for _,group in pairs(groupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
group:FlareGreen()
|
|
end
|
|
|
|
elseif assignment=="Rescue Helo" then
|
|
|
|
-- Start uncontrolled helo.
|
|
local group=groupset:GetFirst() --Wrapper.Group#GROUP
|
|
group:StartUncontrolled()
|
|
|
|
-- Define AI Formation object.
|
|
CarrierFormationHelo = AI_FORMATION:New(Mother, groupset, "Helo Formation with Carrier", "Fly Formation.")
|
|
|
|
-- Formation parameters.
|
|
CarrierFormationHelo:FormationCenterWing(-150, 50, 20, 50, 100, 50)
|
|
CarrierFormationHelo:__Start(2)
|
|
|
|
end
|
|
|
|
--- When the helo is out of fuel, it will return to the carrier and should be delivered.
|
|
function warehouse.Stennis:OnAfterDelivered(From,Event,To,request)
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
-- So we start another request.
|
|
if request.assignment=="Rescue Helo" then
|
|
warehouse.Stennis:__AddRequest(10, warehouse.Stennis, WAREHOUSE.Descriptor.GROUPNAME, "CH-53E", 1, nil, nil, nil, "Rescue Helo")
|
|
end
|
|
end
|
|
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 12: Pause a Warehouse</h2>
|
|
|
|
<p>This example shows how to pause and unpause a warehouse. In paused state, requests will not be processed but assets can be added and requests be added.</p>
|
|
|
|
<ul>
|
|
<li>Warehouse Batumi is paused after 10 seconds.</li>
|
|
<li>Request from Berlin after 15 which will not be processed.</li>
|
|
<li>New tank assets for Batumi after 20 seconds. This is possible also in paused state.</li>
|
|
<li>Batumi unpaused after 30 seconds. Queued request from Berlin can be processed.</li>
|
|
<li>Berlin is paused after 60 seconds.</li>
|
|
<li>Berlin requests tanks from Batumi after 90 seconds. Request is not processed because Berlin is paused and not running.</li>
|
|
<li>Berlin is unpaused after 120 seconds. Queued request for tanks from Batumi can not be processed.</li>
|
|
</ul>
|
|
|
|
<p>Here is the code:</p>
|
|
|
|
<pre><code>-- Start Warehouse at Batumi.
|
|
warehouse.Batumi:Start()
|
|
|
|
-- Start Warehouse Berlin.
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Add 20 infantry groups and 5 tank platoons as assets at Batumi.
|
|
warehouse.Batumi:AddAsset("Infantry Platoon Alpha", 20)
|
|
|
|
-- Pause the warehouse after 10 seconds
|
|
warehouse.Batumi:__Pause(10)
|
|
|
|
-- Add a request from Berlin after 15 seconds. A request can be added but not be processed while warehouse is paused.
|
|
warehouse.Batumi:__AddRequest(15, warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 1)
|
|
|
|
-- New asset added after 20 seconds. This is possible even if the warehouse is paused.
|
|
warehouse.Batumi:__AddAsset(20, "Abrams", 5)
|
|
|
|
-- Unpause warehouse after 30 seconds. Now the request from Berlin can be processed.
|
|
warehouse.Batumi:__Unpause(30)
|
|
|
|
-- Pause warehouse Berlin
|
|
warehouse.Berlin:__Pause(60)
|
|
|
|
-- After 90 seconds request from Berlin for tanks.
|
|
warehouse.Batumi:__AddRequest(90, warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_TANK, 1)
|
|
|
|
-- After 120 seconds unpause Berlin.
|
|
warehouse.Berlin:__Unpause(120)
|
|
</code></pre>
|
|
|
|
<h2>Example 13: Battlefield Air Interdiction</h2>
|
|
|
|
<p>This example show how to couple the WAREHOUSE class with the <a href="AI.AI_BAI.html">AI.AI_BAI</a> class.
|
|
Four enemy targets have been located at the famous Kobuleti X. All three available Viggen 2-ship flights are assigned to kill at least one of the BMPs to complete their mission.</p>
|
|
|
|
<pre><code>-- Start Warehouse at Kobuleti.
|
|
warehouse.Kobuleti:Start()
|
|
|
|
-- Add three 2-ship groups of Viggens.
|
|
warehouse.Kobuleti:AddAsset("Viggen 2ship", 3)
|
|
|
|
-- Self request for all Viggen assets.
|
|
warehouse.Kobuleti:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.GROUPNAME, "Viggen 2ship", WAREHOUSE.Quantity.ALL, nil, nil, nil, "BAI")
|
|
|
|
-- Red targets at Kobuleti X (late activated).
|
|
local RedTargets=GROUP:FindByName("Red IVF Alpha")
|
|
|
|
-- Activate the targets.
|
|
RedTargets:Activate()
|
|
|
|
-- Do something with the spawned aircraft.
|
|
function warehouse.Kobuleti:OnAfterSelfRequest(From,Event,To,groupset,request)
|
|
local groupset=groupset --Core.Set#SET_GROUP
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
if request.assignment=="BAI" then
|
|
|
|
for _,group in pairs(groupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
|
|
-- Start uncontrolled aircraft.
|
|
group:StartUncontrolled()
|
|
|
|
local BAI=AI_BAI_ZONE:New(ZONE:New("Patrol Zone Kobuleti"), 500, 1000, 500, 600, ZONE:New("Patrol Zone Kobuleti"))
|
|
|
|
-- Tell the program to use the object (in this case called BAIPlane) as the group to use in the BAI function
|
|
BAI:SetControllable(group)
|
|
|
|
-- Function checking if targets are still alive
|
|
local function CheckTargets()
|
|
local nTargets=RedTargets:GetSize()
|
|
local nInitial=RedTargets:GetInitialSize()
|
|
local nDead=nInitial-nTargets
|
|
local nRequired=1 -- Let's make this easy.
|
|
if RedTargets:IsAlive() and nDead < nRequired then
|
|
MESSAGE:New(string.format("BAI Mission: %d of %d red targets still alive. At least %d targets need to be eliminated.", nTargets, nInitial, nRequired), 5):ToAll()
|
|
else
|
|
MESSAGE:New("BAI Mission: The required red targets are destroyed.", 30):ToAll()
|
|
BAI:__Accomplish(1) -- Now they should fly back to the patrolzone and patrol.
|
|
end
|
|
end
|
|
|
|
-- Start scheduler to monitor number of targets.
|
|
local Check, CheckScheduleID = SCHEDULER:New(nil, CheckTargets, {}, 60, 60)
|
|
|
|
-- When the targets in the zone are destroyed, (see scheduled function), the planes will return home ...
|
|
function BAI:OnAfterAccomplish( Controllable, From, Event, To )
|
|
MESSAGE:New( "BAI Mission: Sending the Viggens back to base.", 30):ToAll()
|
|
Check:Stop(CheckScheduleID)
|
|
BAI:__RTB(1)
|
|
end
|
|
|
|
-- Start BAI
|
|
BAI:Start()
|
|
|
|
-- Engage after 5 minutes.
|
|
BAI:__Engage(300)
|
|
|
|
-- RTB after 30 min max.
|
|
BAI:__RTB(-30*60)
|
|
|
|
end
|
|
end
|
|
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 14: Strategic Bombing</h2>
|
|
|
|
<p>This example shows how to employ strategic bombers in a mission. Three B-52s are launched at Kobuleti with the assignment to wipe out the enemy warehouse at Sukhumi.
|
|
The bombers will get a flight path and make their approach from the South at an altitude of 5000 m ASL. After their bombing run, they will return to Kobuleti and
|
|
added back to stock.</p>
|
|
|
|
<pre><code>-- Start warehouses
|
|
warehouse.Kobuleti:Start()
|
|
warehouse.Sukhumi:Start()
|
|
|
|
-- Add a strategic bomber assets
|
|
warehouse.Kobuleti:AddAsset("B-52H", 3)
|
|
|
|
-- Request bombers for specific task of bombing Sukhumi warehouse.
|
|
warehouse.Kobuleti:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.AIR_BOMBER, WAREHOUSE.Quantity.ALL, nil, nil, nil, "Bomb Sukhumi")
|
|
|
|
-- Specify assignment after bombers have been spawned.
|
|
function warehouse.Kobuleti:OnAfterSelfRequest(From, Event, To, groupset, request)
|
|
local groupset=groupset --Core.Set#SET_GROUP
|
|
|
|
-- Get assignment of this request.
|
|
local assignment=warehouse.Kobuleti:GetAssignment(request)
|
|
|
|
if assignment=="Bomb Sukhumi" then
|
|
|
|
for _,_group in pairs(groupset:GetSet()) do
|
|
local group=_group --Wrapper.Group#GROUP
|
|
|
|
-- Start uncontrolled aircraft.
|
|
group:StartUncontrolled()
|
|
|
|
-- Target coordinate!
|
|
local ToCoord=warehouse.Sukhumi:GetCoordinate():SetAltitude(5000)
|
|
|
|
-- Home coordinate.
|
|
local HomeCoord=warehouse.Kobuleti:GetCoordinate():SetAltitude(3000)
|
|
|
|
-- Task bomb Sukhumi warehouse using all bombs (2032) from direction 180 at altitude 5000 m.
|
|
local task=group:TaskBombing(warehouse.Sukhumi:GetCoordinate():GetVec2(), false, "All", nil , 180, 5000, 2032)
|
|
|
|
-- Define waypoints.
|
|
local WayPoints={}
|
|
|
|
-- Take off position.
|
|
WayPoints[1]=warehouse.Kobuleti:GetCoordinate():WaypointAirTakeOffParking()
|
|
-- Begin bombing run 20 km south of target.
|
|
WayPoints[2]=ToCoord:Translate(20*1000, 180):WaypointAirTurningPoint(nil, 600, {task}, "Bombing Run")
|
|
-- Return to base.
|
|
WayPoints[3]=HomeCoord:WaypointAirTurningPoint()
|
|
-- Land at homebase. Bombers are added back to stock and can be employed in later assignments.
|
|
WayPoints[4]=warehouse.Kobuleti:GetCoordinate():WaypointAirLanding()
|
|
|
|
-- Route bombers.
|
|
group:Route(WayPoints)
|
|
end
|
|
|
|
end
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 15: Defining Off-Road Paths</h2>
|
|
|
|
<p>For self propelled assets it is possible to define custom off-road paths from one warehouse to another via the <a href="##(WAREHOUSE).AddOffRoadPath">WAREHOUSE.AddOffRoadPath</a> function.
|
|
The waypoints of a path are taken from late activated units. In this example, two paths have been defined between the warehouses Kobuleti and FARP London.
|
|
Trucks are spawned at each warehouse and are guided along the paths to the other warehouse.
|
|
Note that if more than one path was defined, each asset group will randomly select its route.</p>
|
|
|
|
<pre><code>-- Start warehouses
|
|
warehouse.Kobuleti:Start()
|
|
warehouse.London:Start()
|
|
|
|
-- Define a polygon zone as spawn zone at Kobuleti.
|
|
warehouse.Kobuleti:SetSpawnZone(ZONE_POLYGON:New("Warehouse Kobuleti Spawn Zone", GROUP:FindByName("Warehouse Kobuleti Spawn Zone")))
|
|
|
|
-- Add assets.
|
|
warehouse.Kobuleti:AddAsset("M978", 20)
|
|
warehouse.London:AddAsset("M818", 20)
|
|
|
|
-- Off two road paths from Kobuleti to London. The reverse path from London to Kobuleti is added automatically.
|
|
warehouse.Kobuleti:AddOffRoadPath(warehouse.London, GROUP:FindByName("Warehouse Kobuleti-London OffRoad Path 1"))
|
|
warehouse.Kobuleti:AddOffRoadPath(warehouse.London, GROUP:FindByName("Warehouse Kobuleti-London OffRoad Path 2"))
|
|
|
|
-- London requests all available trucks from Kobuleti.
|
|
warehouse.Kobuleti:AddRequest(warehouse.London, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_TRUCK, WAREHOUSE.Quantity.ALL)
|
|
|
|
-- Kobuleti requests all available trucks from London.
|
|
warehouse.London:AddRequest(warehouse.Kobuleti, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_TRUCK, WAREHOUSE.Quantity.HALF)
|
|
</code></pre>
|
|
|
|
<h2>Example 16: Resupply of Dead Assets</h2>
|
|
|
|
<p>Warehouse at FARP Berlin is located at the front line and sends infantry groups to the battle zone.
|
|
Whenever a group dies, a new group is send from the warehouse to the battle zone.
|
|
Additionally, for each dead group, Berlin requests resupply from Batumi.</p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Batumi:Start()
|
|
warehouse.Berlin:Start()
|
|
|
|
-- Front line warehouse.
|
|
warehouse.Berlin:AddAsset("Infantry Platoon Alpha", 6)
|
|
|
|
-- Resupply warehouse.
|
|
warehouse.Batumi:AddAsset("Infantry Platoon Alpha", 50)
|
|
|
|
-- Battle zone near FARP Berlin. This is where the action is!
|
|
local BattleZone=ZONE:New("Virtual Battle Zone")
|
|
|
|
-- Send infantry groups to the battle zone. Two groups every ~60 seconds.
|
|
for i=1,2 do
|
|
local time=(i-1)*60+10
|
|
warehouse.Berlin:__AddRequest(time, warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 2, nil, nil, nil, "To Battle Zone")
|
|
end
|
|
|
|
-- Take care of the spawned units.
|
|
function warehouse.Berlin:OnAfterSelfRequest(From,Event,To,groupset,request)
|
|
local groupset=groupset --Core.Set#SET_GROUP
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
-- Get assignment of this request.
|
|
local assignment=warehouse.Berlin:GetAssignment(request)
|
|
|
|
if assignment=="To Battle Zone" then
|
|
|
|
for _,group in pairs(groupset:GetSet()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
|
|
-- Route group to Battle zone.
|
|
local ToCoord=BattleZone:GetRandomCoordinate()
|
|
group:RouteGroundOnRoad(ToCoord, group:GetSpeedMax()*0.8)
|
|
|
|
-- After 3-5 minutes we create an explosion to destroy the group.
|
|
SCHEDULER:New(nil, Explosion, {group, 50}, math.random(180, 300))
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
-- An asset has died ==> request resupply for it.
|
|
function warehouse.Berlin:OnAfterAssetDead(From, Event, To, asset, request)
|
|
local asset=asset --Functional.Warehouse#WAREHOUSE.Assetitem
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
-- Get assignment.
|
|
local assignment=warehouse.Berlin:GetAssignment(request)
|
|
|
|
-- Request resupply for dead asset from Batumi.
|
|
warehouse.Batumi:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, asset.attribute, nil, nil, nil, nil, "Resupply")
|
|
|
|
-- Send asset to Battle zone either now or when they arrive.
|
|
warehouse.Berlin:AddRequest(warehouse.Berlin, WAREHOUSE.Descriptor.ATTRIBUTE, asset.attribute, 1, nil, nil, nil, assignment)
|
|
end
|
|
</code></pre>
|
|
|
|
<h2>Example 17: Supply Chains</h2>
|
|
|
|
<p>Our remote warehouse "Pampa" south of Batumi needs assets but does not have any air infrastructure (FARP or airdrome).
|
|
Leopard 2 tanks are transported from Kobuleti to Batumi using two C-17As. From there they go be themselfs to Pampa.
|
|
Eight infantry groups and two mortar groups are also being transferred from Kobuleti to Batumi by helicopter.
|
|
The infantry has a higher priority and will be transported first using all available Mi-8 helicopters.
|
|
Once infantry has arrived at Batumi, it will walk by itself to warehouse Pampa.
|
|
The mortars can only be transported once the Mi-8 helos are available again, i.e. when the infantry has been delivered.
|
|
Once the mortars arrive at Batumi, they will be transported by APCs to Pampa.</p>
|
|
|
|
<pre><code>-- Start warehouses.
|
|
warehouse.Kobuleti:Start()
|
|
warehouse.Batumi:Start()
|
|
warehouse.Pampa:Start()
|
|
|
|
-- Add assets to Kobuleti warehouse, which is our main hub.
|
|
warehouse.Kobuleti:AddAsset("C-130", 2)
|
|
warehouse.Kobuleti:AddAsset("C-17A", 2, nil, 77000)
|
|
warehouse.Kobuleti:AddAsset("Mi-8", 2, WAREHOUSE.Attribute.AIR_TRANSPORTHELO, nil, nil, nil, AI.Skill.EXCELLENT, {"Germany", "United Kingdom"})
|
|
warehouse.Kobuleti:AddAsset("Leopard 2", 10, nil, nil, 62000, 500)
|
|
warehouse.Kobuleti:AddAsset("Mortar Alpha", 10, nil, nil, 210)
|
|
warehouse.Kobuleti:AddAsset("Infantry Platoon Alpha", 20)
|
|
|
|
-- Transports at Batumi.
|
|
warehouse.Batumi:AddAsset("SPz Marder", 2)
|
|
warehouse.Batumi:AddAsset("TPz Fuchs", 2)
|
|
|
|
-- Tanks transported by plane from from Kobuleti to Batumi.
|
|
warehouse.Kobuleti:AddRequest(warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_TANK, 2, WAREHOUSE.TransportType.AIRPLANE, 2, 10, "Assets for Pampa")
|
|
-- Artillery transported by helicopter from Kobuleti to Batumi.
|
|
warehouse.Kobuleti:AddRequest(warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_ARTILLERY, 2, WAREHOUSE.TransportType.HELICOPTER, 2, 30, "Assets for Pampa via APC")
|
|
-- Infantry transported by helicopter from Kobuleti to Batumi.
|
|
warehouse.Kobuleti:AddRequest(warehouse.Batumi, WAREHOUSE.Descriptor.ATTRIBUTE, WAREHOUSE.Attribute.GROUND_INFANTRY, 8, WAREHOUSE.TransportType.HELICOPTER, 2, 20, "Assets for Pampa")
|
|
|
|
--- Function handling assets delivered from Kobuleti warehouse.
|
|
function warehouse.Kobuleti:OnAfterDelivered(From, Event, To, request)
|
|
local request=request --Functional.Warehouse#WAREHOUSE.Pendingitem
|
|
|
|
-- Get assignment.
|
|
local assignment=warehouse.Kobuleti:GetAssignment(request)
|
|
|
|
-- Check if these assets were meant for Warehouse Pampa.
|
|
if assignment=="Assets for Pampa via APC" then
|
|
-- Forward everything that arrived at Batumi to Pampa via APC.
|
|
warehouse.Batumi:AddRequest(warehouse.Pampa, WAREHOUSE.Descriptor.ATTRIBUTE, request.cargoattribute, request.ndelivered, WAREHOUSE.TransportType.APC, WAREHOUSE.Quantity.ALL)
|
|
end
|
|
end
|
|
|
|
-- Forward all mobile ground assets to Pampa once they arrived.
|
|
function warehouse.Batumi:OnAfterNewAsset(From, Event, To, asset, assignment)
|
|
local asset=asset --Functional.Warehouse#WAREHOUSE.Assetitem
|
|
if assignment=="Assets for Pampa" then
|
|
if asset.category==Group.Category.GROUND and asset.speedmax>0 then
|
|
warehouse.Batumi:AddRequest(warehouse.Pampa, WAREHOUSE.Descriptor.GROUPNAME, asset.templatename)
|
|
end
|
|
end
|
|
end
|
|
</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##_WAREHOUSEDB')">
|
|
<tr>
|
|
<td class="style="width:40%;"><p><h2>Global <strong>_WAREHOUSEDB</strong></h2></p></td>
|
|
<td class="style="width:60%;">
|
|
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div id= "#Globals##_WAREHOUSEDB" class="w3-container w3-white w3-padding-small">
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(_WAREHOUSEDB)">#_WAREHOUSEDB</a>
|
|
<a id="_WAREHOUSEDB" ><strong>_WAREHOUSEDB</strong></a>
|
|
|
|
|
|
|
|
</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="#(WAREHOUSE)">Type <strong>WAREHOUSE</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE)">WAREHOUSE</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 WAREHOUSE</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="##(WAREHOUSE).AddAsset">WAREHOUSE:AddAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger the FSM event "AddAsset".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AddOffRoadPath">WAREHOUSE:AddOffRoadPath(remotewarehouse, group, oneway)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add an off-road path from this warehouse to another and back.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AddRequest">WAREHOUSE:AddRequest(warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AddRequest".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AddShippingLane">WAREHOUSE:AddShippingLane(remotewarehouse, group, oneway)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a shipping lane from this warehouse to another remote warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AirbaseCaptured">WAREHOUSE:AirbaseCaptured(Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AirbaseCaptured" when the airbase of the warehouse has been captured by another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AirbaseRecaptured">WAREHOUSE:AirbaseRecaptured(Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AirbaseRecaptured" when the airbase of the warehouse has been re-captured from the other coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Arrived">WAREHOUSE:Arrived(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Arrived" when a group has arrived at the destination warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AssetDead">WAREHOUSE:AssetDead(asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AssetDead" when an asset group has died.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AssetLowFuel">WAREHOUSE:AssetLowFuel(asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AssetLowFuel" when an asset runs low on fuel</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).AssetSpawned">WAREHOUSE:AssetSpawned(group, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AssetSpawned" when the warehouse has spawned an asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Attacked">WAREHOUSE:Attacked(Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Attacked" when a warehouse is under attack by an another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Captured">WAREHOUSE:Captured(Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Captured" when a warehouse has been captured by another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).ChangeCountry">WAREHOUSE:ChangeCountry(Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "ChangeCountry" so the warehouse is respawned with the new country.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).ClassName">WAREHOUSE.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="##(WAREHOUSE).Debug">WAREHOUSE.Debug</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, send debug messages to all.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Defeated">WAREHOUSE:Defeated()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Defeated" when an attack from an enemy was defeated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Delivered">WAREHOUSE:Delivered(request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Delivered".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Destroyed">WAREHOUSE:Destroyed()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Destroyed" when the warehouse was destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).FilterStock">WAREHOUSE:FilterStock(descriptor, attribute, nmax, mobile)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Filter stock assets by descriptor and attribute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).FindAssetInDB">WAREHOUSE:FindAssetInDB(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Find an asset in the the global warehouse data base.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).FindNearestWarehouse">WAREHOUSE:FindNearestWarehouse(MinAssets, Descriptor, DescriptorValue, Coalition, RefCoordinate)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Find nearest warehouse in service, i.e.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).FindWarehouseInDB">WAREHOUSE:FindWarehouseInDB(uid)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Find a warehouse in the global warehouse data base.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAirbase">WAREHOUSE:GetAirbase()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get airbase associated to the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAirbaseCategory">WAREHOUSE:GetAirbaseCategory()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get category of airbase associated to the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAirbaseName">WAREHOUSE:GetAirbaseName()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get name airbase associated to the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAssetByID">WAREHOUSE:GetAssetByID(id)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a warehouse asset from its unique id.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAssetByName">WAREHOUSE:GetAssetByName(GroupName)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a warehouse asset from its name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetAssignment">WAREHOUSE:GetAssignment(request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get assignment of a request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetCoalition">WAREHOUSE:GetCoalition()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get coalition side of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetCoalitionName">WAREHOUSE:GetCoalitionName()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get coalition name of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetCoordinate">WAREHOUSE:GetCoordinate()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get coordinate of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetCountry">WAREHOUSE:GetCountry()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get country id of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetCountryName">WAREHOUSE:GetCountryName()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get country name of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetNumberOfAssets">WAREHOUSE:GetNumberOfAssets(Descriptor, DescriptorValue, OnlyMobile)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get number of assets in warehouse stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetRequestByID">WAREHOUSE:GetRequestByID(id)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get a warehouse request from its unique id.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetRunwayRepairtime">WAREHOUSE:GetRunwayRepairtime()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if runway is operational.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetSpawnZone">WAREHOUSE:GetSpawnZone()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the spawn zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetStockInfo">WAREHOUSE:GetStockInfo(stock)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Returns the number of assets for each generalized attribute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetVec2">WAREHOUSE:GetVec2()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get 2D vector of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetVec3">WAREHOUSE:GetVec3()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get 3D vector of warehouse static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).GetWarehouseZone">WAREHOUSE:GetWarehouseZone()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the warehouse zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).HasConnectionNaval">WAREHOUSE:HasConnectionNaval(warehouse, markpath, smokepath)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has a shipping lane defined to another warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).HasConnectionOffRoad">WAREHOUSE:HasConnectionOffRoad(warehouse, markpath, smokepath)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has an off road path defined to another warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).HasConnectionRail">WAREHOUSE:HasConnectionRail(warehouse, markpath, smokepath)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has a railroad connection to another warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).HasConnectionRoad">WAREHOUSE:HasConnectionRoad(warehouse, markpath, smokepath)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has a road connection to another warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsAttacked">WAREHOUSE:IsAttacked()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse is under attack by another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsDestroyed">WAREHOUSE:IsDestroyed()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has been destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsLoaded">WAREHOUSE:IsLoaded()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has been loaded from disk via the "Load" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsNotReadyYet">WAREHOUSE:IsNotReadyYet()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse has not been started yet, i.e.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsPaused">WAREHOUSE:IsPaused()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse is paused.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsRunning">WAREHOUSE:IsRunning()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse is running.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsRunwayOperational">WAREHOUSE:IsRunwayOperational()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if runway is operational.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsShip">WAREHOUSE:IsShip()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if warehouse physical representation is a ship.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsStatic">WAREHOUSE:IsStatic()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if warehouse physical representation is a static (not a unit) object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsStopped">WAREHOUSE:IsStopped()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if the warehouse is stopped.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).IsUnit">WAREHOUSE:IsUnit()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if warehouse physical representation is a unit (not a static) object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Load">WAREHOUSE:Load(path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Load" when the warehouse is loaded from a file on disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).New">WAREHOUSE:New(warehouse, alias)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The WAREHOUSE constructor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).NewAsset">WAREHOUSE:NewAsset(asset, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAirbaseCaptured">WAREHOUSE:OnAfterAirbaseCaptured(From, Event, To, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AirbaseCaptured" even user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAirbaseRecaptured">WAREHOUSE:OnAfterAirbaseRecaptured(From, Event, To, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AirbaseRecaptured" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterArrived">WAREHOUSE:OnAfterArrived(From, Event, To, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Arrived" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAssetDead">WAREHOUSE:OnAfterAssetDead(From, Event, To, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AssetDead" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAssetLowFuel">WAREHOUSE:OnAfterAssetLowFuel(From, Event, To, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AssetLowFuel" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAssetSpawned">WAREHOUSE:OnAfterAssetSpawned(From, Event, To, group, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AssetSpawned" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterAttacked">WAREHOUSE:OnAfterAttacked(From, Event, To, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Attacked" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterCaptured">WAREHOUSE:OnAfterCaptured(From, Event, To, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Captured" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterChangeCountry">WAREHOUSE:OnAfterChangeCountry(From, Event, To, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "ChangeCountry" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterDefeate">WAREHOUSE:OnAfterDefeate(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Defeated" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterDelivered">WAREHOUSE:OnAfterDelivered(From, Event, To, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Delivered" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterDestroyed">WAREHOUSE:OnAfterDestroyed(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Destroyed" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterLoad">WAREHOUSE:OnAfterLoad(From, Event, To, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Load" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterNewAsset">WAREHOUSE:OnAfterNewAsset(From, Event, To, asset, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "NewAsset" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterRequest">WAREHOUSE:OnAfterRequest(From, Event, To, Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Request" user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterRespawn">WAREHOUSE:OnAfterRespawn(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Respawn" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterSave">WAREHOUSE:OnAfterSave(From, Event, To, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Save" event user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnAfterSelfRequest">WAREHOUSE:OnAfterSelfRequest(From, Event, To, groupset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "SelfRequest" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).OnBeforeRequest">WAREHOUSE:OnBeforeRequest(From, Event, To, Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Request" user function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Pause">WAREHOUSE:Pause()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Pause".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Quantity">WAREHOUSE.Quantity</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Report">WAREHOUSE.Report</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, send status messages to coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Request">WAREHOUSE:Request(Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Request".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Respawn">WAREHOUSE:Respawn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Respawn".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Restart">WAREHOUSE:Restart()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Restart".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Save">WAREHOUSE:Save(path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Save" when the warehouse assets are saved to file on disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SelfRequest">WAREHOUSE:SelfRequest(groupset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "SelfRequest".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetAirbase">WAREHOUSE:SetAirbase(airbase)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the airbase belonging to this warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetAllowSpawnOnClientParking">WAREHOUSE:SetAllowSpawnOnClientParking()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set wether client parking spots can be used for spawning.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetAutoDefenceOff">WAREHOUSE:SetAutoDefenceOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set auto defence off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetAutoDefenceOn">WAREHOUSE:SetAutoDefenceOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set auto defence on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetDebugOff">WAREHOUSE:SetDebugOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set debug mode off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetDebugOn">WAREHOUSE:SetDebugOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set debug mode on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetHarborZone">WAREHOUSE:SetHarborZone(zone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Add a Harbor Zone for this warehouse where naval cargo units will spawn and be received.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetLowFuelThreshold">WAREHOUSE:SetLowFuelThreshold(threshold)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set low fuel threshold.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetMarker">WAREHOUSE:SetMarker(switch)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Show or don't show markers on the F10 map displaying the Warehouse stock and road/rail connections.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetParkingIDs">WAREHOUSE:SetParkingIDs(ParkingIDs)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set valid parking spot IDs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetPortZone">WAREHOUSE:SetPortZone(zone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the port zone for this warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetRailConnection">WAREHOUSE:SetRailConnection(coordinate)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the connection of the warehouse to the railroad.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetReportOff">WAREHOUSE:SetReportOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set report off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetReportOn">WAREHOUSE:SetReportOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set report on.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetRespawnAfterDestroyed">WAREHOUSE:SetRespawnAfterDestroyed(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set respawn after destroy.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetRoadConnection">WAREHOUSE:SetRoadConnection(coordinate)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the connection of the warehouse to the road.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetRunwayRepairtime">WAREHOUSE:SetRunwayRepairtime(RepairTime)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set the time until the runway(s) of an airdrome are repaired after it has been destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetSafeParkingOff">WAREHOUSE:SetSafeParkingOff()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Disable safe parking option.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetSafeParkingOn">WAREHOUSE:SetSafeParkingOn()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Enable safe parking option, i.e.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetSaveOnMissionEnd">WAREHOUSE:SetSaveOnMissionEnd(path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Enable auto save of warehouse assets at mission end event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetSpawnZone">WAREHOUSE:SetSpawnZone(zone, maxdist)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set a zone where the (ground) assets of the warehouse are spawned once requested.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetStatusUpdate">WAREHOUSE:SetStatusUpdate(timeinterval)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set interval of status updates.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetVerbosityLevel">WAREHOUSE:SetVerbosityLevel(VerbosityLevel)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set verbosity level.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).SetWarehouseZone">WAREHOUSE:SetWarehouseZone(zone)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set a warehouse zone.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Start">WAREHOUSE:Start()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Start".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Status">WAREHOUSE:Status()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Status".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).Stop">WAREHOUSE:Stop()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Stop".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).TransportType">WAREHOUSE.TransportType</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).UnPause">WAREHOUSE:UnPause()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Unpause".</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._Arrived">WAREHOUSE:_Arrived(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Task function for last waypoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._AssetItemInfo">WAREHOUSE:_AssetItemInfo(asset)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Asset item characteristics.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckAirbaseOwner">WAREHOUSE:_CheckAirbaseOwner()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Checks if the associated airbase still belongs to the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckAssetStatus">WAREHOUSE:_CheckAssetStatus()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function that checks if an asset group is still okay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckConquered">WAREHOUSE:_CheckConquered()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Checks if the warehouse zone was conquered by antoher coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckFuel">WAREHOUSE:_CheckFuel()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Checks fuel on all pening assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckParkingAsset">WAREHOUSE:_CheckParkingAsset(spot, asset)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check parking ID for an asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckParkingValid">WAREHOUSE:_CheckParkingValid(spot)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check parking ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckQueue">WAREHOUSE:_CheckQueue()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sorts the queue and checks if the request can be fulfilled.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckRequestConsistancy">WAREHOUSE:_CheckRequestConsistancy(queue)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Checks if the request can be fulfilled in general.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckRequestNow">WAREHOUSE:_CheckRequestNow(request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Checks if the request can be fulfilled right now.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._CheckRequestValid">WAREHOUSE:_CheckRequestValid(request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if a request is valid in general.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DebugMessage">WAREHOUSE:_DebugMessage(text, duration)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Debug message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DeleteQueueItem">WAREHOUSE:_DeleteQueueItem(qitem, queue)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delete item from queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DeleteQueueItemByID">WAREHOUSE:_DeleteQueueItemByID(qitemID, queue)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delete item from queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DeleteStockItem">WAREHOUSE:_DeleteStockItem(stockitem)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delete an asset item from stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DisplayStatus">WAREHOUSE:_DisplayStatus()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Display status of warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._DisplayStockItems">WAREHOUSE:_DisplayStockItems(stock)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Display stock items of warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._ErrorMessage">WAREHOUSE:_ErrorMessage(text, duration)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Error message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._FilterStock">WAREHOUSE:_FilterStock(stock, descriptor, attribute, nmax, mobile)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Filter stock assets by table entry.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._FindParkingForAssets">WAREHOUSE:_FindParkingForAssets(airbase, assets)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Seach unoccupied parking spots at the airbase for a list of assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._Fireworks">WAREHOUSE:_Fireworks(coord)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Fireworks!</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetAttribute">WAREHOUSE:_GetAttribute(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the generalized attribute of a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetFlightplan">WAREHOUSE:_GetFlightplan(asset, departure, destination)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Make a flight plan from a departure to a destination airport.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetIDsFromGroup">WAREHOUSE:_GetIDsFromGroup(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get warehouse id, asset id and request id from group name (alias).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetIDsFromGroupName">WAREHOUSE:_GetIDsFromGroupName(groupname)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get warehouse id, asset id and request id from group name (alias).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetMaxHeight">WAREHOUSE:_GetMaxHeight(D, alphaC, alphaD, Hdep, Hdest, Deltahhold)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Calculate the maximum height an aircraft can reach for the given parameters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetNameWithOut">WAREHOUSE:_GetNameWithOut(group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get group name without any spawn or cargo suffix #CARGO etc.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetObjectSize">WAREHOUSE:_GetObjectSize(DCSobject)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Size of the bounding box of a DCS object derived from the DCS descriptor table.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetRequestOfGroup">WAREHOUSE:_GetRequestOfGroup(group, queue)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get the request belonging to a group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetStockAssetsText">WAREHOUSE:_GetStockAssetsText(messagetoall)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get text about warehouse stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetTerminal">WAREHOUSE:_GetTerminal(_attribute, _category)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p> Get the proper terminal type based on generalized attribute of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GetTransportsForAssets">WAREHOUSE:_GetTransportsForAssets(Chosen, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Get (optimized) transport carriers for the given assets to be transported.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._GroupIsTransport">WAREHOUSE:_GroupIsTransport(group, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Is the group a used as transporter for a given request?</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._HasAttribute">WAREHOUSE:_HasAttribute(group, attribute)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Check if a group has a generalized attribute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._InfoMessage">WAREHOUSE:_InfoMessage(text, duration)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Info Message.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._JobDone">WAREHOUSE:_JobDone()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function that checks if a pending job is done and can be removed from queue.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._NewLane">WAREHOUSE:_NewLane(group, startcoord, finalcoord)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create a new path from a template group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventArrived">WAREHOUSE:_OnEventArrived(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Arrived event if an air unit/group arrived at its destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventBaseCaptured">WAREHOUSE:_OnEventBaseCaptured(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse event handling function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventBirth">WAREHOUSE:_OnEventBirth(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse event function, handling the birth 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="##(WAREHOUSE)._OnEventCrashOrDead">WAREHOUSE:_OnEventCrashOrDead(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse event handling function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventEngineShutdown">WAREHOUSE:_OnEventEngineShutdown(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function handling the event when a (warehouse) unit 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="##(WAREHOUSE)._OnEventEngineStartup">WAREHOUSE:_OnEventEngineStartup(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function handling the event when a (warehouse) unit 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="##(WAREHOUSE)._OnEventLanding">WAREHOUSE:_OnEventLanding(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function handling the event when a (warehouse) unit lands.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventMissionEnd">WAREHOUSE:_OnEventMissionEnd(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse event handling function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._OnEventTakeOff">WAREHOUSE:_OnEventTakeOff(EventData)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Function handling the event when a (warehouse) unit takes off.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._PassingWaypoint">WAREHOUSE:_PassingWaypoint(group, n, N)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Task function for when passing a waypoint.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._PrintQueue">WAREHOUSE:_PrintQueue(queue, name)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Prints the queue 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="##(WAREHOUSE)._QuantityRel2Abs">WAREHOUSE:_QuantityRel2Abs(relative, ntot)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Relative to absolute quantity.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._RegisterAsset">WAREHOUSE:_RegisterAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, liveries, skill, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Register new asset in globase warehouse data base.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._RouteAir">WAREHOUSE:_RouteAir(aircraft)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Route the airplane from one airbase another.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._RouteGround">WAREHOUSE:_RouteGround(group, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Route ground units to destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._RouteNaval">WAREHOUSE:_RouteNaval(group, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Route naval units along user defined shipping lanes to destination warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._RouteTrain">WAREHOUSE:_RouteTrain(Group, Coordinate, Speed)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Route trains to their destination - or at least to the closest point on rail of the desired final destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SimpleTaskFunction">WAREHOUSE:_SimpleTaskFunction(Function, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Simple task function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SimpleTaskFunctionWP">WAREHOUSE:_SimpleTaskFunctionWP(Function, group, n, N)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Simple task function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SortQueue">WAREHOUSE:_SortQueue()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Sort requests queue wrt prio and request uid.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SpawnAssetAircraft">WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrolled, lateactivated)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Spawn an aircraft asset (plane or helo) at the airbase associated with the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SpawnAssetGroundNaval">WAREHOUSE:_SpawnAssetGroundNaval(alias, asset, request, spawnzone, lateactivated)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Spawn a ground or naval asset in the corresponding spawn zone of the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SpawnAssetPrepareTemplate">WAREHOUSE:_SpawnAssetPrepareTemplate(asset, alias)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Prepare a spawn template for the asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._SpawnAssetRequest">WAREHOUSE:_SpawnAssetRequest(Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Spawns requested assets at warehouse or associated airbase.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._UnitDead">WAREHOUSE:_UnitDead(deadunit, deadgroup, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>A unit of a group just died.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._UpdateWarehouseMarkText">WAREHOUSE:_UpdateWarehouseMarkText()</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Create or update mark text at warehouse, which is displayed in F10 map showing how many assets of each type are in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AddAsset">WAREHOUSE:__AddAsset(delay, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trigger the FSM event "AddAsset" with a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AddRequest">WAREHOUSE:__AddRequest(delay, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AddRequest" with a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AirbaseCaptured">WAREHOUSE:__AirbaseCaptured(delay, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AirbaseCaptured" with a delay when the airbase of the warehouse has been captured by another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AirbaseRecaptured">WAREHOUSE:__AirbaseRecaptured(delay, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AirbaseRecaptured" with a delay when the airbase of the warehouse has been re-captured from the other coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Arrived">WAREHOUSE:__Arrived(delay, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Arrived" after a delay when a group has arrived at the destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AssetDead">WAREHOUSE:__AssetDead(delay, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the delayed FSM event "AssetDead" when an asset group has died.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AssetLowFuel">WAREHOUSE:__AssetLowFuel(delay, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AssetLowFuel" with a delay when an asset runs low on fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__AssetSpawned">WAREHOUSE:__AssetSpawned(delay, group, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "AssetSpawned" with a delay when the warehouse has spawned an asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Attacked">WAREHOUSE:__Attacked(delay, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Attacked" with a delay when a warehouse is under attack by an another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Captured">WAREHOUSE:__Captured(delay, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Captured" with a delay when a warehouse has been captured by another coalition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__ChangeCountry">WAREHOUSE:__ChangeCountry(delay, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "ChangeCountry" after a delay so the warehouse is respawned with the new country.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Defeated">WAREHOUSE:__Defeated(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Defeated" with a delay when an attack from an enemy was defeated.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Delivered">WAREHOUSE:__Delivered(delay, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Delivered" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Destroyed">WAREHOUSE:__Destroyed(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Destroyed" with a delay when the warehouse was destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Load">WAREHOUSE:__Load(delay, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__NewAsset">WAREHOUSE:__NewAsset(delay, asset, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Pause">WAREHOUSE:__Pause(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Pause" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Request">WAREHOUSE:__Request(Delay, Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Request" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Respawn">WAREHOUSE:__Respawn(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Respawn" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Restart">WAREHOUSE:__Restart(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Restart" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Save">WAREHOUSE:__Save(delay, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__SelfRequest">WAREHOUSE:__SelfRequest(delay, groupset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "SelfRequest" with a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Start">WAREHOUSE:__Start(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Start" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Status">WAREHOUSE:__Status(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Status" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Stop">WAREHOUSE:__Stop(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Stop" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).__Unpause">WAREHOUSE:__Unpause(delay)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Triggers the FSM event "Unpause" after a delay.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).airbase">WAREHOUSE.airbase</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airbase the warehouse belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).airbasename">WAREHOUSE.airbasename</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the airbase associated to the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).alias">WAREHOUSE.alias</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Alias of the warehouse. Name its called when sending messages.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).allowSpawnOnClientSpots">WAREHOUSE.allowSpawnOnClientSpots</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).autodefence">WAREHOUSE.autodefence</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>When the warehouse is under attack, automatically spawn assets to defend the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).autosave">WAREHOUSE.autosave</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Automatically save assets to file when mission ends.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).autosavefile">WAREHOUSE.autosavefile</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>File name of the auto asset save file. Default is auto generated from warehouse id and name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).autosavepath">WAREHOUSE.autosavepath</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Path where the asset file is saved on auto save.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).clientcoords">WAREHOUSE.clientcoords</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).coalition">WAREHOUSE.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="##(WAREHOUSE).countryid">WAREHOUSE.countryid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).dTstatus">WAREHOUSE.dTstatus</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Time interval in seconds of updating the warehouse status and processing new events. Default 30 seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).defending">WAREHOUSE.defending</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all defending requests, i.e. self requests that were if the warehouse is under attack. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).delivered">WAREHOUSE.delivered</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all delivered requests. Table elements are #boolean. If true, all cargo has been delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).flightcontrol">WAREHOUSE.flightcontrol</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Flight control of this warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).harborzone">WAREHOUSE.harborzone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).isShip">WAREHOUSE.isShip</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, warehouse is represented by a ship unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).isUnit">WAREHOUSE.isUnit</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, warehouse is represented by a unit instead of a static.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).lid">WAREHOUSE.lid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).lowfuelthresh">WAREHOUSE.lowfuelthresh</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Low fuel threshold. Triggers the event AssetLowFuel if for any unit fuel goes below this number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markerOn">WAREHOUSE.markerOn</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, markers are displayed on the F10 map.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markerRail">WAREHOUSE.markerRail</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Rail road connection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markerRoad">WAREHOUSE.markerRoad</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Road connection.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markerWarehouse">WAREHOUSE.markerWarehouse</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Marker warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markerid">WAREHOUSE.markerid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>ID of the warehouse marker at the airbase.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markrail">WAREHOUSE.markrail</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).markroad">WAREHOUSE.markroad</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).offroadpaths">WAREHOUSE.offroadpaths</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding user defined paths from one warehouse to another.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAddAsset">WAREHOUSE:onafterAddAsset(From, Event, To, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment, other)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AddAsset" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAddRequest">WAREHOUSE:onafterAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AddRequest" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAirbaseCaptured">WAREHOUSE:onafterAirbaseCaptured(From, Event, To, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AirbaseCaptured" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAirbaseRecaptured">WAREHOUSE:onafterAirbaseRecaptured(From, Event, To, Coalition)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AirbaseRecaptured" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterArrived">WAREHOUSE:onafterArrived(From, Event, To, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Arrived" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAssetDead">WAREHOUSE:onafterAssetDead(From, Event, To, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AssetDead" event triggered when an asset group died.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAssetSpawned">WAREHOUSE:onafterAssetSpawned(From, Event, To, group, asset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterAttacked">WAREHOUSE:onafterAttacked(From, Event, To, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Attacked" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterCaptured">WAREHOUSE:onafterCaptured(From, Event, To, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Captured" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterChangeCountry">WAREHOUSE:onafterChangeCountry(From, Event, To, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "ChangeCountry" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterDefeated">WAREHOUSE:onafterDefeated(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Defeated" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterDelivered">WAREHOUSE:onafterDelivered(From, Event, To, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Delivered" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterDestroyed">WAREHOUSE:onafterDestroyed(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Destroyed" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterLoad">WAREHOUSE:onafterLoad(From, Event, To, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Load" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterNewAsset">WAREHOUSE:onafterNewAsset(From, Event, To, asset, assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "NewAsset" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterPause">WAREHOUSE:onafterPause(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Pause" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRequest">WAREHOUSE:onafterRequest(From, Event, To, Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Request" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRequestSpawned">WAREHOUSE:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet, TransportGroupSet)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "RequestSpawned" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRespawn">WAREHOUSE:onafterRespawn(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Respawn warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRestart">WAREHOUSE:onafterRestart(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Restart" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRunwayDestroyed">WAREHOUSE:onafterRunwayDestroyed(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "RunwayDestroyed" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterRunwayRepaired">WAREHOUSE:onafterRunwayRepaired(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "RunwayRepaired" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterSave">WAREHOUSE:onafterSave(From, Event, To, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Save" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterSelfRequest">WAREHOUSE:onafterSelfRequest(From, Event, To, groupset, request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "SelfRequest" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterStart">WAREHOUSE:onafterStart(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after Start event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterStatus">WAREHOUSE:onafterStatus(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after Status event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterStop">WAREHOUSE:onafterStop(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Stop" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterUnloaded">WAREHOUSE:onafterUnloaded(From, Event, To, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Unloaded" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onafterUnpause">WAREHOUSE:onafterUnpause(From, Event, To)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On after "Unpause" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeAddRequest">WAREHOUSE:onbeforeAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "AddRequest" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeArrived">WAREHOUSE:onbeforeArrived(From, Event, To, group)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Arrived" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeCaptured">WAREHOUSE:onbeforeCaptured(From, Event, To, Coalition, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Captured" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeChangeCountry">WAREHOUSE:onbeforeChangeCountry(From, Event, To, Country)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "ChangeCountry" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeLoad">WAREHOUSE:onbeforeLoad(From, Event, To, path, filename)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Load" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onbeforeRequest">WAREHOUSE:onbeforeRequest(From, Event, To, Request)</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>On before "Request" event.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).parkingIDs">WAREHOUSE.parkingIDs</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).pending">WAREHOUSE.pending</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all pending requests, i.e. those that are currently in progress. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).portzone">WAREHOUSE.portzone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Zone defining the port of a warehouse. This is where naval assets are spawned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).queue">WAREHOUSE.queue</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all queued requests. Table entries are of type <a href="##(WAREHOUSE).Queueitem">WAREHOUSE.Queueitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).queueid">WAREHOUSE.queueid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unit id of each request in the queue. Essentially a running number starting at one and incremented when a new request is added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).rail">WAREHOUSE.rail</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Closest point to warehouse on rail.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).respawnafterdestroyed">WAREHOUSE.respawnafterdestroyed</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, warehouse is respawned after it was destroyed. Assets are kept.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).respawndelay">WAREHOUSE.respawndelay</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Delay before respawn in seconds.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).road">WAREHOUSE.road</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Closest point to warehouse on road.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).runwaydestroyed">WAREHOUSE.runwaydestroyed</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Time stamp timer.getAbsTime() when the runway was destroyed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).runwayrepairtime">WAREHOUSE.runwayrepairtime</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Time in seconds until runway will be repaired after it was destroyed. Default is 3600 sec (one hour).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).safeparking">WAREHOUSE.safeparking</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, parking spots for aircraft are considered as occupied if e.g. a client aircraft is parked there. Default false.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).shippinglanes">WAREHOUSE.shippinglanes</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding the user defined shipping between warehouses.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).spawnzone">WAREHOUSE.spawnzone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Zone in which assets are spawned.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).spawnzonemaxdist">WAREHOUSE.spawnzonemaxdist</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Max distance between warehouse and spawn zone. Default 5000 meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).stock">WAREHOUSE.stock</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all assets in stock. Table entries are of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).transporting">WAREHOUSE.transporting</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding assets currently transporting cargo assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).uid">WAREHOUSE.uid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique ID of the warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).verbosity">WAREHOUSE.verbosity</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Verbosity level.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).version">WAREHOUSE.version</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Warehouse class version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).warehouse">WAREHOUSE.warehouse</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The phyical warehouse structure.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).wid">WAREHOUSE.wid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Identifier of the warehouse printed before other 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="##(WAREHOUSE).zone">WAREHOUSE.zone</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Zone around the warehouse. If this zone is captured, the warehouse and all its assets goes to the capturing coalition.</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="##(WAREHOUSE).AddEndState">WAREHOUSE: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="##(WAREHOUSE).AddProcess">WAREHOUSE: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="##(WAREHOUSE).AddScore">WAREHOUSE: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="##(WAREHOUSE).AddScoreProcess">WAREHOUSE: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="##(WAREHOUSE).AddTransition">WAREHOUSE: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="##(WAREHOUSE).CallScheduler">WAREHOUSE.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="##(WAREHOUSE).ClassName">WAREHOUSE.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="##(WAREHOUSE).Events">WAREHOUSE.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="##(WAREHOUSE).GetCurrentState">WAREHOUSE: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="##(WAREHOUSE).GetEndStates">WAREHOUSE: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="##(WAREHOUSE).GetProcess">WAREHOUSE: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="##(WAREHOUSE).GetProcesses">WAREHOUSE: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="##(WAREHOUSE).GetScores">WAREHOUSE: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="##(WAREHOUSE).GetStartState">WAREHOUSE: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="##(WAREHOUSE).GetState">WAREHOUSE: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="##(WAREHOUSE).GetSubs">WAREHOUSE: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="##(WAREHOUSE).GetTransitions">WAREHOUSE: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="##(WAREHOUSE).Is">WAREHOUSE: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="##(WAREHOUSE).LoadCallBacks">WAREHOUSE: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="##(WAREHOUSE).New">WAREHOUSE: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="##(WAREHOUSE).Scores">WAREHOUSE.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="##(WAREHOUSE).SetProcess">WAREHOUSE: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="##(WAREHOUSE).SetStartState">WAREHOUSE: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="##(WAREHOUSE)._EndStates">WAREHOUSE._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="##(WAREHOUSE)._EventSchedules">WAREHOUSE._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="##(WAREHOUSE)._Processes">WAREHOUSE._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="##(WAREHOUSE)._Scores">WAREHOUSE._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="##(WAREHOUSE)._StartState">WAREHOUSE._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="##(WAREHOUSE)._Transitions">WAREHOUSE._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="##(WAREHOUSE)._add_to_map">WAREHOUSE:_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="##(WAREHOUSE)._call_handler">WAREHOUSE:_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="##(WAREHOUSE)._create_transition">WAREHOUSE:_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="##(WAREHOUSE)._delayed_transition">WAREHOUSE:_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="##(WAREHOUSE)._eventmap">WAREHOUSE:_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="##(WAREHOUSE)._gosub">WAREHOUSE:_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="##(WAREHOUSE)._handler">WAREHOUSE:_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="##(WAREHOUSE)._isendstate">WAREHOUSE:_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="##(WAREHOUSE)._submap">WAREHOUSE:_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="##(WAREHOUSE).can">WAREHOUSE: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="##(WAREHOUSE).cannot">WAREHOUSE: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="##(WAREHOUSE).current">WAREHOUSE.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="##(WAREHOUSE).endstates">WAREHOUSE.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="##(WAREHOUSE).is">WAREHOUSE: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="##(WAREHOUSE).options">WAREHOUSE.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="##(WAREHOUSE).subs">WAREHOUSE.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="##(WAREHOUSE).ClassID">WAREHOUSE.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="##(WAREHOUSE).ClassName">WAREHOUSE.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="##(WAREHOUSE).ClassNameAndID">WAREHOUSE.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="##(WAREHOUSE).ClearState">WAREHOUSE: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="##(WAREHOUSE).CreateEventBirth">WAREHOUSE: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="##(WAREHOUSE).CreateEventCrash">WAREHOUSE: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="##(WAREHOUSE).CreateEventDead">WAREHOUSE: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="##(WAREHOUSE).CreateEventDynamicCargoLoaded">WAREHOUSE: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="##(WAREHOUSE).CreateEventDynamicCargoRemoved">WAREHOUSE: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="##(WAREHOUSE).CreateEventDynamicCargoUnloaded">WAREHOUSE: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="##(WAREHOUSE).CreateEventNewDynamicCargo">WAREHOUSE: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="##(WAREHOUSE).CreateEventPlayerEnterAircraft">WAREHOUSE: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="##(WAREHOUSE).CreateEventRemoveUnit">WAREHOUSE: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="##(WAREHOUSE).CreateEventTakeoff">WAREHOUSE: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="##(WAREHOUSE).CreateEventUnitLost">WAREHOUSE: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="##(WAREHOUSE).E">WAREHOUSE: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="##(WAREHOUSE).EventDispatcher">WAREHOUSE: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="##(WAREHOUSE).EventRemoveAll">WAREHOUSE: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="##(WAREHOUSE).F">WAREHOUSE: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="##(WAREHOUSE).F2">WAREHOUSE: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="##(WAREHOUSE).F3">WAREHOUSE: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="##(WAREHOUSE).GetClassID">WAREHOUSE: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="##(WAREHOUSE).GetClassName">WAREHOUSE: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="##(WAREHOUSE).GetClassNameAndID">WAREHOUSE: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="##(WAREHOUSE).GetEventPriority">WAREHOUSE: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="##(WAREHOUSE).GetParent">WAREHOUSE: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="##(WAREHOUSE).GetState">WAREHOUSE: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="##(WAREHOUSE).HandleEvent">WAREHOUSE: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="##(WAREHOUSE).I">WAREHOUSE: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="##(WAREHOUSE).Inherit">WAREHOUSE: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="##(WAREHOUSE).IsInstanceOf">WAREHOUSE: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="##(WAREHOUSE).IsTrace">WAREHOUSE: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="##(WAREHOUSE).New">WAREHOUSE: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="##(WAREHOUSE).OnEvent">WAREHOUSE: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="##(WAREHOUSE).OnEventBDA">WAREHOUSE: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="##(WAREHOUSE).OnEventBaseCaptured">WAREHOUSE: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="##(WAREHOUSE).OnEventBirth">WAREHOUSE: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="##(WAREHOUSE).OnEventCrash">WAREHOUSE: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="##(WAREHOUSE).OnEventDead">WAREHOUSE: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="##(WAREHOUSE).OnEventDetailedFailure">WAREHOUSE: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="##(WAREHOUSE).OnEventDiscardChairAfterEjection">WAREHOUSE: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="##(WAREHOUSE).OnEventDynamicCargoLoaded">WAREHOUSE: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="##(WAREHOUSE).OnEventDynamicCargoRemoved">WAREHOUSE: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="##(WAREHOUSE).OnEventDynamicCargoUnloaded">WAREHOUSE: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="##(WAREHOUSE).OnEventEjection">WAREHOUSE: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="##(WAREHOUSE).OnEventEngineShutdown">WAREHOUSE: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="##(WAREHOUSE).OnEventEngineStartup">WAREHOUSE: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="##(WAREHOUSE).OnEventHit">WAREHOUSE: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="##(WAREHOUSE).OnEventHumanFailure">WAREHOUSE: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="##(WAREHOUSE).OnEventKill">WAREHOUSE: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="##(WAREHOUSE).OnEventLand">WAREHOUSE: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="##(WAREHOUSE).OnEventLandingAfterEjection">WAREHOUSE: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="##(WAREHOUSE).OnEventLandingQualityMark">WAREHOUSE: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="##(WAREHOUSE).OnEventMarkAdded">WAREHOUSE: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="##(WAREHOUSE).OnEventMarkChange">WAREHOUSE: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="##(WAREHOUSE).OnEventMarkRemoved">WAREHOUSE: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="##(WAREHOUSE).OnEventMissionEnd">WAREHOUSE: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="##(WAREHOUSE).OnEventMissionStart">WAREHOUSE: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="##(WAREHOUSE).OnEventNewDynamicCargo">WAREHOUSE: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="##(WAREHOUSE).OnEventParatrooperLanding">WAREHOUSE: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="##(WAREHOUSE).OnEventPilotDead">WAREHOUSE: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="##(WAREHOUSE).OnEventPlayerEnterAircraft">WAREHOUSE: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="##(WAREHOUSE).OnEventPlayerEnterUnit">WAREHOUSE: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="##(WAREHOUSE).OnEventPlayerLeaveUnit">WAREHOUSE: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="##(WAREHOUSE).OnEventRefueling">WAREHOUSE: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="##(WAREHOUSE).OnEventRefuelingStop">WAREHOUSE: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="##(WAREHOUSE).OnEventScore">WAREHOUSE: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="##(WAREHOUSE).OnEventShootingEnd">WAREHOUSE: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="##(WAREHOUSE).OnEventShootingStart">WAREHOUSE: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="##(WAREHOUSE).OnEventShot">WAREHOUSE: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="##(WAREHOUSE).OnEventTakeoff">WAREHOUSE: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="##(WAREHOUSE).OnEventTriggerZone">WAREHOUSE: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="##(WAREHOUSE).OnEventUnitLost">WAREHOUSE: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="##(WAREHOUSE).ScheduleOnce">WAREHOUSE: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="##(WAREHOUSE).ScheduleRepeat">WAREHOUSE: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="##(WAREHOUSE).ScheduleStop">WAREHOUSE: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="##(WAREHOUSE).Scheduler">WAREHOUSE.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="##(WAREHOUSE).SetEventPriority">WAREHOUSE: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="##(WAREHOUSE).SetState">WAREHOUSE: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="##(WAREHOUSE).T">WAREHOUSE: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="##(WAREHOUSE).T2">WAREHOUSE: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="##(WAREHOUSE).T3">WAREHOUSE: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="##(WAREHOUSE).TraceAll">WAREHOUSE: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="##(WAREHOUSE).TraceClass">WAREHOUSE: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="##(WAREHOUSE).TraceClassMethod">WAREHOUSE: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="##(WAREHOUSE).TraceLevel">WAREHOUSE: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="##(WAREHOUSE).TraceOff">WAREHOUSE: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="##(WAREHOUSE).TraceOn">WAREHOUSE: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="##(WAREHOUSE).TraceOnOff">WAREHOUSE: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="##(WAREHOUSE).UnHandleEvent">WAREHOUSE: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="##(WAREHOUSE)._">WAREHOUSE._</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE)._F">WAREHOUSE:_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="##(WAREHOUSE)._Serialize">WAREHOUSE:_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="##(WAREHOUSE)._T">WAREHOUSE:_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="##(WAREHOUSE).__">WAREHOUSE.__</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE).onEvent">WAREHOUSE: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="#(WAREHOUSE.Assetitem)">Type <strong>WAREHOUSE.Assetitem</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Assetitem)">WAREHOUSE.Assetitem</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 WAREHOUSE.Assetitem</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="##(WAREHOUSE.Assetitem).DCSdesc">WAREHOUSE.Assetitem.DCSdesc</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>All DCS descriptors.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).Treturned">WAREHOUSE.Assetitem.Treturned</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Time stamp when asset returned to its legion (airwing, brigade).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).arrived">WAREHOUSE.Assetitem.arrived</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, asset arrived at its destination.</p>
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).assignment">WAREHOUSE.Assetitem.assignment</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Assignment of the asset. This could, e.g., be used in the @{#WAREHOUSE.OnAfterNewAsset) function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).attribute">WAREHOUSE.Assetitem.attribute</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Generalized attribute of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).cargobay">WAREHOUSE.Assetitem.cargobay</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Array of cargo bays of all units in an asset group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).cargobaymax">WAREHOUSE.Assetitem.cargobaymax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Largest cargo bay of all units in the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).cargobaytot">WAREHOUSE.Assetitem.cargobaytot</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Total weight in kg that fits in the cargo bay of all asset group units.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).category">WAREHOUSE.Assetitem.category</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Category of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).cohort">WAREHOUSE.Assetitem.cohort</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The cohort this asset belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).damage">WAREHOUSE.Assetitem.damage</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Damage of asset group in percent.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).flightgroup">WAREHOUSE.Assetitem.flightgroup</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The flightgroup object.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).isReserved">WAREHOUSE.Assetitem.isReserved</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, asset was reserved and cannot be selected by another request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).iscargo">WAREHOUSE.Assetitem.iscargo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, asset is cargo. If false asset is transport. Nil if in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).legion">WAREHOUSE.Assetitem.legion</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The legion this asset belonts to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).life0">WAREHOUSE.Assetitem.life0</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).livery">WAREHOUSE.Assetitem.livery</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Livery of the asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).loadradius">WAREHOUSE.Assetitem.loadradius</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Distance when cargo is loaded into the carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).nunits">WAREHOUSE.Assetitem.nunits</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of units in the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).payload">WAREHOUSE.Assetitem.payload</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The payload of the asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).range">WAREHOUSE.Assetitem.range</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Range of the unit in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).requested">WAREHOUSE.Assetitem.requested</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If <code>true</code>, asset was requested and cannot be selected by another request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).rid">WAREHOUSE.Assetitem.rid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Request ID of this asset (if any).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).size">WAREHOUSE.Assetitem.size</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum size in length and with of the asset in meters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).skill">WAREHOUSE.Assetitem.skill</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Skill of AI unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).spawned">WAREHOUSE.Assetitem.spawned</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, asset was spawned into the cruel world. If false, it is still in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).spawngroupname">WAREHOUSE.Assetitem.spawngroupname</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the spawned group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).speedmax">WAREHOUSE.Assetitem.speedmax</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Maximum speed in km/h the group can do.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).squadname">WAREHOUSE.Assetitem.squadname</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the squadron this asset belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).task">WAREHOUSE.Assetitem.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="##(WAREHOUSE.Assetitem).template">WAREHOUSE.Assetitem.template</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The spawn template of the group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).templatename">WAREHOUSE.Assetitem.templatename</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the template group.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).uid">WAREHOUSE.Assetitem.uid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique id of the asset.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).unittype">WAREHOUSE.Assetitem.unittype</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Type of the first unit of the group as obtained by the Object.getTypeName() DCS API function.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).weight">WAREHOUSE.Assetitem.weight</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The weight of the whole asset group in kilograms.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).weights">WAREHOUSE.Assetitem.weights</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Assetitem).wid">WAREHOUSE.Assetitem.wid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>ID of the warehouse this asset belongs to.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Attribute)">Type <strong>WAREHOUSE.Attribute</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Attribute)">WAREHOUSE.Attribute</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 WAREHOUSE.Attribute</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="##(WAREHOUSE.Attribute).AIR_ATTACKHELO">WAREHOUSE.Attribute.AIR_ATTACKHELO</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Attack helicopter.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_AWACS">WAREHOUSE.Attribute.AIR_AWACS</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airborne Early Warning and Control System.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_BOMBER">WAREHOUSE.Attribute.AIR_BOMBER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Aircraft which can be used for strategic bombing.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_FIGHTER">WAREHOUSE.Attribute.AIR_FIGHTER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Fighter, interceptor, ... airplane.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_OTHER">WAREHOUSE.Attribute.AIR_OTHER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Any airborne unit that does not fall into any other airborne category.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_TANKER">WAREHOUSE.Attribute.AIR_TANKER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airplane which can refuel other aircraft.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_TRANSPORTHELO">WAREHOUSE.Attribute.AIR_TRANSPORTHELO</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Helicopter with transport capability. This can be used to transport other assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_TRANSPORTPLANE">WAREHOUSE.Attribute.AIR_TRANSPORTPLANE</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Airplane with transport capability. This can be used to transport other assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).AIR_UAV">WAREHOUSE.Attribute.AIR_UAV</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unpiloted Aerial Vehicle, e.g. drones.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_AAA">WAREHOUSE.Attribute.GROUND_AAA</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Anti-Aircraft Artillery.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_APC">WAREHOUSE.Attribute.GROUND_APC</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Infantry carriers, in particular Amoured Personell Carrier. This can be used to transport other assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_ARTILLERY">WAREHOUSE.Attribute.GROUND_ARTILLERY</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Artillery assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_EWR">WAREHOUSE.Attribute.GROUND_EWR</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Early Warning Radar.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_IFV">WAREHOUSE.Attribute.GROUND_IFV</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Ground infantry fighting vehicle.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_INFANTRY">WAREHOUSE.Attribute.GROUND_INFANTRY</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Ground infantry assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_OTHER">WAREHOUSE.Attribute.GROUND_OTHER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Any ground unit that does not fall into any other ground category.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_SAM">WAREHOUSE.Attribute.GROUND_SAM</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Surface-to-Air Missile system or components.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_TANK">WAREHOUSE.Attribute.GROUND_TANK</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Tanks (modern or old).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_TRAIN">WAREHOUSE.Attribute.GROUND_TRAIN</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Trains. Not that trains are <strong>not</strong> yet properly implemented in DCS and cannot be used currently.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).GROUND_TRUCK">WAREHOUSE.Attribute.GROUND_TRUCK</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unarmed ground vehicles, which has the DCS "Truck" attribute.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).NAVAL_AIRCRAFTCARRIER">WAREHOUSE.Attribute.NAVAL_AIRCRAFTCARRIER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Aircraft carrier.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).NAVAL_ARMEDSHIP">WAREHOUSE.Attribute.NAVAL_ARMEDSHIP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Any armed ship that is not an aircraft carrier, a cruiser, destroyer, firgatte or corvette.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).NAVAL_OTHER">WAREHOUSE.Attribute.NAVAL_OTHER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Any naval unit that does not fall into any other naval category.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).NAVAL_UNARMEDSHIP">WAREHOUSE.Attribute.NAVAL_UNARMEDSHIP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Any unarmed naval vessel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).NAVAL_WARSHIP">WAREHOUSE.Attribute.NAVAL_WARSHIP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>War ship, i.e. cruisers, destroyers, firgates and corvettes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Attribute).OTHER_UNKNOWN">WAREHOUSE.Attribute.OTHER_UNKNOWN</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Anything that does not fall into any other category.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Descriptor)">Type <strong>WAREHOUSE.Descriptor</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Descriptor)">WAREHOUSE.Descriptor</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 WAREHOUSE.Descriptor</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="##(WAREHOUSE.Descriptor).ASSETLIST">WAREHOUSE.Descriptor.ASSETLIST</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>List of specific assets gives as a table of assets. Mind the curly brackets {}.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Descriptor).ASSIGNMENT">WAREHOUSE.Descriptor.ASSIGNMENT</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Assignment of asset when it was added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Descriptor).ATTRIBUTE">WAREHOUSE.Descriptor.ATTRIBUTE</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Generalized attribute <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Descriptor).CATEGORY">WAREHOUSE.Descriptor.CATEGORY</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Asset category of type DCS#Group.Category, i.e. GROUND, AIRPLANE, HELICOPTER, SHIP, TRAIN.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Descriptor).GROUPNAME">WAREHOUSE.Descriptor.GROUPNAME</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Name of the asset template.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Descriptor).UNITTYPE">WAREHOUSE.Descriptor.UNITTYPE</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Typename of the DCS unit, e.g. "A-10C".</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Pendingitem)">Type <strong>WAREHOUSE.Pendingitem</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Pendingitem)">WAREHOUSE.Pendingitem</a></strong>
|
|
, extends <strong><a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</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 WAREHOUSE.Pendingitem</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="##(WAREHOUSE.Pendingitem).assetproblem">WAREHOUSE.Pendingitem.assetproblem</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table with assets that might have problems (damage or stuck).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).cargogroupset">WAREHOUSE.Pendingitem.cargogroupset</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set of cargo groups do be delivered.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).carriercargo">WAREHOUSE.Pendingitem.carriercargo</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding the cargo groups of each carrier unit.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).lowfuel">WAREHOUSE.Pendingitem.lowfuel</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>If true, at least one asset group is low on fuel.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).ndelivered">WAREHOUSE.Pendingitem.ndelivered</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of groups delivered to destination.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).ntransport">WAREHOUSE.Pendingitem.ntransport</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).ntransporthome">WAREHOUSE.Pendingitem.ntransporthome</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of transports back home.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).timestamp">WAREHOUSE.Pendingitem.timestamp</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Absolute mission time in seconds when the request was processed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).transportcargoset">WAREHOUSE.Pendingitem.transportcargoset</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set of cargo objects.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Pendingitem).transportgroupset">WAREHOUSE.Pendingitem.transportgroupset</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Set of cargo transport carrier groups.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Quantity)">Type <strong>WAREHOUSE.Quantity</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Quantity)">WAREHOUSE.Quantity</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 WAREHOUSE.Quantity</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="##(WAREHOUSE.Quantity).ALL">WAREHOUSE.Quantity.ALL</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>All "all" assets currently in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Quantity).HALF">WAREHOUSE.Quantity.HALF</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Half "1/2" of assets in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Quantity).QUARTER">WAREHOUSE.Quantity.QUARTER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>One quarter "1/4" of assets in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Quantity).THIRD">WAREHOUSE.Quantity.THIRD</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>One third "1/3" of assets in stock.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Quantity).THREEQUARTERS">WAREHOUSE.Quantity.THREEQUARTERS</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Three quarters "3/4" of assets in stock.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Queueitem)">Type <strong>WAREHOUSE.Queueitem</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.Queueitem)">WAREHOUSE.Queueitem</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 WAREHOUSE.Queueitem</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="##(WAREHOUSE.Queueitem).airbase">WAREHOUSE.Queueitem.airbase</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>The airbase beloning to requesting warehouse if any.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).assetdesc">WAREHOUSE.Queueitem.assetdesc</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Descriptor of the requested asset. Enumerator of type <a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).assetdescval">WAREHOUSE.Queueitem.assetdescval</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Value of the asset descriptor. Type depends on "assetdesc" descriptor.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).assetproblem">WAREHOUSE.Queueitem.assetproblem</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).assets">WAREHOUSE.Queueitem.assets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table of self propelled (or cargo) and transport assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a> and can be accessed by their asset ID.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).assignment">WAREHOUSE.Queueitem.assignment</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>A keyword or text that later be used to identify this request and postprocess the assets.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).cargoassets">WAREHOUSE.Queueitem.cargoassets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table of cargo (or self propelled) assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).cargoattribute">WAREHOUSE.Queueitem.cargoattribute</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Attribute of cargo assets of type <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).cargocategory">WAREHOUSE.Queueitem.cargocategory</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Category of cargo assets of type <a href="##(WAREHOUSE).Category">WAREHOUSE.Category</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).category">WAREHOUSE.Queueitem.category</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Category of the requesting airbase, i.e. airdrome, helipad/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="##(WAREHOUSE.Queueitem).lateActivation">WAREHOUSE.Queueitem.lateActivation</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Assets are spawned in late activated state.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).nasset">WAREHOUSE.Queueitem.nasset</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Number of asset groups requested.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).ntransport">WAREHOUSE.Queueitem.ntransport</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Max. number of transport units requested.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).prio">WAREHOUSE.Queueitem.prio</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Priority of the request. Number between 1 (high) and 100 (low).</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).timestamp">WAREHOUSE.Queueitem.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="##(WAREHOUSE.Queueitem).toself">WAREHOUSE.Queueitem.toself</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Self request, i.e. warehouse requests assets from itself.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).transportassets">WAREHOUSE.Queueitem.transportassets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table of transport carrier assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).transportattribute">WAREHOUSE.Queueitem.transportattribute</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Attribute of transport assets of type <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).transportcategory">WAREHOUSE.Queueitem.transportcategory</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Category of transport assets of type <a href="##(WAREHOUSE).Category">WAREHOUSE.Category</a>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).transporttype">WAREHOUSE.Queueitem.transporttype</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transport unit type.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).uid">WAREHOUSE.Queueitem.uid</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique id of the queue item.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.Queueitem).warehouse">WAREHOUSE.Queueitem.warehouse</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Requesting warehouse.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.TransportType)">Type <strong>WAREHOUSE.TransportType</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(WAREHOUSE.TransportType)">WAREHOUSE.TransportType</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 WAREHOUSE.TransportType</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="##(WAREHOUSE.TransportType).AIRCRAFTCARRIER">WAREHOUSE.TransportType.AIRCRAFTCARRIER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).AIRPLANE">WAREHOUSE.TransportType.AIRPLANE</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transports are carried out by airplanes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).APC">WAREHOUSE.TransportType.APC</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transports are conducted by APCs.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).ARMEDSHIP">WAREHOUSE.TransportType.ARMEDSHIP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).HELICOPTER">WAREHOUSE.TransportType.HELICOPTER</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transports are carried out by helicopters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).SELFPROPELLED">WAREHOUSE.TransportType.SELFPROPELLED</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Assets go to their destination by themselves. No transport carrier needed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).SHIP">WAREHOUSE.TransportType.SHIP</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transports are conducted by ships. Not implemented yet.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).TRAIN">WAREHOUSE.TransportType.TRAIN</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Transports are conducted by trains. Not implemented yet. Also trains are buggy in DCS.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(WAREHOUSE.TransportType).WARSHIP">WAREHOUSE.TransportType.WARSHIP</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="#(_WAREHOUSEDB)">Type <strong>_WAREHOUSEDB</strong></a></h2></div>
|
|
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
|
<strong><a href="##(_WAREHOUSEDB)">_WAREHOUSEDB</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 _WAREHOUSEDB</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="##(_WAREHOUSEDB).AssetID">_WAREHOUSEDB.AssetID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique ID of each asset. This is a running number, which is increased each time a new asset is added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(_WAREHOUSEDB).Assets">_WAREHOUSEDB.Assets</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding registered assets, which are of type <a href="Functional.Warehouse.html##(WAREHOUSE).Assetitem">Functional.Warehouse#WAREHOUSE.Assetitem</a>.#</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(_WAREHOUSEDB).WarehouseID">_WAREHOUSEDB.WarehouseID</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Unique ID of the warehouse. Running number.</p>
|
|
</td>
|
|
</tr>
|
|
<tr class="w3-border">
|
|
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(_WAREHOUSEDB).Warehouses">_WAREHOUSEDB.Warehouses</a></p></td>
|
|
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
|
<p>Table holding all defined <a href="##(WAREHOUSE)">#WAREHOUSE</a> objects by their unique ids.</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Functional.Warehouse)" >Type <strong>Functional.Warehouse</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##WAREHOUSE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE)">Type <strong>WAREHOUSE</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>WAREHOUSE class.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<a id="#(WAREHOUSE).Attribute" ><strong>WAREHOUSE.Attribute</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).ClassName" ><strong>WAREHOUSE.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Debug" ><strong>WAREHOUSE.Debug</strong></a>
|
|
|
|
<p>If true, send debug messages to all.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<a id="#(WAREHOUSE).Descriptor" ><strong>WAREHOUSE.Descriptor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Quantity)">#WAREHOUSE.Quantity</a>
|
|
<a id="#(WAREHOUSE).Quantity" ><strong>WAREHOUSE.Quantity</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Report" ><strong>WAREHOUSE.Report</strong></a>
|
|
|
|
<p>If true, send status messages to coalition.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<a id="#(WAREHOUSE).TransportType" ><strong>WAREHOUSE.TransportType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(WAREHOUSE).airbase" ><strong>WAREHOUSE.airbase</strong></a>
|
|
|
|
<p>Airbase the warehouse belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).airbasename" ><strong>WAREHOUSE.airbasename</strong></a>
|
|
|
|
<p>Name of the airbase associated to the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).alias" ><strong>WAREHOUSE.alias</strong></a>
|
|
|
|
<p>Alias of the warehouse. Name its called when sending messages.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).allowSpawnOnClientSpots" ><strong>WAREHOUSE.allowSpawnOnClientSpots</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autodefence" ><strong>WAREHOUSE.autodefence</strong></a>
|
|
|
|
<p>When the warehouse is under attack, automatically spawn assets to defend the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autosave" ><strong>WAREHOUSE.autosave</strong></a>
|
|
|
|
<p>Automatically save assets to file when mission ends.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavefile" ><strong>WAREHOUSE.autosavefile</strong></a>
|
|
|
|
<p>File name of the auto asset save file. Default is auto generated from warehouse id and name.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavepath" ><strong>WAREHOUSE.autosavepath</strong></a>
|
|
|
|
<p>Path where the asset file is saved on auto save.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).coalition" ><strong>WAREHOUSE.coalition</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Coalition of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).countryid" ><strong>WAREHOUSE.countryid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Country of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).dTstatus" ><strong>WAREHOUSE.dTstatus</strong></a>
|
|
|
|
<p>Time interval in seconds of updating the warehouse status and processing new events. Default 30 seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).defending" ><strong>WAREHOUSE.defending</strong></a>
|
|
|
|
<p>Table holding all defending requests, i.e. self requests that were if the warehouse is under attack. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).delivered" ><strong>WAREHOUSE.delivered</strong></a>
|
|
|
|
<p>Table holding all delivered requests. Table elements are #boolean. If true, all cargo has been delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="OPS.FlightControl.html##(FLIGHTCONTROL)">OPS.FlightControl#FLIGHTCONTROL</a>
|
|
<a id="#(WAREHOUSE).flightcontrol" ><strong>WAREHOUSE.flightcontrol</strong></a>
|
|
|
|
<p>Flight control of this warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).harborzone" ><strong>WAREHOUSE.harborzone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isShip" ><strong>WAREHOUSE.isShip</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a ship unit.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isUnit" ><strong>WAREHOUSE.isUnit</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a unit instead of a static.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).lid" ><strong>WAREHOUSE.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).lowfuelthresh" ><strong>WAREHOUSE.lowfuelthresh</strong></a>
|
|
|
|
<p>Low fuel threshold. Triggers the event AssetLowFuel if for any unit fuel goes below this number.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).markerOn" ><strong>WAREHOUSE.markerOn</strong></a>
|
|
|
|
<p>If true, markers are displayed on the F10 map.</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="#(WAREHOUSE).markerRail" ><strong>WAREHOUSE.markerRail</strong></a>
|
|
|
|
<p>Rail road connection.</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="#(WAREHOUSE).markerRoad" ><strong>WAREHOUSE.markerRoad</strong></a>
|
|
|
|
<p>Road connection.</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="#(WAREHOUSE).markerWarehouse" ><strong>WAREHOUSE.markerWarehouse</strong></a>
|
|
|
|
<p>Marker warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).markerid" ><strong>WAREHOUSE.markerid</strong></a>
|
|
|
|
<p>ID of the warehouse marker at the airbase.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markrail" ><strong>WAREHOUSE.markrail</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markroad" ><strong>WAREHOUSE.markroad</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).offroadpaths" ><strong>WAREHOUSE.offroadpaths</strong></a>
|
|
|
|
<p>Table holding user defined paths from one warehouse to another.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).parkingIDs" ><strong>WAREHOUSE.parkingIDs</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).pending" ><strong>WAREHOUSE.pending</strong></a>
|
|
|
|
<p>Table holding all pending requests, i.e. those that are currently in progress. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).portzone" ><strong>WAREHOUSE.portzone</strong></a>
|
|
|
|
<p>Zone defining the port of a warehouse. This is where naval assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).queue" ><strong>WAREHOUSE.queue</strong></a>
|
|
|
|
<p>Table holding all queued requests. Table entries are of type <a href="##(WAREHOUSE).Queueitem">WAREHOUSE.Queueitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).queueid" ><strong>WAREHOUSE.queueid</strong></a>
|
|
|
|
<p>Unit id of each request in the queue. Essentially a running number starting at one and incremented when a new request is added.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).rail" ><strong>WAREHOUSE.rail</strong></a>
|
|
|
|
<p>Closest point to warehouse on rail.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).respawnafterdestroyed" ><strong>WAREHOUSE.respawnafterdestroyed</strong></a>
|
|
|
|
<p>If true, warehouse is respawned after it was destroyed. Assets are kept.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).respawndelay" ><strong>WAREHOUSE.respawndelay</strong></a>
|
|
|
|
<p>Delay before respawn in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).road" ><strong>WAREHOUSE.road</strong></a>
|
|
|
|
<p>Closest point to warehouse on road.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwaydestroyed" ><strong>WAREHOUSE.runwaydestroyed</strong></a>
|
|
|
|
<p>Time stamp timer.getAbsTime() when the runway was destroyed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwayrepairtime" ><strong>WAREHOUSE.runwayrepairtime</strong></a>
|
|
|
|
<p>Time in seconds until runway will be repaired after it was destroyed. Default is 3600 sec (one hour).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).safeparking" ><strong>WAREHOUSE.safeparking</strong></a>
|
|
|
|
<p>If true, parking spots for aircraft are considered as occupied if e.g. a client aircraft is parked there. Default false.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).shippinglanes" ><strong>WAREHOUSE.shippinglanes</strong></a>
|
|
|
|
<p>Table holding the user defined shipping between warehouses.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).spawnzone" ><strong>WAREHOUSE.spawnzone</strong></a>
|
|
|
|
<p>Zone in which assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).spawnzonemaxdist" ><strong>WAREHOUSE.spawnzonemaxdist</strong></a>
|
|
|
|
<p>Max distance between warehouse and spawn zone. Default 5000 meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).stock" ><strong>WAREHOUSE.stock</strong></a>
|
|
|
|
<p>Table holding all assets in stock. Table entries are of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).transporting" ><strong>WAREHOUSE.transporting</strong></a>
|
|
|
|
<p>Table holding assets currently transporting cargo assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).uid" ><strong>WAREHOUSE.uid</strong></a>
|
|
|
|
<p>Unique ID of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).verbosity" ><strong>WAREHOUSE.verbosity</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).version" ><strong>WAREHOUSE.version</strong></a>
|
|
|
|
<p>Warehouse class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
|
|
<a id="#(WAREHOUSE).warehouse" ><strong>WAREHOUSE.warehouse</strong></a>
|
|
|
|
<p>The phyical warehouse structure.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).wid" ><strong>WAREHOUSE.wid</strong></a>
|
|
|
|
<p>Identifier of the warehouse printed before other output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).zone" ><strong>WAREHOUSE.zone</strong></a>
|
|
|
|
<p>Zone around the warehouse. If this zone is captured, the warehouse and all its assets goes to the capturing coalition.</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="#(WAREHOUSE).AddAsset" ><strong>WAREHOUSE:AddAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger the FSM event "AddAsset".</p>
|
|
|
|
|
|
<p>Add a group to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##AddAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Group to be added as new asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ngroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number of groups to add to the warehouse stock. Default is 1.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<strong><strong>forceattribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force a generalized attribute for the asset. This has to be an <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forcecargobay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each <em>unit</em> of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forceweight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force weight in kg of each unit in the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>loadradius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The distance in meters when the cargo is loaded into the carrier. Default is the bounding box size of the carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(AI.Skill)">DCS#AI.Skill</a>
|
|
<strong><strong>skill</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Skill of the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>liveries</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of livery names. When the asset is spawned one livery is chosen randomly.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A free to choose string specifying an assignment for the asset. This can be used with the <a href="##(WAREHOUSE).OnAfterNewAsset">WAREHOUSE.OnAfterNewAsset</a> 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="#(WAREHOUSE).AddOffRoadPath" ><strong>WAREHOUSE:AddOffRoadPath(remotewarehouse, group, oneway)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add an off-road path from this warehouse to another and back.</p>
|
|
|
|
|
|
<p>The start and end points are automatically set to one random point in the respective spawn zones of the two warehouses.
|
|
By default, the reverse path is also added as path from the remote warehouse to this warehouse.</p>
|
|
|
|
<div id= "#Functions##AddOffRoadPath" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>remotewarehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to which the path leads.</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>Waypoints of this group will define the path between to warehouses.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>oneway</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If true, the path can only be used from this warehouse to the other but not other way around. 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="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AddRequest" ><strong>WAREHOUSE:AddRequest(warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AddRequest".</p>
|
|
|
|
|
|
<p>Add a request to the warehouse queue, which is processed when possible.</p>
|
|
|
|
<div id= "#Functions##AddRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse requesting supply.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<strong><strong>AssetDescriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the asset that is requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>AssetDescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nAsset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups requested that match the asset specification.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<strong><strong>TransportType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of transport.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nTransport</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of transport units requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Prio</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Priority of the request. Number ranging from 1=high to 100=low.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A keyword or text that later be used to identify this request and postprocess the assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AddShippingLane" ><strong>WAREHOUSE:AddShippingLane(remotewarehouse, group, oneway)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a shipping lane from this warehouse to another remote warehouse.</p>
|
|
|
|
|
|
<p>Note that both warehouses must have a port zone defined before a shipping lane can be added!
|
|
Shipping lane is taken from the waypoints of a (late activated) template group. So set up a group, e.g. a ship or a helicopter, and place its
|
|
waypoints along the shipping lane you want to add.</p>
|
|
|
|
<div id= "#Functions##AddShippingLane" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>remotewarehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to where the shipping lane is added</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>Waypoints of this group will define the shipping lane between to warehouses.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>oneway</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If true, the lane can only be used from this warehouse to the other but not other way around. 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="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AirbaseCaptured" ><strong>WAREHOUSE:AirbaseCaptured(Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AirbaseCaptured" when the airbase of the warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##AirbaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><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##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the airbase, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AirbaseRecaptured" ><strong>WAREHOUSE:AirbaseRecaptured(Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AirbaseRecaptured" when the airbase of the warehouse has been re-captured from the other coalition.</p>
|
|
|
|
<div id= "#Functions##AirbaseRecaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><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##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Arrived" ><strong>WAREHOUSE:Arrived(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Arrived" when a group has arrived at the destination warehouse.</p>
|
|
|
|
|
|
<p>This function should always be called from the sending and not the receiving warehouse.
|
|
If the group is a cargo asset, it is added to the receiving warehouse. If the group is a transporter it
|
|
is added to the sending warehouse since carriers are supposed to return to their home warehouse once
|
|
all cargo was delivered.</p>
|
|
|
|
<div id= "#Functions##Arrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group that has arrived.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AssetDead" ><strong>WAREHOUSE:AssetDead(asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AssetDead" when an asset group has died.</p>
|
|
|
|
<div id= "#Functions##AssetDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is dead.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the dead asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AssetLowFuel" ><strong>WAREHOUSE:AssetLowFuel(asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AssetLowFuel" when an asset runs low on fuel</p>
|
|
|
|
<div id= "#Functions##AssetLowFuel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).AssetSpawned" ><strong>WAREHOUSE:AssetSpawned(group, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AssetSpawned" when the warehouse has spawned an asset.</p>
|
|
|
|
<div id= "#Functions##AssetSpawned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the group that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the spawned asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Attacked" ><strong>WAREHOUSE:Attacked(Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Attacked" when a warehouse is under attack by an another coalition.</p>
|
|
|
|
<div id= "#Functions##Attacked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which is attacking the warehouse, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country ID, which is attacking the warehouse, i.e. a number <a href="DCS.html##(country).id">DCS#country.id</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Captured" ><strong>WAREHOUSE:Captured(Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Captured" when a warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##Captured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the warehouse.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country id which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).ChangeCountry" ><strong>WAREHOUSE:ChangeCountry(Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "ChangeCountry" so the warehouse is respawned with the new country.</p>
|
|
|
|
<div id= "#Functions##ChangeCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>New country id of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Defeated" ><strong>WAREHOUSE:Defeated()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Defeated" when an attack from an enemy was defeated.</p>
|
|
|
|
<div id= "#Functions##Defeated" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Delivered" ><strong>WAREHOUSE:Delivered(request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Delivered".</p>
|
|
|
|
|
|
<p>All (cargo) assets of a request have been delivered to the receiving warehouse.</p>
|
|
|
|
<div id= "#Functions##Delivered" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending request that was now delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Destroyed" ><strong>WAREHOUSE:Destroyed()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Destroyed" when the warehouse was destroyed.</p>
|
|
|
|
|
|
<p>Services are stopped.</p>
|
|
|
|
<div id= "#Functions##Destroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).FilterStock" ><strong>WAREHOUSE:FilterStock(descriptor, attribute, nmax, mobile)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Filter stock assets by descriptor and attribute.</p>
|
|
|
|
<div id= "#Functions##FilterStock" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>descriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the filtered assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>attribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the descriptor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nmax</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Maximum number of items that will be returned. Default nmax=nil is all matching items are returned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>mobile</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If true, filter only mobile assets.</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>Filtered assets in stock with the specified descriptor value.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Total number of (requested) assets available.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, enough assets are available.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).FindAssetInDB" ><strong>WAREHOUSE:FindAssetInDB(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Find an asset in the the global warehouse data base.</p>
|
|
|
|
|
|
<p>Parameter is the MOOSE group object.
|
|
Note that the group name must contain they "AID" keyword.</p>
|
|
|
|
<div id= "#Functions##FindAssetInDB" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group from which it is assumed that it has a registered asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset from the data base or nil if it could not be 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="#(WAREHOUSE).FindNearestWarehouse" ><strong>WAREHOUSE:FindNearestWarehouse(MinAssets, Descriptor, DescriptorValue, Coalition, RefCoordinate)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Find nearest warehouse in service, i.e.</p>
|
|
|
|
|
|
<p>warehouses which are not started, stopped or destroyed are not considered.
|
|
Optionally, only warehouses with (specific) assets can be included in the search or warehouses of a certain coalition.</p>
|
|
|
|
<div id= "#Functions##FindNearestWarehouse" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>MinAssets</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Minimum number of assets the warehouse should have. Default 0.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Descriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Descriptor describing the selected assets which should be in stock. See <a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a> for possible values.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Descriptor value selecting the type of assets which should be in stock.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(Coalition.side)">DCS#Coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Coalition side of the warehouse. Default is the same coalition as the present warehouse. Set to false for any coalition.</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>RefCoordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Coordinate to which the closest warehouse is searched. Default is the warehouse calling this function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The the nearest warehouse object. Or nil if no warehouse is found.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The distance to the nearest warehouse in meters. Or nil if no warehouse is 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="#(WAREHOUSE).FindWarehouseInDB" ><strong>WAREHOUSE:FindWarehouseInDB(uid)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Find a warehouse in the global warehouse data base.</p>
|
|
|
|
<div id= "#Functions##FindWarehouseInDB" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>uid</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The unique ID of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse object or nil if no warehouse exists.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAirbase" ><strong>WAREHOUSE:GetAirbase()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get airbase associated to the warehouse.</p>
|
|
|
|
<div id= "#Functions##GetAirbase" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Airbase object or nil if warehouse has no airbase connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAirbaseCategory" ><strong>WAREHOUSE:GetAirbaseCategory()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get category of airbase associated to the warehouse.</p>
|
|
|
|
<div id= "#Functions##GetAirbaseCategory" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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>Category of airbase or -1 if warehouse has (currently) no airbase.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAirbaseName" ><strong>WAREHOUSE:GetAirbaseName()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get name airbase associated to the warehouse.</p>
|
|
|
|
<div id= "#Functions##GetAirbaseName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#string:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>name of the airbase assosicated to the warehouse or "none" if the airbase has not airbase connection currently.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAssetByID" ><strong>WAREHOUSE:GetAssetByID(id)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a warehouse asset from its unique id.</p>
|
|
|
|
<div id= "#Functions##GetAssetByID" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Asset 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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAssetByName" ><strong>WAREHOUSE:GetAssetByName(GroupName)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a warehouse asset from its name.</p>
|
|
|
|
<div id= "#Functions##GetAssetByName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>GroupName</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Spawn group 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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetAssignment" ><strong>WAREHOUSE:GetAssignment(request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get assignment of a request.</p>
|
|
|
|
<div id= "#Functions##GetAssignment" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request from which the assignment is extracted.</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 assignment 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="#(WAREHOUSE).GetCoalition" ><strong>WAREHOUSE:GetCoalition()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get coalition side of warehouse static.</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>WAREHOUSE</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 side, i.e. number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetCoalitionName" ><strong>WAREHOUSE:GetCoalitionName()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get coalition name of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetCoalitionName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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 side, i.e. number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetCoordinate" ><strong>WAREHOUSE:GetCoordinate()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get coordinate of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetCoordinate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The coordinate of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetCountry" ><strong>WAREHOUSE:GetCountry()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get country id of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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>Country id, i.e. number of <a href="DCS.html##(country).id">DCS#country.id</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetCountryName" ><strong>WAREHOUSE:GetCountryName()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get country name of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetCountryName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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>Country id, i.e. number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetNumberOfAssets" ><strong>WAREHOUSE:GetNumberOfAssets(Descriptor, DescriptorValue, OnlyMobile)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get number of assets in warehouse stock.</p>
|
|
|
|
|
|
<p>Optionally, only specific assets can be counted.</p>
|
|
|
|
<div id= "#Functions##GetNumberOfAssets" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Descriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Descriptor return the number of a specifc asset type. See <a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a> for possible values.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>DescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Descriptor value selecting the type of assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>OnlyMobile</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If true only mobile units are considered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of assets in stock.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetRequestByID" ><strong>WAREHOUSE:GetRequestByID(id)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get a warehouse request from its unique id.</p>
|
|
|
|
<div id= "#Functions##GetRequestByID" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Request ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse requested - either queued or pending.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <em>true</em>, request is queued, if <em>false</em>, request is pending, if <em>nil</em>, request could not be 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="#(WAREHOUSE).GetRunwayRepairtime" ><strong>WAREHOUSE:GetRunwayRepairtime()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if runway is operational.</p>
|
|
|
|
<div id= "#Functions##GetRunwayRepairtime" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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>Time in seconds until the runway is repaired. Will return 0 if runway is repaired.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetSpawnZone" ><strong>WAREHOUSE:GetSpawnZone()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the spawn zone.</p>
|
|
|
|
<div id= "#Functions##GetSpawnZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The spawn zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetStockInfo" ><strong>WAREHOUSE:GetStockInfo(stock)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Returns the number of assets for each generalized attribute.</p>
|
|
|
|
<div id= "#Functions##GetStockInfo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>stock</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The stock of the warehouse.</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>Data table holding the numbers, i.e. data[attibute]=n.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetVec2" ><strong>WAREHOUSE:GetVec2()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get 2D vector of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetVec2" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="DCS.html##(Vec2)">DCS#Vec2</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The 2D vector of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetVec3" ><strong>WAREHOUSE:GetVec3()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get 3D vector of warehouse static.</p>
|
|
|
|
<div id= "#Functions##GetVec3" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="DCS.html##(Vec3)">DCS#Vec3</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The 3D vector of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).GetWarehouseZone" ><strong>WAREHOUSE:GetWarehouseZone()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the warehouse zone.</p>
|
|
|
|
<div id= "#Functions##GetWarehouseZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse zone.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).HasConnectionNaval" ><strong>WAREHOUSE:HasConnectionNaval(warehouse, markpath, smokepath)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has a shipping lane defined to another warehouse.</p>
|
|
|
|
<div id= "#Functions##HasConnectionNaval" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to where the connection is checked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>markpath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, place markers of path segments on the F10 map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>smokepath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, put green smoke on path segments.</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, the two warehouses are connected by road.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path length in meters. Negative distance -1 meter indicates no connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).HasConnectionOffRoad" ><strong>WAREHOUSE:HasConnectionOffRoad(warehouse, markpath, smokepath)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has an off road path defined to another warehouse.</p>
|
|
|
|
<div id= "#Functions##HasConnectionOffRoad" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to where the connection is checked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>markpath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, place markers of path segments on the F10 map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>smokepath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, put green smoke on path segments.</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, the two warehouses are connected by road.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path length in meters. Negative distance -1 meter indicates no connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).HasConnectionRail" ><strong>WAREHOUSE:HasConnectionRail(warehouse, markpath, smokepath)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has a railroad connection to another warehouse.</p>
|
|
|
|
|
|
<p>Both warehouses need to be started!</p>
|
|
|
|
<div id= "#Functions##HasConnectionRail" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to where the connection is checked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>markpath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, place markers of path segments on the F10 map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>smokepath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, put green smoke on path segments.</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, the two warehouses are connected by road.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path length in meters. Negative distance -1 meter indicates no connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).HasConnectionRoad" ><strong>WAREHOUSE:HasConnectionRoad(warehouse, markpath, smokepath)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has a road connection to another warehouse.</p>
|
|
|
|
|
|
<p>Both warehouses need to be started!</p>
|
|
|
|
<div id= "#Functions##HasConnectionRoad" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The remote warehouse to where the connection is checked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>markpath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, place markers of path segments on the F10 map.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>smokepath</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, put green smoke on path segments.</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, the two warehouses are connected by road.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path length in meters. Negative distance -1 meter indicates no connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsAttacked" ><strong>WAREHOUSE:IsAttacked()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse is under attack by another coalition.</p>
|
|
|
|
<div id= "#Functions##IsAttacked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse is attacked.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsDestroyed" ><strong>WAREHOUSE:IsDestroyed()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has been destroyed.</p>
|
|
|
|
<div id= "#Functions##IsDestroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse had been destroyed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsLoaded" ><strong>WAREHOUSE:IsLoaded()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has been loaded from disk via the "Load" event.</p>
|
|
|
|
<div id= "#Functions##IsLoaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse was loaded from disk.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsNotReadyYet" ><strong>WAREHOUSE:IsNotReadyYet()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse has not been started yet, i.e.</p>
|
|
|
|
|
|
<p>is in the state "NotReadyYet".</p>
|
|
|
|
<div id= "#Functions##IsNotReadyYet" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse object has been created but the warehouse has not been started yet.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsPaused" ><strong>WAREHOUSE:IsPaused()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse is paused.</p>
|
|
|
|
|
|
<p>In this state, requests are not processed.</p>
|
|
|
|
<div id= "#Functions##IsPaused" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse is paused.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsRunning" ><strong>WAREHOUSE:IsRunning()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse is running.</p>
|
|
|
|
<div id= "#Functions##IsRunning" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse is running and requests are processed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsRunwayOperational" ><strong>WAREHOUSE:IsRunwayOperational()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if runway is operational.</p>
|
|
|
|
<div id= "#Functions##IsRunwayOperational" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, runway is operational.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsShip" ><strong>WAREHOUSE:IsShip()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if warehouse physical representation is a ship.</p>
|
|
|
|
<div id= "#Functions##IsShip" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, warehouse object is a ship.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsStatic" ><strong>WAREHOUSE:IsStatic()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if warehouse physical representation is a static (not a unit) object.</p>
|
|
|
|
<div id= "#Functions##IsStatic" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, warehouse object is a static.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).IsStopped" ><strong>WAREHOUSE:IsStopped()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if the warehouse is stopped.</p>
|
|
|
|
<div id= "#Functions##IsStopped" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, the warehouse is 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="#(WAREHOUSE).IsUnit" ><strong>WAREHOUSE:IsUnit()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if warehouse physical representation is a unit (not a static) object.</p>
|
|
|
|
<div id= "#Functions##IsUnit" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If <code>true</code>, warehouse object is a unit.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Load" ><strong>WAREHOUSE:Load(path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Load" when the warehouse is loaded from a file on disk.</p>
|
|
|
|
<div id= "#Functions##Load" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 the file is located. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).New" ><strong>WAREHOUSE:New(warehouse, alias)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>The WAREHOUSE constructor.</p>
|
|
|
|
|
|
<p>Creates a new WAREHOUSE object from a static object. Parameters like the coalition and country are taken from the static object structure.</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>WAREHOUSE</p>
|
|
</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.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The physical structure representing the warehouse. Can also be a <a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>alias</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Alias of the warehouse, i.e. the name it will be called when sending messages etc. Default is the name of the static/unit representing the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).NewAsset" ><strong>WAREHOUSE:NewAsset(asset, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##NewAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The new asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Assignment text for the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAirbaseCaptured" ><strong>WAREHOUSE:OnAfterAirbaseCaptured(From, Event, To, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AirbaseCaptured" even user function.</p>
|
|
|
|
|
|
<p>Called when the airbase of the warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##OnAfterAirbaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the airbase, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAirbaseRecaptured" ><strong>WAREHOUSE:OnAfterAirbaseRecaptured(From, Event, To, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AirbaseRecaptured" event user function.</p>
|
|
|
|
|
|
<p>Called when the airbase of the warehouse has been re-captured from the other coalition.</p>
|
|
|
|
<div id= "#Functions##OnAfterAirbaseRecaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterArrived" ><strong>WAREHOUSE:OnAfterArrived(From, Event, To, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Arrived" event user function.</p>
|
|
|
|
|
|
<p>Called when a group has arrived at its destination.</p>
|
|
|
|
<div id= "#Functions##OnAfterArrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Group that has arrived.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAssetDead" ><strong>WAREHOUSE:OnAfterAssetDead(From, Event, To, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AssetDead" event user function.</p>
|
|
|
|
|
|
<p>Called when an asset group died.</p>
|
|
|
|
<div id= "#Functions##OnAfterAssetDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is dead.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the dead asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAssetLowFuel" ><strong>WAREHOUSE:OnAfterAssetLowFuel(From, Event, To, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AssetLowFuel" event user function.</p>
|
|
|
|
|
|
<p>Called when the an asset is low on fuel.</p>
|
|
|
|
<div id= "#Functions##OnAfterAssetLowFuel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAssetSpawned" ><strong>WAREHOUSE:OnAfterAssetSpawned(From, Event, To, group, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AssetSpawned" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse has spawned an asset.</p>
|
|
|
|
<div id= "#Functions##OnAfterAssetSpawned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 group that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the spawned asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterAttacked" ><strong>WAREHOUSE:OnAfterAttacked(From, Event, To, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Attacked" event user function.</p>
|
|
|
|
|
|
<p>Called when a warehouse (zone) is under attack by an enemy.</p>
|
|
|
|
<div id= "#Functions##OnAfterAttacked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which is attacking the warehouse, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country ID, which is attacking the warehouse, i.e. a number <a href="DCS.html##(country).id">DCS#country.id</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterCaptured" ><strong>WAREHOUSE:OnAfterCaptured(From, Event, To, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Captured" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse has been captured by an enemy coalition.</p>
|
|
|
|
<div id= "#Functions##OnAfterCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the warehouse, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country id which has captured the warehouse, i.e. a number <a href="DCS.html##(country).id">DCS#country.id</a> enumerator.</p>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterChangeCountry" ><strong>WAREHOUSE:OnAfterChangeCountry(From, Event, To, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "ChangeCountry" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse has changed its country.</p>
|
|
|
|
<div id= "#Functions##OnAfterChangeCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>New country id of the warehouse, i.e. a number <a href="DCS.html##(country).id">DCS#country.id</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterDefeate" ><strong>WAREHOUSE:OnAfterDefeate(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Defeated" event user function.</p>
|
|
|
|
|
|
<p>Called when an enemy attack was defeated.</p>
|
|
|
|
<div id= "#Functions##OnAfterDefeate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).OnAfterDelivered" ><strong>WAREHOUSE:OnAfterDelivered(From, Event, To, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Delivered" event user function.</p>
|
|
|
|
|
|
<p>Called when a group has been delivered from the warehouse to another warehouse.</p>
|
|
|
|
<div id= "#Functions##OnAfterDelivered" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending request that was now delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterDestroyed" ><strong>WAREHOUSE:OnAfterDestroyed(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Destroyed" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse was destroyed. Services are stopped.</p>
|
|
|
|
<div id= "#Functions##OnAfterDestroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).OnAfterLoad" ><strong>WAREHOUSE:OnAfterLoad(From, Event, To, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Load" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse assets are loaded from disk.</p>
|
|
|
|
<div id= "#Functions##OnAfterLoad" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is located. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterNewAsset" ><strong>WAREHOUSE:OnAfterNewAsset(From, Event, To, asset, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "NewAsset" event user function.</p>
|
|
|
|
|
|
<p>A new asset has been added to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##OnAfterNewAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that has just been added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Assignment text for the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterRequest" ><strong>WAREHOUSE:OnAfterRequest(From, Event, To, Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Request" user function.</p>
|
|
|
|
|
|
<p>The necessary cargo and transport assets were spawned.</p>
|
|
|
|
<div id= "#Functions##OnAfterRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterRespawn" ><strong>WAREHOUSE:OnAfterRespawn(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Respawn" event user function.</p>
|
|
|
|
<div id= "#Functions##OnAfterRespawn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).OnAfterSave" ><strong>WAREHOUSE:OnAfterSave(From, Event, To, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Save" event user function.</p>
|
|
|
|
|
|
<p>Called when the warehouse assets are saved to disk.</p>
|
|
|
|
<div id= "#Functions##OnAfterSave" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is saved. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnAfterSelfRequest" ><strong>WAREHOUSE:OnAfterSelfRequest(From, Event, To, groupset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "SelfRequest" event.</p>
|
|
|
|
|
|
<p>Request was initiated from the warehouse to itself. Groups are simply spawned at the warehouse or the associated airbase.
|
|
All requested assets are passed as a <a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> and can be used for further tasks or in other MOOSE classes.
|
|
Note that airborne assets are spawned in uncontrolled state so they do not simply "fly away" after spawning.</p>
|
|
|
|
|
|
<div id= "#Functions##OnAfterSelfRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>groupset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The set of (cargo) groups that was delivered to the warehouse itself.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending self request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Usage:</strong></h2>
|
|
<pre class="example"><code>--- Self request event. Triggered once the assets are spawned in the spawn zone or at the airbase.
|
|
function mywarehouse:OnAfterSelfRequest(From, Event, To, groupset, request)
|
|
local groupset=groupset --Core.Set#SET_GROUP
|
|
|
|
-- Loop over all groups spawned from that request.
|
|
for _,group in pairs(groupset:GetSetObjects()) do
|
|
local group=group --Wrapper.Group#GROUP
|
|
|
|
-- Gree smoke on spawned group.
|
|
group:SmokeGreen()
|
|
|
|
-- Activate uncontrolled airborne group if necessary.
|
|
group:StartUncontrolled()
|
|
end
|
|
end
|
|
</code></pre>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).OnBeforeRequest" ><strong>WAREHOUSE:OnBeforeRequest(From, Event, To, Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Request" user function.</p>
|
|
|
|
|
|
<p>The necessary cargo and transport assets will be spawned. Time to set some additional asset parameters.</p>
|
|
|
|
<div id= "#Functions##OnBeforeRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Pause" ><strong>WAREHOUSE:Pause()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Pause".</p>
|
|
|
|
|
|
<p>Pauses the warehouse. Assets can still be added and requests be made. However, requests are not processed.</p>
|
|
|
|
<div id= "#Functions##Pause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Request" ><strong>WAREHOUSE:Request(Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Request".</p>
|
|
|
|
|
|
<p>Executes a request from the queue if possible.</p>
|
|
|
|
<div id= "#Functions##Request" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Respawn" ><strong>WAREHOUSE:Respawn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Respawn".</p>
|
|
|
|
<div id= "#Functions##Respawn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Restart" ><strong>WAREHOUSE:Restart()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Restart".</p>
|
|
|
|
|
|
<p>Restarts the warehouse from stopped state by reactivating the event handlers <em>only</em>.</p>
|
|
|
|
<div id= "#Functions##Restart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Save" ><strong>WAREHOUSE:Save(path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Save" when the warehouse assets are saved to file on disk.</p>
|
|
|
|
<div id= "#Functions##Save" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 the file is saved. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SelfRequest" ><strong>WAREHOUSE:SelfRequest(groupset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "SelfRequest".</p>
|
|
|
|
|
|
<p>Request was initiated from the warehouse to itself. Groups are just spawned at the warehouse or the associated airbase.
|
|
If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated,
|
|
this request is used to put the groups back into the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##SelfRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>groupset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The set of cargo groups that was delivered to the warehouse itself.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending self request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetAirbase" ><strong>WAREHOUSE:SetAirbase(airbase)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the airbase belonging to this warehouse.</p>
|
|
|
|
|
|
<p>Note that it has to be of the same coalition as the warehouse.
|
|
Also, be reasonable and do not put it too far from the phyiscal warehouse structure because you troops might have a long way to get to their transports.</p>
|
|
|
|
<div id= "#Functions##SetAirbase" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<strong><strong>airbase</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The airbase object associated to this warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetAllowSpawnOnClientParking" ><strong>WAREHOUSE:SetAllowSpawnOnClientParking()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set wether client parking spots can be used for spawning.</p>
|
|
|
|
<div id= "#Functions##SetAllowSpawnOnClientParking" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetAutoDefenceOff" ><strong>WAREHOUSE:SetAutoDefenceOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set auto defence off.</p>
|
|
|
|
|
|
<p>This is the default.</p>
|
|
|
|
<div id= "#Functions##SetAutoDefenceOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetAutoDefenceOn" ><strong>WAREHOUSE:SetAutoDefenceOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set auto defence on.</p>
|
|
|
|
|
|
<p>When the warehouse is under attack, all ground assets are spawned automatically and will defend the warehouse zone.</p>
|
|
|
|
<div id= "#Functions##SetAutoDefenceOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetDebugOff" ><strong>WAREHOUSE:SetDebugOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set debug mode off.</p>
|
|
|
|
|
|
<p>This is the default</p>
|
|
|
|
<div id= "#Functions##SetDebugOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetDebugOn" ><strong>WAREHOUSE:SetDebugOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set debug mode on.</p>
|
|
|
|
|
|
<p>Error messages will be displayed on screen, units will be smoked at some events.</p>
|
|
|
|
<div id= "#Functions##SetDebugOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetHarborZone" ><strong>WAREHOUSE:SetHarborZone(zone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Add a Harbor Zone for this warehouse where naval cargo units will spawn and be received.</p>
|
|
|
|
|
|
<p>Both warehouses must have the harbor zone defined for units to properly spawn on both the
|
|
sending and receiving side. The harbor zone should be within 3km of the port zone used for
|
|
warehouse in order to facilitate the boarding process.</p>
|
|
|
|
<div id= "#Functions##SetHarborZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The zone defining the naval embarcation/debarcation point for cargo units</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetLowFuelThreshold" ><strong>WAREHOUSE:SetLowFuelThreshold(threshold)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set low fuel threshold.</p>
|
|
|
|
|
|
<p>If one unit of an asset has less fuel than this number, the event AssetLowFuel will be fired.</p>
|
|
|
|
<div id= "#Functions##SetLowFuelThreshold" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>threshold</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Relative low fuel threshold, i.e. a number in [0,1]. Default 0.15 (15%).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetMarker" ><strong>WAREHOUSE:SetMarker(switch)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Show or don't show markers on the F10 map displaying the Warehouse stock and road/rail connections.</p>
|
|
|
|
<div id= "#Functions##SetMarker" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 (or nil), markers are on. If false, markers are not displayed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetParkingIDs" ><strong>WAREHOUSE:SetParkingIDs(ParkingIDs)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set valid parking spot IDs.</p>
|
|
|
|
<div id= "#Functions##SetParkingIDs" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>ParkingIDs</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of numbers.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetPortZone" ><strong>WAREHOUSE:SetPortZone(zone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the port zone for this warehouse.</p>
|
|
|
|
|
|
<p>The port zone is the zone, where all naval assets of the warehouse are spawned.</p>
|
|
|
|
<div id= "#Functions##SetPortZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The zone defining the naval port of the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetRailConnection" ><strong>WAREHOUSE:SetRailConnection(coordinate)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the connection of the warehouse to the railroad.</p>
|
|
|
|
|
|
<p>This is the place where train assets or transports will be spawned.</p>
|
|
|
|
<div id= "#Functions##SetRailConnection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The railroad connection. Technically, the closest point on rails from this coordinate is determined by DCS API function. So this point must not be exactly on the a railroad connection.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetReportOff" ><strong>WAREHOUSE:SetReportOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set report off.</p>
|
|
|
|
|
|
<p>Warehouse does not report about its status and at certain events.</p>
|
|
|
|
<div id= "#Functions##SetReportOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetReportOn" ><strong>WAREHOUSE:SetReportOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set report on.</p>
|
|
|
|
|
|
<p>Messages at events will be displayed on screen to the coalition owning the warehouse.</p>
|
|
|
|
<div id= "#Functions##SetReportOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetRespawnAfterDestroyed" ><strong>WAREHOUSE:SetRespawnAfterDestroyed(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set respawn after destroy.</p>
|
|
|
|
<div id= "#Functions##SetRespawnAfterDestroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>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="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetRoadConnection" ><strong>WAREHOUSE:SetRoadConnection(coordinate)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the connection of the warehouse to the road.</p>
|
|
|
|
|
|
<p>Ground assets spawned in the warehouse spawn zone will first go to this point and from there travel on road to the requesting warehouse.
|
|
Note that by default the road connection is set to the closest point on road from the center of the spawn zone if it is withing 3000 meters.
|
|
Also note, that if the parameter "coordinate" is passed as nil, any road connection is disabled and ground assets cannot travel of be transportet on the ground.</p>
|
|
|
|
<div id= "#Functions##SetRoadConnection" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The road connection. Technically, the closest point on road from this coordinate is determined by DCS API function. So this point must not be exactly on the road.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetRunwayRepairtime" ><strong>WAREHOUSE:SetRunwayRepairtime(RepairTime)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set the time until the runway(s) of an airdrome are repaired after it has been destroyed.</p>
|
|
|
|
|
|
<p>Note that this is the time, the DCS engine uses not something we can control on a user level or we could get via scripting.
|
|
You need to input the value. On the DCS forum it was stated that this is currently one hour. Hence this is the default value.</p>
|
|
|
|
<div id= "#Functions##SetRunwayRepairtime" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>RepairTime</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Time in seconds until the runway is repaired. Default 3600 sec (one hour).</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetSafeParkingOff" ><strong>WAREHOUSE:SetSafeParkingOff()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Disable safe parking option.</p>
|
|
|
|
|
|
<p>Note that is the default setting.</p>
|
|
|
|
<div id= "#Functions##SetSafeParkingOff" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetSafeParkingOn" ><strong>WAREHOUSE:SetSafeParkingOn()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Enable safe parking option, i.e.</p>
|
|
|
|
|
|
<p>parking spots at an airbase will be considered as occupied when a client aircraft is parked there (even if the client slot is not taken by a player yet).
|
|
Note that also incoming aircraft can reserve/occupie parking spaces.</p>
|
|
|
|
<div id= "#Functions##SetSafeParkingOn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetSaveOnMissionEnd" ><strong>WAREHOUSE:SetSaveOnMissionEnd(path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Enable auto save of warehouse assets at mission end event.</p>
|
|
|
|
<div id= "#Functions##SetSaveOnMissionEnd" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 asset data file.</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. Default is generated automatically from warehouse 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="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetSpawnZone" ><strong>WAREHOUSE:SetSpawnZone(zone, maxdist)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a zone where the (ground) assets of the warehouse are spawned once requested.</p>
|
|
|
|
<div id= "#Functions##SetSpawnZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The spawn 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>maxdist</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Maximum distance in meters between spawn zone and warehouse. Units are not spawned if distance is larger. Default is 5000 m.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetStatusUpdate" ><strong>WAREHOUSE:SetStatusUpdate(timeinterval)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set interval of status updates.</p>
|
|
|
|
|
|
<p>Note that normally only one request can be processed per time interval.</p>
|
|
|
|
<div id= "#Functions##SetStatusUpdate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>timeinterval</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Time interval in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetVerbosityLevel" ><strong>WAREHOUSE:SetVerbosityLevel(VerbosityLevel)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set verbosity level.</p>
|
|
|
|
<div id= "#Functions##SetVerbosityLevel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>VerbosityLevel</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Level of output (higher=more). Default 0.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).SetWarehouseZone" ><strong>WAREHOUSE:SetWarehouseZone(zone)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Set a warehouse zone.</p>
|
|
|
|
|
|
<p>If this zone is captured, the warehouse and all its assets fall into the hands of the enemy.</p>
|
|
|
|
<div id= "#Functions##SetWarehouseZone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>zone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse zone. Note that this <strong>cannot</strong> be a polygon 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="##(WAREHOUSE)">#WAREHOUSE</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>self</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Start" ><strong>WAREHOUSE:Start()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Start".</p>
|
|
|
|
|
|
<p>Starts the warehouse. Initializes parameters and starts event handlers.</p>
|
|
|
|
<div id= "#Functions##Start" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Status" ><strong>WAREHOUSE:Status()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Status".</p>
|
|
|
|
|
|
<p>Queue is updated and requests are executed.</p>
|
|
|
|
<div id= "#Functions##Status" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).Stop" ><strong>WAREHOUSE:Stop()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Stop".</p>
|
|
|
|
|
|
<p>Stops the warehouse and all its event handlers. All waiting and pending queue items are deleted as well and all assets are removed from stock.</p>
|
|
|
|
<div id= "#Functions##Stop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).UnPause" ><strong>WAREHOUSE:UnPause()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Unpause".</p>
|
|
|
|
|
|
<p>Unpauses the warehouse. Processing of queued requests is resumed.</p>
|
|
|
|
<div id= "#Functions##UnPause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._Arrived" ><strong>WAREHOUSE:_Arrived(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Task function for last waypoint.</p>
|
|
|
|
|
|
<p>Triggering the "Arrived" event.</p>
|
|
|
|
<div id= "#Functions##_Arrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group that arrived.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._AssetItemInfo" ><strong>WAREHOUSE:_AssetItemInfo(asset)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Asset item characteristics.</p>
|
|
|
|
<div id= "#Functions##_AssetItemInfo" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset for which info in printed in trace mode.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckAirbaseOwner" ><strong>WAREHOUSE:_CheckAirbaseOwner()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Checks if the associated airbase still belongs to the warehouse.</p>
|
|
|
|
<div id= "#Functions##_CheckAirbaseOwner" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckAssetStatus" ><strong>WAREHOUSE:_CheckAssetStatus()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function that checks if an asset group is still okay.</p>
|
|
|
|
<div id= "#Functions##_CheckAssetStatus" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckConquered" ><strong>WAREHOUSE:_CheckConquered()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Checks if the warehouse zone was conquered by antoher coalition.</p>
|
|
|
|
<div id= "#Functions##_CheckConquered" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckFuel" ><strong>WAREHOUSE:_CheckFuel()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Checks fuel on all pening assets.</p>
|
|
|
|
<div id= "#Functions##_CheckFuel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckParkingAsset" ><strong>WAREHOUSE:_CheckParkingAsset(spot, asset)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check parking ID for an asset.</p>
|
|
|
|
<div id= "#Functions##_CheckParkingAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE.ParkingSpot)">Wrapper.Airbase#AIRBASE.ParkingSpot</a>
|
|
<strong><strong>spot</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parking spot.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>asset</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, parking is valid.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckParkingValid" ><strong>WAREHOUSE:_CheckParkingValid(spot)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check parking ID.</p>
|
|
|
|
<div id= "#Functions##_CheckParkingValid" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE.ParkingSpot)">Wrapper.Airbase#AIRBASE.ParkingSpot</a>
|
|
<strong><strong>spot</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parking spot.</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, parking is valid.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckQueue" ><strong>WAREHOUSE:_CheckQueue()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sorts the queue and checks if the request can be fulfilled.</p>
|
|
|
|
<div id= "#Functions##_CheckQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Chosen request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckRequestConsistancy" ><strong>WAREHOUSE:_CheckRequestConsistancy(queue)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Checks if the request can be fulfilled in general.</p>
|
|
|
|
|
|
<p>If not, it is removed from the queue.
|
|
Check if departure and destination bases are of the right type.</p>
|
|
|
|
<div id= "#Functions##_CheckRequestConsistancy" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>queue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The queue which is holding the requests to check.</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, request can be executed. If false, something is not right.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckRequestNow" ><strong>WAREHOUSE:_CheckRequestNow(request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Checks if the request can be fulfilled right now.</p>
|
|
|
|
|
|
<p>Check for current parking situation, number of assets and transports currently in stock.</p>
|
|
|
|
<div id= "#Functions##_CheckRequestNow" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request to be checked.</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, request can be executed. If false, something is not right.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._CheckRequestValid" ><strong>WAREHOUSE:_CheckRequestValid(request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if a request is valid in general.</p>
|
|
|
|
|
|
<p>If not, it will be removed from the queue.
|
|
This routine needs to have at least one asset in stock that matches the request descriptor in order to determine whether the request category of troops.
|
|
If no asset is in stock, the request will remain in the queue but cannot be executed.</p>
|
|
|
|
<div id= "#Functions##_CheckRequestValid" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request to be checked.</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, request can be executed. If false, something is not right.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._DebugMessage" ><strong>WAREHOUSE:_DebugMessage(text, duration)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Debug message.</p>
|
|
|
|
|
|
<p>Message send to all if debug mode is activated (and duration > 0). Text self:T(text) added to DCS.log file.</p>
|
|
|
|
<div id= "#Functions##_DebugMessage" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 of the error message.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>duration</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._DeleteQueueItem" ><strong>WAREHOUSE:_DeleteQueueItem(qitem, queue)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delete item from queue.</p>
|
|
|
|
<div id= "#Functions##_DeleteQueueItem" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>qitem</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Item of queue to be removed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>queue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The queue from which the item should be deleted.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._DeleteQueueItemByID" ><strong>WAREHOUSE:_DeleteQueueItemByID(qitemID, queue)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delete item from queue.</p>
|
|
|
|
<div id= "#Functions##_DeleteQueueItemByID" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>qitemID</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>ID of queue item to be removed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>queue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The queue from which the item should be deleted.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._DeleteStockItem" ><strong>WAREHOUSE:_DeleteStockItem(stockitem)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Delete an asset item from stock.</p>
|
|
|
|
<div id= "#Functions##_DeleteStockItem" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>stockitem</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Asset item to delete from stock 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="#(WAREHOUSE)._DisplayStatus" ><strong>WAREHOUSE:_DisplayStatus()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Display status of warehouse.</p>
|
|
|
|
<div id= "#Functions##_DisplayStatus" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._DisplayStockItems" ><strong>WAREHOUSE:_DisplayStockItems(stock)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Display stock items of warehouse.</p>
|
|
|
|
<div id= "#Functions##_DisplayStockItems" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>stock</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table holding all assets in stock of the warehouse. Each entry is of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._ErrorMessage" ><strong>WAREHOUSE:_ErrorMessage(text, duration)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Error message.</p>
|
|
|
|
|
|
<p>Message send to all (if duration > 0). Text self:E(text) added to DCS.log file.</p>
|
|
|
|
<div id= "#Functions##_ErrorMessage" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 of the error message.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>duration</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._FilterStock" ><strong>WAREHOUSE:_FilterStock(stock, descriptor, attribute, nmax, mobile)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Filter stock assets by table entry.</p>
|
|
|
|
<div id= "#Functions##_FilterStock" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>stock</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table holding all assets in stock of the warehouse. Each entry is of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>descriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the filtered assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>attribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the descriptor.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nmax</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Maximum number of items that will be returned. Default nmax=nil is all matching items are returned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>mobile</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) If true, filter only mobile assets.</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>Filtered stock items table.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Total number of (requested) assets available.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, enough assets are available.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._FindParkingForAssets" ><strong>WAREHOUSE:_FindParkingForAssets(airbase, assets)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Seach unoccupied parking spots at the airbase for a list of assets.</p>
|
|
|
|
|
|
<p>For each asset group a list of parking spots is returned.
|
|
During the search also the not yet spawned asset aircraft are considered.
|
|
If not enough spots for all asset units could be found, the routine returns nil!</p>
|
|
|
|
<div id= "#Functions##_FindParkingForAssets" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<strong><strong>airbase</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The airbase where we search for parking spots.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>assets</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A table of assets for which the parking spots are needed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of coordinates and terminal IDs of free parking spots. Each table entry has the elements .Coordinate and .TerminalID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._Fireworks" ><strong>WAREHOUSE:_Fireworks(coord)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Fireworks!</p>
|
|
|
|
<div id= "#Functions##_Fireworks" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>coord</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="#(WAREHOUSE)._GetAttribute" ><strong>WAREHOUSE:_GetAttribute(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the generalized attribute of a group.</p>
|
|
|
|
|
|
<p>Note that for a heterogenious group, the attribute is determined from the attribute of the first unit!</p>
|
|
|
|
<div id= "#Functions##_GetAttribute" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>MOOSE group 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="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Generalized attribute of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetFlightplan" ><strong>WAREHOUSE:_GetFlightplan(asset, departure, destination)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Make a flight plan from a departure to a destination airport.</p>
|
|
|
|
<div id= "#Functions##_GetFlightplan" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</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.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<strong><strong>departure</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Departure airbase.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<strong><strong>destination</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Destination airbase.</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>Table of flightplan waypoints.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of flightplan coordinates.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetIDsFromGroup" ><strong>WAREHOUSE:_GetIDsFromGroup(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get warehouse id, asset id and request id from group name (alias).</p>
|
|
|
|
<div id= "#Functions##_GetIDsFromGroup" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group from which the info is gathered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Warehouse ID.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Asset ID.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetIDsFromGroupName" ><strong>WAREHOUSE:_GetIDsFromGroupName(groupname)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get warehouse id, asset id and request id from group name (alias).</p>
|
|
|
|
<div id= "#Functions##_GetIDsFromGroupName" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>groupname</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Name of the group from which the info is gathered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Warehouse ID.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Asset ID.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request ID.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetMaxHeight" ><strong>WAREHOUSE:_GetMaxHeight(D, alphaC, alphaD, Hdep, Hdest, Deltahhold)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Calculate the maximum height an aircraft can reach for the given parameters.</p>
|
|
|
|
<div id= "#Functions##_GetMaxHeight" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>D</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Total distance in meters from Departure to holding point at destination.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>alphaC</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Climb angle in rad.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>alphaD</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descent angle in rad.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Hdep</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>AGL altitude of departure point.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Hdest</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>AGL altitude of destination point.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Deltahhold</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Relative altitude of holding point above destination.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Maximum height the aircraft can reach.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetNameWithOut" ><strong>WAREHOUSE:_GetNameWithOut(group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get group name without any spawn or cargo suffix #CARGO etc.</p>
|
|
|
|
<div id= "#Functions##_GetNameWithOut" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group from which the info is gathered.</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>Name of the object without trailing #...</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetObjectSize" ><strong>WAREHOUSE:_GetObjectSize(DCSobject)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Size of the bounding box of a DCS object derived from the DCS descriptor table.</p>
|
|
|
|
|
|
<p>If boundinb box is nil, a size of zero is returned.</p>
|
|
|
|
<div id= "#Functions##_GetObjectSize" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><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##(Object)">DCS#Object</a>
|
|
<strong><strong>DCSobject</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The DCS object for which the size is needed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return values:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Max size of object in meters (length (x) or width (z) components not including height (y)).</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Length (x component) of size.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Height (y component) of size.</p>
|
|
|
|
</div>
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Width (z component) of size.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetRequestOfGroup" ><strong>WAREHOUSE:_GetRequestOfGroup(group, queue)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get the request belonging to a group.</p>
|
|
|
|
<div id= "#Functions##_GetRequestOfGroup" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 from which the info is gathered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>queue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Queue holding all requests.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request belonging to this group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetStockAssetsText" ><strong>WAREHOUSE:_GetStockAssetsText(messagetoall)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get text about warehouse stock.</p>
|
|
|
|
<div id= "#Functions##_GetStockAssetsText" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>messagetoall</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, send message to all.</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 about warehouse stock</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetTerminal" ><strong>WAREHOUSE:_GetTerminal(_attribute, _category)</strong></a></h2>
|
|
</div>
|
|
|
|
<p> Get the proper terminal type based on generalized attribute of the group.</p>
|
|
|
|
<div id= "#Functions##_GetTerminal" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<strong><strong>_attribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Generlized attibute of unit.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>_category</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Airbase category.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Wrapper.Airbase.html##(AIRBASE.TerminalType)">Wrapper.Airbase#AIRBASE.TerminalType</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Terminal type for this group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._GetTransportsForAssets" ><strong>WAREHOUSE:_GetTransportsForAssets(Chosen, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Get (optimized) transport carriers for the given assets to be transported.</p>
|
|
|
|
<div id= "#Functions##_GetTransportsForAssets" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>Chosen</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>request</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="#(WAREHOUSE)._GroupIsTransport" ><strong>WAREHOUSE:_GroupIsTransport(group, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Is the group a used as transporter for a given request?</p>
|
|
|
|
<div id= "#Functions##_GroupIsTransport" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 from which the info is gathered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>True if group is transport, false if group is cargo and nil otherwise.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._HasAttribute" ><strong>WAREHOUSE:_HasAttribute(group, attribute)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if a group has a generalized attribute.</p>
|
|
|
|
<div id= "#Functions##_HasAttribute" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>MOOSE 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="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<strong><strong>attribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Attribute to check.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>True if group has the specified attribute.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._InfoMessage" ><strong>WAREHOUSE:_InfoMessage(text, duration)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Info Message.</p>
|
|
|
|
|
|
<p>Message send to coalition if reports or debug mode activated (and duration > 0). Text self:I(text) added to DCS.log file.</p>
|
|
|
|
<div id= "#Functions##_InfoMessage" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 of the error message.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>duration</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Message display duration in seconds. Default 20 sec. If duration is zero, no message is displayed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._JobDone" ><strong>WAREHOUSE:_JobDone()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function that checks if a pending job is done and can be removed from queue.</p>
|
|
|
|
<div id= "#Functions##_JobDone" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._NewLane" ><strong>WAREHOUSE:_NewLane(group, startcoord, finalcoord)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create a new path from a template group.</p>
|
|
|
|
<div id= "#Functions##_NewLane" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Group used for extracting the waypoints.</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>startcoord</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>First coordinate.</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>finalcoord</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Final 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>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table with route points.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventArrived" ><strong>WAREHOUSE:_OnEventArrived(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Arrived event if an air unit/group arrived at its destination.</p>
|
|
|
|
|
|
<p>This can be an engine shutdown or a landing event.</p>
|
|
|
|
<div id= "#Functions##_OnEventArrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data 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="#(WAREHOUSE)._OnEventBaseCaptured" ><strong>WAREHOUSE:_OnEventBaseCaptured(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Warehouse event handling function.</p>
|
|
|
|
|
|
<p>Handles the case when the airbase associated with the warehous is captured.</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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventBirth" ><strong>WAREHOUSE:_OnEventBirth(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Warehouse event function, handling the birth of a unit.</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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventCrashOrDead" ><strong>WAREHOUSE:_OnEventCrashOrDead(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Warehouse event handling function.</p>
|
|
|
|
<div id= "#Functions##_OnEventCrashOrDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventEngineShutdown" ><strong>WAREHOUSE:_OnEventEngineShutdown(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function handling the event when a (warehouse) unit shuts down 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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventEngineStartup" ><strong>WAREHOUSE:_OnEventEngineStartup(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function handling the event when a (warehouse) unit starts 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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventLanding" ><strong>WAREHOUSE:_OnEventLanding(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function handling the event when a (warehouse) unit lands.</p>
|
|
|
|
<div id= "#Functions##_OnEventLanding" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventMissionEnd" ><strong>WAREHOUSE:_OnEventMissionEnd(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Warehouse event handling function.</p>
|
|
|
|
|
|
<p>Handles the case when the mission is ended.</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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._OnEventTakeOff" ><strong>WAREHOUSE:_OnEventTakeOff(EventData)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Function handling the event when a (warehouse) unit takes off.</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>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a>
|
|
<strong><strong>EventData</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Event data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._PassingWaypoint" ><strong>WAREHOUSE:_PassingWaypoint(group, n, N)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Task function for when passing a waypoint.</p>
|
|
|
|
<div id= "#Functions##_PassingWaypoint" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group that arrived.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>n</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Waypoint passed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>N</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Final waypoint.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._PrintQueue" ><strong>WAREHOUSE:_PrintQueue(queue, name)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Prints the queue to DCS.log file.</p>
|
|
|
|
<div id= "#Functions##_PrintQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>queue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Queue to print.</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 queue for info reasons.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._QuantityRel2Abs" ><strong>WAREHOUSE:_QuantityRel2Abs(relative, ntot)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Relative to absolute quantity.</p>
|
|
|
|
<div id= "#Functions##_QuantityRel2Abs" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>relative</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Relative number in terms of <a href="##(WAREHOUSE).Quantity">WAREHOUSE.Quantity</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ntot</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Total number.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#number:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Absolute number.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._RegisterAsset" ><strong>WAREHOUSE:_RegisterAsset(group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, liveries, skill, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Register new asset in globase warehouse data base.</p>
|
|
|
|
<div id= "#Functions##_RegisterAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The group that will be added to the warehouse stock.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ngroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups to be added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>forceattribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Forced generalized attribute.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forcecargobay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Cargo bay weight limit in kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forceweight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Weight of units in kg.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>loadradius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Radius in meters when cargo is loaded into the carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>liveries</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of liveries.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(AI.Skill)">DCS#AI.Skill</a>
|
|
<strong><strong>skill</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Skill of AI.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Assignment attached to the asset item.</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>A table containing all registered assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._RouteAir" ><strong>WAREHOUSE:_RouteAir(aircraft)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Route the airplane from one airbase another.</p>
|
|
|
|
|
|
<p>Activates uncontrolled aircraft and sets ROE/ROT for ferry flights.
|
|
ROE is set to return fire and ROT to passive defence.</p>
|
|
|
|
<div id= "#Functions##_RouteAir" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><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>aircraft</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Airplane group to be routed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._RouteGround" ><strong>WAREHOUSE:_RouteGround(group, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Route ground units to destination.</p>
|
|
|
|
|
|
<p>ROE is set to return fire and alarm state to green.</p>
|
|
|
|
<div id= "#Functions##_RouteGround" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 ground group to be routed</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request for this group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._RouteNaval" ><strong>WAREHOUSE:_RouteNaval(group, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Route naval units along user defined shipping lanes to destination warehouse.</p>
|
|
|
|
|
|
<p>ROE is set to return fire.</p>
|
|
|
|
<div id= "#Functions##_RouteNaval" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 naval group to be routed</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request for this group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._RouteTrain" ><strong>WAREHOUSE:_RouteTrain(Group, Coordinate, Speed)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Route trains to their destination - or at least to the closest point on rail of the desired final destination.</p>
|
|
|
|
<div id= "#Functions##_RouteTrain" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 train group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<strong><strong>Coordinate</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>of the destination. Tail will be routed to the closest point</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Speed</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Speed in km/h to drive to the destination coordinate. Default is 60% of max possible speed the unit can go.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SimpleTaskFunction" ><strong>WAREHOUSE:_SimpleTaskFunction(Function, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Simple task function.</p>
|
|
|
|
|
|
<p>Can be used to call a function which has the warehouse and the executing group as parameters.</p>
|
|
|
|
<div id= "#Functions##_SimpleTaskFunction" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Function</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The name of the function to call passed as string.</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 group which is meant.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SimpleTaskFunctionWP" ><strong>WAREHOUSE:_SimpleTaskFunctionWP(Function, group, n, N)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Simple task function.</p>
|
|
|
|
|
|
<p>Can be used to call a function which has the warehouse and the executing group as parameters.</p>
|
|
|
|
<div id= "#Functions##_SimpleTaskFunctionWP" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Function</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The name of the function to call passed as string.</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 group which is meant.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>n</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Waypoint passed.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>N</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Final waypoint number.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SortQueue" ><strong>WAREHOUSE:_SortQueue()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Sort requests queue wrt prio and request uid.</p>
|
|
|
|
<div id= "#Functions##_SortQueue" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SpawnAssetAircraft" ><strong>WAREHOUSE:_SpawnAssetAircraft(alias, asset, request, parking, uncontrolled, lateactivated)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Spawn an aircraft asset (plane or helo) at the airbase associated with the warehouse.</p>
|
|
|
|
<div id= "#Functions##_SpawnAssetAircraft" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>alias</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Alias name of the asset group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ground asset that will be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request belonging to this asset. Needed for the name/alias.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>parking</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Parking data for this asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>uncontrolled</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Spawn aircraft in uncontrolled 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>lateactivated</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, groups are spawned late activated.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The spawned group or nil if the group could not be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SpawnAssetGroundNaval" ><strong>WAREHOUSE:_SpawnAssetGroundNaval(alias, asset, request, spawnzone, lateactivated)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Spawn a ground or naval asset in the corresponding spawn zone of the warehouse.</p>
|
|
|
|
<div id= "#Functions##_SpawnAssetGroundNaval" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>alias</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Alias name of the asset group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ground asset that will be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request belonging to this asset. Needed for the name/alias.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<strong><strong>spawnzone</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Zone where the assets should be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#boolean
|
|
<strong><strong>lateactivated</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, groups are spawned late activated.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p><a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The spawned group or nil if the group could not be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SpawnAssetPrepareTemplate" ><strong>WAREHOUSE:_SpawnAssetPrepareTemplate(asset, alias)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Prepare a spawn template for the asset.</p>
|
|
|
|
|
|
<p>Deep copy of asset template, adjusting template and unit names, nillifying group and unit ids.</p>
|
|
|
|
<div id= "#Functions##_SpawnAssetPrepareTemplate" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Ground asset that will be spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>alias</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Alias name of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#table:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Prepared new spawn template.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._SpawnAssetRequest" ><strong>WAREHOUSE:_SpawnAssetRequest(Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Spawns requested assets at warehouse or associated airbase.</p>
|
|
|
|
<div id= "#Functions##_SpawnAssetRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._UnitDead" ><strong>WAREHOUSE:_UnitDead(deadunit, deadgroup, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>A unit of a group just died.</p>
|
|
|
|
|
|
<p>Update group sets in request.
|
|
This is important in order to determine if a job is done and can be removed from the (pending) queue.</p>
|
|
|
|
<div id= "#Functions##_UnitDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a>
|
|
<strong><strong>deadunit</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Unit that died.</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>deadgroup</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group of unit that died.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Request that needs to be updated.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE)._UpdateWarehouseMarkText" ><strong>WAREHOUSE:_UpdateWarehouseMarkText()</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Create or update mark text at warehouse, which is displayed in F10 map showing how many assets of each type are in stock.</p>
|
|
|
|
|
|
<p>Only the coalition of the warehouse owner is able to see it.</p>
|
|
|
|
<div id= "#Functions##_UpdateWarehouseMarkText" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</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 about warehouse stock</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AddAsset" ><strong>WAREHOUSE:__AddAsset(delay, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Trigger the FSM event "AddAsset" with a delay.</p>
|
|
|
|
|
|
<p>Add a group to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##__AddAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group to be added as new asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ngroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Number of groups to add to the warehouse stock. Default is 1.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<strong><strong>forceattribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force a generalized attribute for the asset. This has to be an <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forcecargobay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each <em>unit</em> of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forceweight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force weight in kg of each unit in the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>loadradius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) The distance in meters when the cargo is loaded into the carrier. Default is the bounding box size of the carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(AI.Skill)">DCS#AI.Skill</a>
|
|
<strong><strong>skill</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Skill of the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>liveries</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of livery names. When the asset is spawned one livery is chosen randomly.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A free to choose string specifying an assignment for the asset. This can be used with the <a href="##(WAREHOUSE).OnAfterNewAsset">WAREHOUSE.OnAfterNewAsset</a> 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="#(WAREHOUSE).__AddRequest" ><strong>WAREHOUSE:__AddRequest(delay, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AddRequest" with a delay.</p>
|
|
|
|
|
|
<p>Add a request to the warehouse queue, which is processed when possible.</p>
|
|
|
|
<div id= "#Functions##__AddRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse requesting supply.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<strong><strong>AssetDescriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the asset that is requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>AssetDescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nAsset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups requested that match the asset specification.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<strong><strong>TransportType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of transport.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nTransport</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of transport units requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Prio</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Priority of the request. Number ranging from 1=high to 100=low.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A keyword or text that later be used to identify this request and postprocess the assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AirbaseCaptured" ><strong>WAREHOUSE:__AirbaseCaptured(delay, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AirbaseCaptured" with a delay when the airbase of the warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##__AirbaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the airbase, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AirbaseRecaptured" ><strong>WAREHOUSE:__AirbaseRecaptured(delay, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AirbaseRecaptured" with a delay when the airbase of the warehouse has been re-captured from the other coalition.</p>
|
|
|
|
<div id= "#Functions##__AirbaseRecaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition which re-captured the airbase, i.e. the same as the current warehouse owner coalition.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Arrived" ><strong>WAREHOUSE:__Arrived(delay, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Arrived" after a delay when a group has arrived at the destination.</p>
|
|
|
|
|
|
<p>This function should always be called from the sending and not the receiving warehouse.
|
|
If the group is a cargo asset, it is added to the receiving warehouse. If the group is a transporter it
|
|
is added to the sending warehouse since carriers are supposed to return to their home warehouse once</p>
|
|
|
|
<div id= "#Functions##__Arrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Group that has arrived.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AssetDead" ><strong>WAREHOUSE:__AssetDead(delay, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the delayed FSM event "AssetDead" when an asset group has died.</p>
|
|
|
|
<div id= "#Functions##__AssetDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is dead.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the dead asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AssetLowFuel" ><strong>WAREHOUSE:__AssetLowFuel(delay, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AssetLowFuel" with a delay when an asset runs low on fuel.</p>
|
|
|
|
<div id= "#Functions##__AssetLowFuel" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the asset that is low on fuel.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__AssetSpawned" ><strong>WAREHOUSE:__AssetSpawned(delay, group, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "AssetSpawned" with a delay when the warehouse has spawned an asset.</p>
|
|
|
|
<div id= "#Functions##__AssetSpawned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Wrapper.Group.html##(GROUP)">Wrapper.Group#GROUP</a>
|
|
<strong><strong>group</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>the group that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that was spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the spawned asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Attacked" ><strong>WAREHOUSE:__Attacked(delay, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Attacked" with a delay when a warehouse is under attack by an another coalition.</p>
|
|
|
|
<div id= "#Functions##__Attacked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which is attacking the warehouse, i.e. a number of <a href="DCS.html##(coalition).side">DCS#coalition.side</a> enumerator.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country ID, which is attacking the warehouse, i.e. a number <a href="DCS.html##(country).id">DCS#country.id</a> enumerator.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Captured" ><strong>WAREHOUSE:__Captured(delay, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Captured" with a delay when a warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##__Captured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which captured the warehouse.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country id which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__ChangeCountry" ><strong>WAREHOUSE:__ChangeCountry(delay, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "ChangeCountry" after a delay so the warehouse is respawned with the new country.</p>
|
|
|
|
<div id= "#Functions##__ChangeCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country id which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Defeated" ><strong>WAREHOUSE:__Defeated(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Defeated" with a delay when an attack from an enemy was defeated.</p>
|
|
|
|
<div id= "#Functions##__Defeated" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Delivered" ><strong>WAREHOUSE:__Delivered(delay, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Delivered" after a delay.</p>
|
|
|
|
|
|
<p>A group has been delivered from the warehouse to another warehouse.</p>
|
|
|
|
<div id= "#Functions##__Delivered" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending request that was now delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Destroyed" ><strong>WAREHOUSE:__Destroyed(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Destroyed" with a delay when the warehouse was destroyed.</p>
|
|
|
|
|
|
<p>Services are stopped.</p>
|
|
|
|
<div id= "#Functions##__Destroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Load" ><strong>WAREHOUSE:__Load(delay, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Load" with a delay when the warehouse assets are loaded from disk.</p>
|
|
|
|
<div id= "#Functions##__Load" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is located. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__NewAsset" ><strong>WAREHOUSE:__NewAsset(delay, asset, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM delayed event "NewAsset" when a new asset has been added to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##__NewAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The new asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Assignment text for the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Pause" ><strong>WAREHOUSE:__Pause(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Pause" after a delay.</p>
|
|
|
|
|
|
<p>Pauses the warehouse. Assets can still be added and requests be made. However, requests are not processed.</p>
|
|
|
|
<div id= "#Functions##__Pause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Request" ><strong>WAREHOUSE:__Request(Delay, Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Request" after a delay.</p>
|
|
|
|
|
|
<p>Executes a request from the queue if possible.</p>
|
|
|
|
<div id= "#Functions##__Request" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Respawn" ><strong>WAREHOUSE:__Respawn(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Respawn" after a delay.</p>
|
|
|
|
<div id= "#Functions##__Respawn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Restart" ><strong>WAREHOUSE:__Restart(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Restart" after a delay.</p>
|
|
|
|
|
|
<p>Restarts the warehouse from stopped state by reactivating the event handlers <em>only</em>.</p>
|
|
|
|
<div id= "#Functions##__Restart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Save" ><strong>WAREHOUSE:__Save(delay, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Save" with a delay when the warehouse assets are saved to a file.</p>
|
|
|
|
<div id= "#Functions##__Save" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is saved. Default is the DCS installation root directory.</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>(Optional) File name. Default is WAREHOUSE-<UID>_<ALIAS>.txt.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__SelfRequest" ><strong>WAREHOUSE:__SelfRequest(delay, groupset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "SelfRequest" with a delay.</p>
|
|
|
|
|
|
<p>Request was initiated from the warehouse to itself. Groups are just spawned at the warehouse or the associated airbase.
|
|
If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated,
|
|
this request is used to put the groups back into the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##__SelfRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>groupset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The set of cargo groups that was delivered to the warehouse itself.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending self request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Start" ><strong>WAREHOUSE:__Start(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Start" after a delay.</p>
|
|
|
|
|
|
<p>Starts the warehouse. Initializes parameters and starts event handlers.</p>
|
|
|
|
<div id= "#Functions##__Start" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Status" ><strong>WAREHOUSE:__Status(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Status" after a delay.</p>
|
|
|
|
|
|
<p>Queue is updated and requests are executed.</p>
|
|
|
|
<div id= "#Functions##__Status" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Stop" ><strong>WAREHOUSE:__Stop(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Stop" after a delay.</p>
|
|
|
|
|
|
<p>Stops the warehouse and all its event handlers. All waiting and pending queue items are deleted as well and all assets are removed from stock.</p>
|
|
|
|
<div id= "#Functions##__Stop" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).__Unpause" ><strong>WAREHOUSE:__Unpause(delay)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Triggers the FSM event "Unpause" after a delay.</p>
|
|
|
|
|
|
<p>Unpauses the warehouse. Processing of queued requests is resumed.</p>
|
|
|
|
<div id= "#Functions##__Unpause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</div>
|
|
<h2><strong>Parameter:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>delay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Delay in seconds.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAddAsset" ><strong>WAREHOUSE:onafterAddAsset(From, Event, To, group, ngroups, forceattribute, forcecargobay, forceweight, loadradius, skill, liveries, assignment, other)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AddAsset" event.</p>
|
|
|
|
|
|
<p>Add a group to the warehouse stock. If the group is alive, it is destroyed.</p>
|
|
|
|
<div id= "#Functions##onafterAddAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>Group or template group to be added to the warehouse stock.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>ngroups</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups to add to the warehouse stock. Default is 1.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<strong><strong>forceattribute</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force a generalized attribute for the asset. This has to be an <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forcecargobay</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force cargobay weight limit in kg for cargo carriers. This is for each <em>unit</em> of the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>forceweight</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Explicitly force weight in kg of each unit in the group.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>loadradius</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Radius in meters when the cargo is loaded into the carrier.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="DCS.html##(AI.Skill)">DCS#AI.Skill</a>
|
|
<strong><strong>skill</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Skill of the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>liveries</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Table of livery names. When the asset is spawned one livery is chosen randomly.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A free to choose string specifying an assignment for the asset. This can be used with the <a href="##(WAREHOUSE).OnAfterNewAsset">WAREHOUSE.OnAfterNewAsset</a> function.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>other</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>(Optional) Table of other useful data. Can be collected via WAREHOUSE.OnAfterNewAsset() function for example</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAddRequest" ><strong>WAREHOUSE:onafterAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AddRequest" event.</p>
|
|
|
|
|
|
<p>Add a request to the warehouse queue, which is processed when possible.</p>
|
|
|
|
<div id= "#Functions##onafterAddRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse requesting supply.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<strong><strong>AssetDescriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the asset that is requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>AssetDescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nAsset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups requested that match the asset specification.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<strong><strong>TransportType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of transport.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nTransport</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of transport units requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Prio</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Priority of the request. Number ranging from 1=high to 100=low.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A keyword or text that can later be used to identify this request and postprocess the assets.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAirbaseCaptured" ><strong>WAREHOUSE:onafterAirbaseCaptured(From, Event, To, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AirbaseCaptured" event.</p>
|
|
|
|
|
|
<p>Airbase of warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##onafterAirbaseCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAirbaseRecaptured" ><strong>WAREHOUSE:onafterAirbaseRecaptured(From, Event, To, Coalition)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AirbaseRecaptured" event.</p>
|
|
|
|
|
|
<p>Airbase of warehouse has been re-captured from other coalition.</p>
|
|
|
|
<div id= "#Functions##onafterAirbaseRecaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Coalition side which originally captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterArrived" ><strong>WAREHOUSE:onafterArrived(From, Event, To, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Arrived" event.</p>
|
|
|
|
|
|
<p>Triggered when a group has arrived at its destination warehouse.
|
|
The routine should be called by the warehouse sending this asset and not by the receiving warehouse.
|
|
It is checked if this asset is cargo (or self propelled) or transport. If it is cargo it is put into the stock of receiving warehouse.
|
|
If it is a transporter it is put back into the sending warehouse since transports are supposed to return their home warehouse.</p>
|
|
|
|
<div id= "#Functions##onafterArrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 group that was delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAssetDead" ><strong>WAREHOUSE:onafterAssetDead(From, Event, To, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AssetDead" event triggered when an asset group died.</p>
|
|
|
|
<div id= "#Functions##onafterAssetDead" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is dead.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the dead asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAssetSpawned" ><strong>WAREHOUSE:onafterAssetSpawned(From, Event, To, group, asset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "AssetSpawned" event triggered when an asset group is spawned into the cruel world.</p>
|
|
|
|
<div id= "#Functions##onafterAssetSpawned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 group spawned.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that is dead.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The request of the dead asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterAttacked" ><strong>WAREHOUSE:onafterAttacked(From, Event, To, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Attacked" event.</p>
|
|
|
|
|
|
<p>Warehouse is under attack by an another coalition.</p>
|
|
|
|
<div id= "#Functions##onafterAttacked" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which is attacking the warehouse.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which is attacking the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterCaptured" ><strong>WAREHOUSE:onafterCaptured(From, Event, To, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Captured" event.</p>
|
|
|
|
|
|
<p>Warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##onafterCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which captured the warehouse.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterChangeCountry" ><strong>WAREHOUSE:onafterChangeCountry(From, Event, To, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "ChangeCountry" event.</p>
|
|
|
|
|
|
<p>Warehouse is respawned with the specified country. All queued requests are deleted and the owned airbase is reset if the coalition is changed by changing the
|
|
country.</p>
|
|
|
|
<div id= "#Functions##onafterChangeCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Country which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterDefeated" ><strong>WAREHOUSE:onafterDefeated(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Defeated" event.</p>
|
|
|
|
|
|
<p>Warehouse defeated an attack by another coalition. Defender assets are added back to warehouse stock.</p>
|
|
|
|
<div id= "#Functions##onafterDefeated" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterDelivered" ><strong>WAREHOUSE:onafterDelivered(From, Event, To, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Delivered" event.</p>
|
|
|
|
|
|
<p>Triggered when all asset groups have reached their destination. Corresponding request is deleted from the pending queue.</p>
|
|
|
|
<div id= "#Functions##onafterDelivered" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The pending request that is finished and deleted from the pending queue.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterDestroyed" ><strong>WAREHOUSE:onafterDestroyed(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Destroyed" event.</p>
|
|
|
|
|
|
<p>Warehouse was destroyed. All services are stopped. Warehouse is going to "Stopped" state in one minute.</p>
|
|
|
|
<div id= "#Functions##onafterDestroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterLoad" ><strong>WAREHOUSE:onafterLoad(From, Event, To, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Load" event.</p>
|
|
|
|
|
|
<p>Warehouse assets are loaded from file on disk.</p>
|
|
|
|
<div id= "#Functions##onafterLoad" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is loaded from.</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>(Optional) Name of the file containing the asset data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterNewAsset" ><strong>WAREHOUSE:onafterNewAsset(From, Event, To, asset, assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "NewAsset" event.</p>
|
|
|
|
|
|
<p>A new asset has been added to the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##onafterNewAsset" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Assetitem)">#WAREHOUSE.Assetitem</a>
|
|
<strong><strong>asset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The asset that has just been added.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The (optional) assignment for the asset.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterPause" ><strong>WAREHOUSE:onafterPause(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Pause" event.</p>
|
|
|
|
|
|
<p>Pauses the warehouse, i.e. no requests are processed. However, new requests and new assets can be added in this state.</p>
|
|
|
|
<div id= "#Functions##onafterPause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterRequest" ><strong>WAREHOUSE:onafterRequest(From, Event, To, Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Request" event.</p>
|
|
|
|
|
|
<p>Spawns the necessary cargo and transport assets.</p>
|
|
|
|
<div id= "#Functions##onafterRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterRequestSpawned" ><strong>WAREHOUSE:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet, TransportGroupSet)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "RequestSpawned" event.</p>
|
|
|
|
|
|
<p>Initiates the transport of the assets to the requesting warehouse.</p>
|
|
|
|
<div id= "#Functions##onafterRequestSpawned" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>CargoGroupSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set of cargo groups.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>TransportGroupSet</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Set of transport groups if any.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterRespawn" ><strong>WAREHOUSE:onafterRespawn(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Respawn warehouse.</p>
|
|
|
|
<div id= "#Functions##onafterRespawn" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterRestart" ><strong>WAREHOUSE:onafterRestart(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Restart" event.</p>
|
|
|
|
|
|
<p>Restarts the warehouse when it was in stopped state by reactivating the event handlers <em>only</em>.</p>
|
|
|
|
<div id= "#Functions##onafterRestart" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterRunwayDestroyed" ><strong>WAREHOUSE:onafterRunwayDestroyed(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "RunwayDestroyed" event.</p>
|
|
|
|
<div id= "#Functions##onafterRunwayDestroyed" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterRunwayRepaired" ><strong>WAREHOUSE:onafterRunwayRepaired(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "RunwayRepaired" event.</p>
|
|
|
|
<div id= "#Functions##onafterRunwayRepaired" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterSave" ><strong>WAREHOUSE:onafterSave(From, Event, To, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Save" event.</p>
|
|
|
|
|
|
<p>Warehouse assets are saved to file on disk.</p>
|
|
|
|
<div id= "#Functions##onafterSave" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is saved. If nil, file is saved in the DCS root installtion directory.</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>(Optional) Name of the file containing the asset data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterSelfRequest" ><strong>WAREHOUSE:onafterSelfRequest(From, Event, To, groupset, request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "SelfRequest" event.</p>
|
|
|
|
|
|
<p>Request was initiated to the warehouse itself. Groups are just spawned at the warehouse or the associated airbase.
|
|
If the warehouse is currently under attack when the self request is made, the self request is added to the defending table. One the attack is defeated,
|
|
this request is used to put the groups back into the warehouse stock.</p>
|
|
|
|
<div id= "#Functions##onafterSelfRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<strong><strong>groupset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The set of asset groups that was delivered to the warehouse itself.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Pendingitem)">#WAREHOUSE.Pendingitem</a>
|
|
<strong><strong>request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Pending self request.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterStart" ><strong>WAREHOUSE:onafterStart(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after Start event.</p>
|
|
|
|
|
|
<p>Starts the warehouse. Adds event handlers and schedules status updates of reqests and queue.</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>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterStatus" ><strong>WAREHOUSE:onafterStatus(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after Status event.</p>
|
|
|
|
|
|
<p>Checks the queue and handles requests.</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>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterStop" ><strong>WAREHOUSE:onafterStop(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Stop" event.</p>
|
|
|
|
|
|
<p>Stops the warehouse, unhandles all events.</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>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onafterUnloaded" ><strong>WAREHOUSE:onafterUnloaded(From, Event, To, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Unloaded" event.</p>
|
|
|
|
|
|
<p>Triggered when a group was unloaded from the carrier.</p>
|
|
|
|
<div id= "#Functions##onafterUnloaded" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 group that was delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onafterUnpause" ><strong>WAREHOUSE:onafterUnpause(From, Event, To)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On after "Unpause" event.</p>
|
|
|
|
|
|
<p>Unpauses the warehouse, i.e. requests in queue are processed again.</p>
|
|
|
|
<div id= "#Functions##onafterUnpause" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="#(WAREHOUSE).onbeforeAddRequest" ><strong>WAREHOUSE:onbeforeAddRequest(From, Event, To, warehouse, AssetDescriptor, AssetDescriptorValue, nAsset, TransportType, nTransport, Prio, Assignment)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "AddRequest" event.</p>
|
|
|
|
|
|
<p>Checks some basic properties of the given parameters.</p>
|
|
|
|
<div id= "#Functions##onbeforeAddRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<strong><strong>warehouse</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The warehouse requesting supply.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<strong><strong>AssetDescriptor</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Descriptor describing the asset that is requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>AssetDescriptorValue</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Value of the asset descriptor. Type depends on descriptor, i.e. could be a string, etc.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nAsset</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of groups requested that match the asset specification.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<strong><strong>TransportType</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Type of transport.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>nTransport</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Number of transport units requested.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Prio</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Priority of the request. Number ranging from 1=high to 100=low.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>Assignment</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>A keyword or text that later be used to identify this request and postprocess the assets.</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, request is okay at first glance.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onbeforeArrived" ><strong>WAREHOUSE:onbeforeArrived(From, Event, To, group)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Arrived" event.</p>
|
|
|
|
|
|
<p>Triggered when a group has arrived at its destination warehouse.</p>
|
|
|
|
<div id= "#Functions##onbeforeArrived" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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 group that was delivered.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onbeforeCaptured" ><strong>WAREHOUSE:onbeforeCaptured(From, Event, To, Coalition, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Captured" event.</p>
|
|
|
|
|
|
<p>Warehouse has been captured by another coalition.</p>
|
|
|
|
<div id= "#Functions##onbeforeCaptured" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(coalition.side)">DCS#coalition.side</a>
|
|
<strong><strong>Coalition</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which captured the warehouse.</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##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onbeforeChangeCountry" ><strong>WAREHOUSE:onbeforeChangeCountry(From, Event, To, Country)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "ChangeCountry" event.</p>
|
|
|
|
|
|
<p>Checks whether a change of country is necessary by comparing the actual country to the the requested one.</p>
|
|
|
|
<div id= "#Functions##onbeforeChangeCountry" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="DCS.html##(country.id)">DCS#country.id</a>
|
|
<strong><strong>Country</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>which has captured the warehouse.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onbeforeLoad" ><strong>WAREHOUSE:onbeforeLoad(From, Event, To, path, filename)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Load" event.</p>
|
|
|
|
|
|
<p>Checks if the file the warehouse data should be loaded from exists.</p>
|
|
|
|
<div id= "#Functions##onbeforeLoad" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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>
|
|
#string
|
|
<strong><strong>path</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Path where the file is loaded from.</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>(Optional) Name of the file containing the asset data.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<div class="w3-theme-l2">
|
|
<h2><a id="#(WAREHOUSE).onbeforeRequest" ><strong>WAREHOUSE:onbeforeRequest(From, Event, To, Request)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>On before "Request" event.</p>
|
|
|
|
|
|
<p>Checks if the request can be fulfilled.</p>
|
|
|
|
<div id= "#Functions##onbeforeRequest" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p>WAREHOUSE</p>
|
|
</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="##(WAREHOUSE.Queueitem)">#WAREHOUSE.Queueitem</a>
|
|
<strong><strong>Request</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Information table of the request.</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, request is granted.</p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<a id="#(WAREHOUSE).Attribute" ><strong>WAREHOUSE.Attribute</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).ClassName" ><strong>WAREHOUSE.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Debug" ><strong>WAREHOUSE.Debug</strong></a>
|
|
|
|
<p>If true, send debug messages to all.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<a id="#(WAREHOUSE).Descriptor" ><strong>WAREHOUSE.Descriptor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Quantity)">#WAREHOUSE.Quantity</a>
|
|
<a id="#(WAREHOUSE).Quantity" ><strong>WAREHOUSE.Quantity</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Report" ><strong>WAREHOUSE.Report</strong></a>
|
|
|
|
<p>If true, send status messages to coalition.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<a id="#(WAREHOUSE).TransportType" ><strong>WAREHOUSE.TransportType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(WAREHOUSE).airbase" ><strong>WAREHOUSE.airbase</strong></a>
|
|
|
|
<p>Airbase the warehouse belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).airbasename" ><strong>WAREHOUSE.airbasename</strong></a>
|
|
|
|
<p>Name of the airbase associated to the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).alias" ><strong>WAREHOUSE.alias</strong></a>
|
|
|
|
<p>Alias of the warehouse. Name its called when sending messages.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).allowSpawnOnClientSpots" ><strong>WAREHOUSE.allowSpawnOnClientSpots</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autodefence" ><strong>WAREHOUSE.autodefence</strong></a>
|
|
|
|
<p>When the warehouse is under attack, automatically spawn assets to defend the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autosave" ><strong>WAREHOUSE.autosave</strong></a>
|
|
|
|
<p>Automatically save assets to file when mission ends.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavefile" ><strong>WAREHOUSE.autosavefile</strong></a>
|
|
|
|
<p>File name of the auto asset save file. Default is auto generated from warehouse id and name.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavepath" ><strong>WAREHOUSE.autosavepath</strong></a>
|
|
|
|
<p>Path where the asset file is saved on auto save.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).coalition" ><strong>WAREHOUSE.coalition</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Coalition of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).countryid" ><strong>WAREHOUSE.countryid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Country of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).dTstatus" ><strong>WAREHOUSE.dTstatus</strong></a>
|
|
|
|
<p>Time interval in seconds of updating the warehouse status and processing new events. Default 30 seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).defending" ><strong>WAREHOUSE.defending</strong></a>
|
|
|
|
<p>Table holding all defending requests, i.e. self requests that were if the warehouse is under attack. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).delivered" ><strong>WAREHOUSE.delivered</strong></a>
|
|
|
|
<p>Table holding all delivered requests. Table elements are #boolean. If true, all cargo has been delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="OPS.FlightControl.html##(FLIGHTCONTROL)">OPS.FlightControl#FLIGHTCONTROL</a>
|
|
<a id="#(WAREHOUSE).flightcontrol" ><strong>WAREHOUSE.flightcontrol</strong></a>
|
|
|
|
<p>Flight control of this warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).harborzone" ><strong>WAREHOUSE.harborzone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isShip" ><strong>WAREHOUSE.isShip</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a ship unit.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isUnit" ><strong>WAREHOUSE.isUnit</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a unit instead of a static.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).lid" ><strong>WAREHOUSE.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).lowfuelthresh" ><strong>WAREHOUSE.lowfuelthresh</strong></a>
|
|
|
|
<p>Low fuel threshold. Triggers the event AssetLowFuel if for any unit fuel goes below this number.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).markerOn" ><strong>WAREHOUSE.markerOn</strong></a>
|
|
|
|
<p>If true, markers are displayed on the F10 map.</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="#(WAREHOUSE).markerRail" ><strong>WAREHOUSE.markerRail</strong></a>
|
|
|
|
<p>Rail road connection.</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="#(WAREHOUSE).markerRoad" ><strong>WAREHOUSE.markerRoad</strong></a>
|
|
|
|
<p>Road connection.</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="#(WAREHOUSE).markerWarehouse" ><strong>WAREHOUSE.markerWarehouse</strong></a>
|
|
|
|
<p>Marker warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).markerid" ><strong>WAREHOUSE.markerid</strong></a>
|
|
|
|
<p>ID of the warehouse marker at the airbase.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markrail" ><strong>WAREHOUSE.markrail</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markroad" ><strong>WAREHOUSE.markroad</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).offroadpaths" ><strong>WAREHOUSE.offroadpaths</strong></a>
|
|
|
|
<p>Table holding user defined paths from one warehouse to another.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).parkingIDs" ><strong>WAREHOUSE.parkingIDs</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).pending" ><strong>WAREHOUSE.pending</strong></a>
|
|
|
|
<p>Table holding all pending requests, i.e. those that are currently in progress. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).portzone" ><strong>WAREHOUSE.portzone</strong></a>
|
|
|
|
<p>Zone defining the port of a warehouse. This is where naval assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).queue" ><strong>WAREHOUSE.queue</strong></a>
|
|
|
|
<p>Table holding all queued requests. Table entries are of type <a href="##(WAREHOUSE).Queueitem">WAREHOUSE.Queueitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).queueid" ><strong>WAREHOUSE.queueid</strong></a>
|
|
|
|
<p>Unit id of each request in the queue. Essentially a running number starting at one and incremented when a new request is added.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).rail" ><strong>WAREHOUSE.rail</strong></a>
|
|
|
|
<p>Closest point to warehouse on rail.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).respawnafterdestroyed" ><strong>WAREHOUSE.respawnafterdestroyed</strong></a>
|
|
|
|
<p>If true, warehouse is respawned after it was destroyed. Assets are kept.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).respawndelay" ><strong>WAREHOUSE.respawndelay</strong></a>
|
|
|
|
<p>Delay before respawn in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).road" ><strong>WAREHOUSE.road</strong></a>
|
|
|
|
<p>Closest point to warehouse on road.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwaydestroyed" ><strong>WAREHOUSE.runwaydestroyed</strong></a>
|
|
|
|
<p>Time stamp timer.getAbsTime() when the runway was destroyed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwayrepairtime" ><strong>WAREHOUSE.runwayrepairtime</strong></a>
|
|
|
|
<p>Time in seconds until runway will be repaired after it was destroyed. Default is 3600 sec (one hour).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).safeparking" ><strong>WAREHOUSE.safeparking</strong></a>
|
|
|
|
<p>If true, parking spots for aircraft are considered as occupied if e.g. a client aircraft is parked there. Default false.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).shippinglanes" ><strong>WAREHOUSE.shippinglanes</strong></a>
|
|
|
|
<p>Table holding the user defined shipping between warehouses.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).spawnzone" ><strong>WAREHOUSE.spawnzone</strong></a>
|
|
|
|
<p>Zone in which assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).spawnzonemaxdist" ><strong>WAREHOUSE.spawnzonemaxdist</strong></a>
|
|
|
|
<p>Max distance between warehouse and spawn zone. Default 5000 meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).stock" ><strong>WAREHOUSE.stock</strong></a>
|
|
|
|
<p>Table holding all assets in stock. Table entries are of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).transporting" ><strong>WAREHOUSE.transporting</strong></a>
|
|
|
|
<p>Table holding assets currently transporting cargo assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).uid" ><strong>WAREHOUSE.uid</strong></a>
|
|
|
|
<p>Unique ID of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).verbosity" ><strong>WAREHOUSE.verbosity</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).version" ><strong>WAREHOUSE.version</strong></a>
|
|
|
|
<p>Warehouse class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
|
|
<a id="#(WAREHOUSE).warehouse" ><strong>WAREHOUSE.warehouse</strong></a>
|
|
|
|
<p>The phyical warehouse structure.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).wid" ><strong>WAREHOUSE.wid</strong></a>
|
|
|
|
<p>Identifier of the warehouse printed before other output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).zone" ><strong>WAREHOUSE.zone</strong></a>
|
|
|
|
<p>Zone around the warehouse. If this zone is captured, the warehouse and all its assets goes to the capturing coalition.</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="#(WAREHOUSE).AddEndState" ><strong>WAREHOUSE: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="#(WAREHOUSE).AddProcess" ><strong>WAREHOUSE: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="#(WAREHOUSE).AddScore" ><strong>WAREHOUSE: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="#(WAREHOUSE).AddScoreProcess" ><strong>WAREHOUSE: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="#(WAREHOUSE).AddTransition" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetCurrentState" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetEndStates" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetProcess" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetProcesses" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetScores" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetStartState" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetState" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetSubs" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetTransitions" ><strong>WAREHOUSE: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="#(WAREHOUSE).Is" ><strong>WAREHOUSE: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="#(WAREHOUSE).LoadCallBacks" ><strong>WAREHOUSE: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="#(WAREHOUSE).New" ><strong>WAREHOUSE: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="#(WAREHOUSE).SetProcess" ><strong>WAREHOUSE: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="#(WAREHOUSE).SetStartState" ><strong>WAREHOUSE: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="#(WAREHOUSE)._add_to_map" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._call_handler" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._create_transition" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._delayed_transition" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._eventmap" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._gosub" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._handler" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._isendstate" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._submap" ><strong>WAREHOUSE:_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="#(WAREHOUSE).can" ><strong>WAREHOUSE: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="#(WAREHOUSE).cannot" ><strong>WAREHOUSE: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="#(WAREHOUSE).is" ><strong>WAREHOUSE:is(State, state)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Check if FSM is in state.</p>
|
|
|
|
<div id= "#Functions##is" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#string
|
|
<strong><strong>State</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>State name.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
<strong><strong>state</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
<p></p>
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#boolean:</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>If true, FSM is in this state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<a id="#(WAREHOUSE).Attribute" ><strong>WAREHOUSE.Attribute</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).ClassName" ><strong>WAREHOUSE.ClassName</strong></a>
|
|
|
|
<p>Name of the class.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Debug" ><strong>WAREHOUSE.Debug</strong></a>
|
|
|
|
<p>If true, send debug messages to all.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<a id="#(WAREHOUSE).Descriptor" ><strong>WAREHOUSE.Descriptor</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Quantity)">#WAREHOUSE.Quantity</a>
|
|
<a id="#(WAREHOUSE).Quantity" ><strong>WAREHOUSE.Quantity</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).Report" ><strong>WAREHOUSE.Report</strong></a>
|
|
|
|
<p>If true, send status messages to coalition.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<a id="#(WAREHOUSE).TransportType" ><strong>WAREHOUSE.TransportType</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(WAREHOUSE).airbase" ><strong>WAREHOUSE.airbase</strong></a>
|
|
|
|
<p>Airbase the warehouse belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).airbasename" ><strong>WAREHOUSE.airbasename</strong></a>
|
|
|
|
<p>Name of the airbase associated to the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).alias" ><strong>WAREHOUSE.alias</strong></a>
|
|
|
|
<p>Alias of the warehouse. Name its called when sending messages.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).allowSpawnOnClientSpots" ><strong>WAREHOUSE.allowSpawnOnClientSpots</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autodefence" ><strong>WAREHOUSE.autodefence</strong></a>
|
|
|
|
<p>When the warehouse is under attack, automatically spawn assets to defend the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).autosave" ><strong>WAREHOUSE.autosave</strong></a>
|
|
|
|
<p>Automatically save assets to file when mission ends.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavefile" ><strong>WAREHOUSE.autosavefile</strong></a>
|
|
|
|
<p>File name of the auto asset save file. Default is auto generated from warehouse id and name.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).autosavepath" ><strong>WAREHOUSE.autosavepath</strong></a>
|
|
|
|
<p>Path where the asset file is saved on auto save.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).coalition" ><strong>WAREHOUSE.coalition</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Coalition of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).countryid" ><strong>WAREHOUSE.countryid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Country of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).dTstatus" ><strong>WAREHOUSE.dTstatus</strong></a>
|
|
|
|
<p>Time interval in seconds of updating the warehouse status and processing new events. Default 30 seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).defending" ><strong>WAREHOUSE.defending</strong></a>
|
|
|
|
<p>Table holding all defending requests, i.e. self requests that were if the warehouse is under attack. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).delivered" ><strong>WAREHOUSE.delivered</strong></a>
|
|
|
|
<p>Table holding all delivered requests. Table elements are #boolean. If true, all cargo has been delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="OPS.FlightControl.html##(FLIGHTCONTROL)">OPS.FlightControl#FLIGHTCONTROL</a>
|
|
<a id="#(WAREHOUSE).flightcontrol" ><strong>WAREHOUSE.flightcontrol</strong></a>
|
|
|
|
<p>Flight control of this warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).harborzone" ><strong>WAREHOUSE.harborzone</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isShip" ><strong>WAREHOUSE.isShip</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a ship unit.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).isUnit" ><strong>WAREHOUSE.isUnit</strong></a>
|
|
|
|
<p>If <code>true</code>, warehouse is represented by a unit instead of a static.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).lid" ><strong>WAREHOUSE.lid</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set some string id for output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).lowfuelthresh" ><strong>WAREHOUSE.lowfuelthresh</strong></a>
|
|
|
|
<p>Low fuel threshold. Triggers the event AssetLowFuel if for any unit fuel goes below this number.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).markerOn" ><strong>WAREHOUSE.markerOn</strong></a>
|
|
|
|
<p>If true, markers are displayed on the F10 map.</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="#(WAREHOUSE).markerRail" ><strong>WAREHOUSE.markerRail</strong></a>
|
|
|
|
<p>Rail road connection.</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="#(WAREHOUSE).markerRoad" ><strong>WAREHOUSE.markerRoad</strong></a>
|
|
|
|
<p>Road connection.</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="#(WAREHOUSE).markerWarehouse" ><strong>WAREHOUSE.markerWarehouse</strong></a>
|
|
|
|
<p>Marker warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).markerid" ><strong>WAREHOUSE.markerid</strong></a>
|
|
|
|
<p>ID of the warehouse marker at the airbase.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markrail" ><strong>WAREHOUSE.markrail</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).markroad" ><strong>WAREHOUSE.markroad</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).offroadpaths" ><strong>WAREHOUSE.offroadpaths</strong></a>
|
|
|
|
<p>Table holding user defined paths from one warehouse to another.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE).parkingIDs" ><strong>WAREHOUSE.parkingIDs</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).pending" ><strong>WAREHOUSE.pending</strong></a>
|
|
|
|
<p>Table holding all pending requests, i.e. those that are currently in progress. Table elements are of type <a href="##(WAREHOUSE).Pendingitem">WAREHOUSE.Pendingitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).portzone" ><strong>WAREHOUSE.portzone</strong></a>
|
|
|
|
<p>Zone defining the port of a warehouse. This is where naval assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).queue" ><strong>WAREHOUSE.queue</strong></a>
|
|
|
|
<p>Table holding all queued requests. Table entries are of type <a href="##(WAREHOUSE).Queueitem">WAREHOUSE.Queueitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).queueid" ><strong>WAREHOUSE.queueid</strong></a>
|
|
|
|
<p>Unit id of each request in the queue. Essentially a running number starting at one and incremented when a new request is added.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).rail" ><strong>WAREHOUSE.rail</strong></a>
|
|
|
|
<p>Closest point to warehouse on rail.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).respawnafterdestroyed" ><strong>WAREHOUSE.respawnafterdestroyed</strong></a>
|
|
|
|
<p>If true, warehouse is respawned after it was destroyed. Assets are kept.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).respawndelay" ><strong>WAREHOUSE.respawndelay</strong></a>
|
|
|
|
<p>Delay before respawn in seconds.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
|
|
<a id="#(WAREHOUSE).road" ><strong>WAREHOUSE.road</strong></a>
|
|
|
|
<p>Closest point to warehouse on road.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwaydestroyed" ><strong>WAREHOUSE.runwaydestroyed</strong></a>
|
|
|
|
<p>Time stamp timer.getAbsTime() when the runway was destroyed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).runwayrepairtime" ><strong>WAREHOUSE.runwayrepairtime</strong></a>
|
|
|
|
<p>Time in seconds until runway will be repaired after it was destroyed. Default is 3600 sec (one hour).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE).safeparking" ><strong>WAREHOUSE.safeparking</strong></a>
|
|
|
|
<p>If true, parking spots for aircraft are considered as occupied if e.g. a client aircraft is parked there. Default false.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).shippinglanes" ><strong>WAREHOUSE.shippinglanes</strong></a>
|
|
|
|
<p>Table holding the user defined shipping between warehouses.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).spawnzone" ><strong>WAREHOUSE.spawnzone</strong></a>
|
|
|
|
<p>Zone in which assets are spawned.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).spawnzonemaxdist" ><strong>WAREHOUSE.spawnzonemaxdist</strong></a>
|
|
|
|
<p>Max distance between warehouse and spawn zone. Default 5000 meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).stock" ><strong>WAREHOUSE.stock</strong></a>
|
|
|
|
<p>Table holding all assets in stock. Table entries are of type <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE).transporting" ><strong>WAREHOUSE.transporting</strong></a>
|
|
|
|
<p>Table holding assets currently transporting cargo assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).uid" ><strong>WAREHOUSE.uid</strong></a>
|
|
|
|
<p>Unique ID of the warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE).verbosity" ><strong>WAREHOUSE.verbosity</strong></a>
|
|
|
|
<p>Verbosity level.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).version" ><strong>WAREHOUSE.version</strong></a>
|
|
|
|
<p>Warehouse class version.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Static.html##(STATIC)">Wrapper.Static#STATIC</a>
|
|
<a id="#(WAREHOUSE).warehouse" ><strong>WAREHOUSE.warehouse</strong></a>
|
|
|
|
<p>The phyical warehouse structure.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE).wid" ><strong>WAREHOUSE.wid</strong></a>
|
|
|
|
<p>Identifier of the warehouse printed before other output to DCS.log file.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a>
|
|
<a id="#(WAREHOUSE).zone" ><strong>WAREHOUSE.zone</strong></a>
|
|
|
|
<p>Zone around the warehouse. If this zone is captured, the warehouse and all its assets goes to the capturing coalition.</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="#(WAREHOUSE).ClearState" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventBirth" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventCrash" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventDead" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventDynamicCargoLoaded" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventDynamicCargoRemoved" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventDynamicCargoUnloaded" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventNewDynamicCargo" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventPlayerEnterAircraft" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventRemoveUnit" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventTakeoff" ><strong>WAREHOUSE: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="#(WAREHOUSE).CreateEventUnitLost" ><strong>WAREHOUSE: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="#(WAREHOUSE).E" ><strong>WAREHOUSE: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="#(WAREHOUSE).EventDispatcher" ><strong>WAREHOUSE: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="#(WAREHOUSE).EventRemoveAll" ><strong>WAREHOUSE: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="#(WAREHOUSE).F" ><strong>WAREHOUSE: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="#(WAREHOUSE).F2" ><strong>WAREHOUSE: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="#(WAREHOUSE).F3" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetClassID" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetClassName" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetClassNameAndID" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetEventPriority" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetParent" ><strong>WAREHOUSE: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="#(WAREHOUSE).GetState" ><strong>WAREHOUSE: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="#(WAREHOUSE).HandleEvent" ><strong>WAREHOUSE: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="#(WAREHOUSE).I" ><strong>WAREHOUSE: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="#(WAREHOUSE).Inherit" ><strong>WAREHOUSE: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="#(WAREHOUSE).IsInstanceOf" ><strong>WAREHOUSE: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="#(WAREHOUSE).IsTrace" ><strong>WAREHOUSE: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="#(WAREHOUSE).New" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEvent" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventBDA" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventBaseCaptured" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventBirth" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventCrash" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDead" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDetailedFailure" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDiscardChairAfterEjection" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDynamicCargoLoaded" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDynamicCargoRemoved" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventDynamicCargoUnloaded" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventEjection" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventEngineShutdown" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventEngineStartup" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventHit" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventHumanFailure" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventKill" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventLand" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventLandingAfterEjection" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventLandingQualityMark" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventMarkAdded" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventMarkChange" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventMarkRemoved" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventMissionEnd" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventMissionStart" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventNewDynamicCargo" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventParatrooperLanding" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventPilotDead" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventPlayerEnterAircraft" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventPlayerEnterUnit" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventPlayerLeaveUnit" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventRefueling" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventRefuelingStop" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventScore" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventShootingEnd" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventShootingStart" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventShot" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventTakeoff" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventTriggerZone" ><strong>WAREHOUSE: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="#(WAREHOUSE).OnEventUnitLost" ><strong>WAREHOUSE: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="#(WAREHOUSE).ScheduleOnce" ><strong>WAREHOUSE:ScheduleOnce(Start, SchedulerFunction, ...)</strong></a></h2>
|
|
</div>
|
|
|
|
<p>Schedule a new time event.</p>
|
|
|
|
|
|
<p>Note that the schedule will only take place if the scheduler is <em>started</em>. Even for a single schedule event, the scheduler needs to be started also.</p>
|
|
|
|
<div id= "#Functions##ScheduleOnce" class="w3-show w3-white">
|
|
<div class="w3-container w3-white" id="functiontype">
|
|
<h2><strong>Defined in:</strong></h2>
|
|
<div class="w3-margin-left">
|
|
<p><a href="Core.Base.html##(BASE)">Core.Base#BASE</a></p>
|
|
</div>
|
|
<h2><strong>Parameters:</strong></h2>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#number
|
|
<strong><strong>Start</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#function
|
|
<strong><strong>SchedulerFunction</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
|
<div class="w3-half">
|
|
<p>
|
|
#table
|
|
<strong><strong>...</strong></strong>
|
|
</p>
|
|
</div>
|
|
<div class="w3-half">
|
|
|
|
<p>Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2><strong>Return value:</strong></h2>
|
|
<div class="w3-row w3-border-bottom w3-margin-left">
|
|
<div class="w3-half">
|
|
<p>#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="#(WAREHOUSE).ScheduleRepeat" ><strong>WAREHOUSE: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="#(WAREHOUSE).ScheduleStop" ><strong>WAREHOUSE: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="#(WAREHOUSE).SetEventPriority" ><strong>WAREHOUSE: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="#(WAREHOUSE).SetState" ><strong>WAREHOUSE: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="#(WAREHOUSE).T" ><strong>WAREHOUSE: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="#(WAREHOUSE).T2" ><strong>WAREHOUSE: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="#(WAREHOUSE).T3" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceAll" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceClass" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceClassMethod" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceLevel" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceOff" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceOn" ><strong>WAREHOUSE: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="#(WAREHOUSE).TraceOnOff" ><strong>WAREHOUSE: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="#(WAREHOUSE).UnHandleEvent" ><strong>WAREHOUSE: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="#(WAREHOUSE)._F" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._Serialize" ><strong>WAREHOUSE:_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="#(WAREHOUSE)._T" ><strong>WAREHOUSE:_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="#(WAREHOUSE).onEvent" ><strong>WAREHOUSE: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##WAREHOUSE.Assetitem')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Assetitem)">Type <strong>WAREHOUSE.Assetitem</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Assetitem" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Item of the warehouse stock table.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="DCS.html##(Object.Desc)">DCS#Object.Desc</a>
|
|
<a id="#(WAREHOUSE.Assetitem).DCSdesc" ><strong>WAREHOUSE.Assetitem.DCSdesc</strong></a>
|
|
|
|
<p>All DCS descriptors.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).Treturned" ><strong>WAREHOUSE.Assetitem.Treturned</strong></a>
|
|
|
|
<p>Time stamp when asset returned to its legion (airwing, brigade).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Assetitem).arrived" ><strong>WAREHOUSE.Assetitem.arrived</strong></a>
|
|
|
|
<p>If true, asset arrived at its destination.</p>
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).assignment" ><strong>WAREHOUSE.Assetitem.assignment</strong></a>
|
|
|
|
<p>Assignment of the asset. This could, e.g., be used in the @{#WAREHOUSE.OnAfterNewAsset) function.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Attribute)">#WAREHOUSE.Attribute</a>
|
|
<a id="#(WAREHOUSE.Assetitem).attribute" ><strong>WAREHOUSE.Assetitem.attribute</strong></a>
|
|
|
|
<p>Generalized attribute of the group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Assetitem).cargobay" ><strong>WAREHOUSE.Assetitem.cargobay</strong></a>
|
|
|
|
<p>Array of cargo bays of all units in an asset group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).cargobaymax" ><strong>WAREHOUSE.Assetitem.cargobaymax</strong></a>
|
|
|
|
<p>Largest cargo bay of all units in the group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).cargobaytot" ><strong>WAREHOUSE.Assetitem.cargobaytot</strong></a>
|
|
|
|
<p>Total weight in kg that fits in the cargo bay of all asset group units.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="DCS.html##(Group.Category)">DCS#Group.Category</a>
|
|
<a id="#(WAREHOUSE.Assetitem).category" ><strong>WAREHOUSE.Assetitem.category</strong></a>
|
|
|
|
<p>Category of the group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a>
|
|
<a id="#(WAREHOUSE.Assetitem).cohort" ><strong>WAREHOUSE.Assetitem.cohort</strong></a>
|
|
|
|
<p>The cohort this asset belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).damage" ><strong>WAREHOUSE.Assetitem.damage</strong></a>
|
|
|
|
<p>Damage of asset group in percent.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a>
|
|
<a id="#(WAREHOUSE.Assetitem).flightgroup" ><strong>WAREHOUSE.Assetitem.flightgroup</strong></a>
|
|
|
|
<p>The flightgroup object.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Assetitem).isReserved" ><strong>WAREHOUSE.Assetitem.isReserved</strong></a>
|
|
|
|
<p>If <code>true</code>, asset was reserved and cannot be selected by another request.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Assetitem).iscargo" ><strong>WAREHOUSE.Assetitem.iscargo</strong></a>
|
|
|
|
<p>If true, asset is cargo. If false asset is transport. Nil if in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a>
|
|
<a id="#(WAREHOUSE.Assetitem).legion" ><strong>WAREHOUSE.Assetitem.legion</strong></a>
|
|
|
|
<p>The legion this asset belonts to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE.Assetitem).life0" ><strong>WAREHOUSE.Assetitem.life0</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).livery" ><strong>WAREHOUSE.Assetitem.livery</strong></a>
|
|
|
|
<p>Livery of the asset.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).loadradius" ><strong>WAREHOUSE.Assetitem.loadradius</strong></a>
|
|
|
|
<p>Distance when cargo is loaded into the carrier.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).nunits" ><strong>WAREHOUSE.Assetitem.nunits</strong></a>
|
|
|
|
<p>Number of units in the group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Ops.Airwing.html##(AIRWING.Payload)">Ops.Airwing#AIRWING.Payload</a>
|
|
<a id="#(WAREHOUSE.Assetitem).payload" ><strong>WAREHOUSE.Assetitem.payload</strong></a>
|
|
|
|
<p>The payload of the asset.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).range" ><strong>WAREHOUSE.Assetitem.range</strong></a>
|
|
|
|
<p>Range of the unit in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Assetitem).requested" ><strong>WAREHOUSE.Assetitem.requested</strong></a>
|
|
|
|
<p>If <code>true</code>, asset was requested and cannot be selected by another request.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).rid" ><strong>WAREHOUSE.Assetitem.rid</strong></a>
|
|
|
|
<p>Request ID of this asset (if any).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).size" ><strong>WAREHOUSE.Assetitem.size</strong></a>
|
|
|
|
<p>Maximum size in length and with of the asset in meters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="DCS.html##(AI.Skill)">DCS#AI.Skill</a>
|
|
<a id="#(WAREHOUSE.Assetitem).skill" ><strong>WAREHOUSE.Assetitem.skill</strong></a>
|
|
|
|
<p>Skill of AI unit.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Assetitem).spawned" ><strong>WAREHOUSE.Assetitem.spawned</strong></a>
|
|
|
|
<p>If true, asset was spawned into the cruel world. If false, it is still in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).spawngroupname" ><strong>WAREHOUSE.Assetitem.spawngroupname</strong></a>
|
|
|
|
<p>Name of the spawned group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).speedmax" ><strong>WAREHOUSE.Assetitem.speedmax</strong></a>
|
|
|
|
<p>Maximum speed in km/h the group can do.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).squadname" ><strong>WAREHOUSE.Assetitem.squadname</strong></a>
|
|
|
|
<p>Name of the squadron this asset belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE.Assetitem).task" ><strong>WAREHOUSE.Assetitem.task</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Assetitem).template" ><strong>WAREHOUSE.Assetitem.template</strong></a>
|
|
|
|
<p>The spawn template of the group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).templatename" ><strong>WAREHOUSE.Assetitem.templatename</strong></a>
|
|
|
|
<p>Name of the template group.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).uid" ><strong>WAREHOUSE.Assetitem.uid</strong></a>
|
|
|
|
<p>Unique id of the asset.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Assetitem).unittype" ><strong>WAREHOUSE.Assetitem.unittype</strong></a>
|
|
|
|
<p>Type of the first unit of the group as obtained by the Object.getTypeName() DCS API function.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).weight" ><strong>WAREHOUSE.Assetitem.weight</strong></a>
|
|
|
|
<p>The weight of the whole asset group in kilograms.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE.Assetitem).weights" ><strong>WAREHOUSE.Assetitem.weights</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Assetitem).wid" ><strong>WAREHOUSE.Assetitem.wid</strong></a>
|
|
|
|
<p>ID of the warehouse this asset belongs to.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.Attribute')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Attribute)">Type <strong>WAREHOUSE.Attribute</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Attribute" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Generalized asset attributes.</p>
|
|
|
|
|
|
<p>Can be used to request assets with certain general characteristics. See <a href="https://wiki.hoggitworld.com/view/DCS_enum_attributes">DCS attributes</a> on hoggit.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_ATTACKHELO" ><strong>WAREHOUSE.Attribute.AIR_ATTACKHELO</strong></a>
|
|
|
|
<p>Attack helicopter.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_AWACS" ><strong>WAREHOUSE.Attribute.AIR_AWACS</strong></a>
|
|
|
|
<p>Airborne Early Warning and Control System.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_BOMBER" ><strong>WAREHOUSE.Attribute.AIR_BOMBER</strong></a>
|
|
|
|
<p>Aircraft which can be used for strategic bombing.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_FIGHTER" ><strong>WAREHOUSE.Attribute.AIR_FIGHTER</strong></a>
|
|
|
|
<p>Fighter, interceptor, ... airplane.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_OTHER" ><strong>WAREHOUSE.Attribute.AIR_OTHER</strong></a>
|
|
|
|
<p>Any airborne unit that does not fall into any other airborne category.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_TANKER" ><strong>WAREHOUSE.Attribute.AIR_TANKER</strong></a>
|
|
|
|
<p>Airplane which can refuel other aircraft.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_TRANSPORTHELO" ><strong>WAREHOUSE.Attribute.AIR_TRANSPORTHELO</strong></a>
|
|
|
|
<p>Helicopter with transport capability. This can be used to transport other assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_TRANSPORTPLANE" ><strong>WAREHOUSE.Attribute.AIR_TRANSPORTPLANE</strong></a>
|
|
|
|
<p>Airplane with transport capability. This can be used to transport other assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).AIR_UAV" ><strong>WAREHOUSE.Attribute.AIR_UAV</strong></a>
|
|
|
|
<p>Unpiloted Aerial Vehicle, e.g. drones.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_AAA" ><strong>WAREHOUSE.Attribute.GROUND_AAA</strong></a>
|
|
|
|
<p>Anti-Aircraft Artillery.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_APC" ><strong>WAREHOUSE.Attribute.GROUND_APC</strong></a>
|
|
|
|
<p>Infantry carriers, in particular Amoured Personell Carrier. This can be used to transport other assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_ARTILLERY" ><strong>WAREHOUSE.Attribute.GROUND_ARTILLERY</strong></a>
|
|
|
|
<p>Artillery assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_EWR" ><strong>WAREHOUSE.Attribute.GROUND_EWR</strong></a>
|
|
|
|
<p>Early Warning Radar.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_IFV" ><strong>WAREHOUSE.Attribute.GROUND_IFV</strong></a>
|
|
|
|
<p>Ground infantry fighting vehicle.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_INFANTRY" ><strong>WAREHOUSE.Attribute.GROUND_INFANTRY</strong></a>
|
|
|
|
<p>Ground infantry assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_OTHER" ><strong>WAREHOUSE.Attribute.GROUND_OTHER</strong></a>
|
|
|
|
<p>Any ground unit that does not fall into any other ground category.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_SAM" ><strong>WAREHOUSE.Attribute.GROUND_SAM</strong></a>
|
|
|
|
<p>Surface-to-Air Missile system or components.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_TANK" ><strong>WAREHOUSE.Attribute.GROUND_TANK</strong></a>
|
|
|
|
<p>Tanks (modern or old).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_TRAIN" ><strong>WAREHOUSE.Attribute.GROUND_TRAIN</strong></a>
|
|
|
|
<p>Trains. Not that trains are <strong>not</strong> yet properly implemented in DCS and cannot be used currently.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).GROUND_TRUCK" ><strong>WAREHOUSE.Attribute.GROUND_TRUCK</strong></a>
|
|
|
|
<p>Unarmed ground vehicles, which has the DCS "Truck" attribute.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).NAVAL_AIRCRAFTCARRIER" ><strong>WAREHOUSE.Attribute.NAVAL_AIRCRAFTCARRIER</strong></a>
|
|
|
|
<p>Aircraft carrier.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).NAVAL_ARMEDSHIP" ><strong>WAREHOUSE.Attribute.NAVAL_ARMEDSHIP</strong></a>
|
|
|
|
<p>Any armed ship that is not an aircraft carrier, a cruiser, destroyer, firgatte or corvette.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).NAVAL_OTHER" ><strong>WAREHOUSE.Attribute.NAVAL_OTHER</strong></a>
|
|
|
|
<p>Any naval unit that does not fall into any other naval category.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).NAVAL_UNARMEDSHIP" ><strong>WAREHOUSE.Attribute.NAVAL_UNARMEDSHIP</strong></a>
|
|
|
|
<p>Any unarmed naval vessel.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).NAVAL_WARSHIP" ><strong>WAREHOUSE.Attribute.NAVAL_WARSHIP</strong></a>
|
|
|
|
<p>War ship, i.e. cruisers, destroyers, firgates and corvettes.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Attribute).OTHER_UNKNOWN" ><strong>WAREHOUSE.Attribute.OTHER_UNKNOWN</strong></a>
|
|
|
|
<p>Anything that does not fall into any other category.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.Descriptor')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Descriptor)">Type <strong>WAREHOUSE.Descriptor</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Descriptor" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Descriptors enumerator describing the type of the asset.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).ASSETLIST" ><strong>WAREHOUSE.Descriptor.ASSETLIST</strong></a>
|
|
|
|
<p>List of specific assets gives as a table of assets. Mind the curly brackets {}.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).ASSIGNMENT" ><strong>WAREHOUSE.Descriptor.ASSIGNMENT</strong></a>
|
|
|
|
<p>Assignment of asset when it was added.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).ATTRIBUTE" ><strong>WAREHOUSE.Descriptor.ATTRIBUTE</strong></a>
|
|
|
|
<p>Generalized attribute <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).CATEGORY" ><strong>WAREHOUSE.Descriptor.CATEGORY</strong></a>
|
|
|
|
<p>Asset category of type DCS#Group.Category, i.e. GROUND, AIRPLANE, HELICOPTER, SHIP, TRAIN.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).GROUPNAME" ><strong>WAREHOUSE.Descriptor.GROUPNAME</strong></a>
|
|
|
|
<p>Name of the asset template.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Descriptor).UNITTYPE" ><strong>WAREHOUSE.Descriptor.UNITTYPE</strong></a>
|
|
|
|
<p>Typename of the DCS unit, e.g. "A-10C".</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.Pendingitem')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Pendingitem)">Type <strong>WAREHOUSE.Pendingitem</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Pendingitem" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Item of the warehouse pending queue table.</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="#(WAREHOUSE.Pendingitem).assetproblem" ><strong>WAREHOUSE.Pendingitem.assetproblem</strong></a>
|
|
|
|
<p>Table with assets that might have problems (damage or stuck).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<a id="#(WAREHOUSE.Pendingitem).cargogroupset" ><strong>WAREHOUSE.Pendingitem.cargogroupset</strong></a>
|
|
|
|
<p>Set of cargo groups do be delivered.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Pendingitem).carriercargo" ><strong>WAREHOUSE.Pendingitem.carriercargo</strong></a>
|
|
|
|
<p>Table holding the cargo groups of each carrier unit.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Pendingitem).lowfuel" ><strong>WAREHOUSE.Pendingitem.lowfuel</strong></a>
|
|
|
|
<p>If true, at least one asset group is low on fuel.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Pendingitem).ndelivered" ><strong>WAREHOUSE.Pendingitem.ndelivered</strong></a>
|
|
|
|
<p>Number of groups delivered to destination.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Pendingitem).ntransporthome" ><strong>WAREHOUSE.Pendingitem.ntransporthome</strong></a>
|
|
|
|
<p>Number of transports back home.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Pendingitem).timestamp" ><strong>WAREHOUSE.Pendingitem.timestamp</strong></a>
|
|
|
|
<p>Absolute mission time in seconds when the request was processed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_CARGO)">Core.Set#SET_CARGO</a>
|
|
<a id="#(WAREHOUSE.Pendingitem).transportcargoset" ><strong>WAREHOUSE.Pendingitem.transportcargoset</strong></a>
|
|
|
|
<p>Set of cargo objects.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a>
|
|
<a id="#(WAREHOUSE.Pendingitem).transportgroupset" ><strong>WAREHOUSE.Pendingitem.transportgroupset</strong></a>
|
|
|
|
<p>Set of cargo transport carrier groups.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.Quantity')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Quantity)">Type <strong>WAREHOUSE.Quantity</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Quantity" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Warehouse quantity enumerator for selecting number of assets, e.g.</p>
|
|
|
|
|
|
<p>all, half etc. of what is in stock rather than an absolute number.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Quantity).ALL" ><strong>WAREHOUSE.Quantity.ALL</strong></a>
|
|
|
|
<p>All "all" assets currently in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Quantity).HALF" ><strong>WAREHOUSE.Quantity.HALF</strong></a>
|
|
|
|
<p>Half "1/2" of assets in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Quantity).QUARTER" ><strong>WAREHOUSE.Quantity.QUARTER</strong></a>
|
|
|
|
<p>One quarter "1/4" of assets in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Quantity).THIRD" ><strong>WAREHOUSE.Quantity.THIRD</strong></a>
|
|
|
|
<p>One third "1/3" of assets in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Quantity).THREEQUARTERS" ><strong>WAREHOUSE.Quantity.THREEQUARTERS</strong></a>
|
|
|
|
<p>Three quarters "3/4" of assets in stock.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.Queueitem')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.Queueitem)">Type <strong>WAREHOUSE.Queueitem</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.Queueitem" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Item of the warehouse queue table.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="Wrapper.Airbase.html##(AIRBASE)">Wrapper.Airbase#AIRBASE</a>
|
|
<a id="#(WAREHOUSE.Queueitem).airbase" ><strong>WAREHOUSE.Queueitem.airbase</strong></a>
|
|
|
|
<p>The airbase beloning to requesting warehouse if any.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.Descriptor)">#WAREHOUSE.Descriptor</a>
|
|
<a id="#(WAREHOUSE.Queueitem).assetdesc" ><strong>WAREHOUSE.Queueitem.assetdesc</strong></a>
|
|
|
|
<p>Descriptor of the requested asset. Enumerator of type <a href="##(WAREHOUSE).Descriptor">WAREHOUSE.Descriptor</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Queueitem).assetproblem" ><strong>WAREHOUSE.Queueitem.assetproblem</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Init problem table.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Queueitem).assets" ><strong>WAREHOUSE.Queueitem.assets</strong></a>
|
|
|
|
<p>Table of self propelled (or cargo) and transport assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a> and can be accessed by their asset ID.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.Queueitem).assignment" ><strong>WAREHOUSE.Queueitem.assignment</strong></a>
|
|
|
|
<p>A keyword or text that later be used to identify this request and postprocess the assets.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Queueitem).cargoassets" ><strong>WAREHOUSE.Queueitem.cargoassets</strong></a>
|
|
|
|
<p>Table of cargo (or self propelled) assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).cargoattribute" ><strong>WAREHOUSE.Queueitem.cargoattribute</strong></a>
|
|
|
|
<p>Attribute of cargo assets of type <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).cargocategory" ><strong>WAREHOUSE.Queueitem.cargocategory</strong></a>
|
|
|
|
<p>Category of cargo assets of type <a href="##(WAREHOUSE).Category">WAREHOUSE.Category</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="DCS.html##(Airbase.Category)">DCS#Airbase.Category</a>
|
|
<a id="#(WAREHOUSE.Queueitem).category" ><strong>WAREHOUSE.Queueitem.category</strong></a>
|
|
|
|
<p>Category of the requesting airbase, i.e. airdrome, helipad/farp or ship.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Queueitem).lateActivation" ><strong>WAREHOUSE.Queueitem.lateActivation</strong></a>
|
|
|
|
<p>Assets are spawned in late activated state.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).nasset" ><strong>WAREHOUSE.Queueitem.nasset</strong></a>
|
|
|
|
<p>Number of asset groups requested.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).ntransport" ><strong>WAREHOUSE.Queueitem.ntransport</strong></a>
|
|
|
|
<p>Max. number of transport units requested.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).prio" ><strong>WAREHOUSE.Queueitem.prio</strong></a>
|
|
|
|
<p>Priority of the request. Number between 1 (high) and 100 (low).</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
|
|
<a id="#(WAREHOUSE.Queueitem).timestamp" ><strong>WAREHOUSE.Queueitem.timestamp</strong></a>
|
|
|
|
|
|
|
|
|
|
<p> Set time stamp.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#boolean
|
|
<a id="#(WAREHOUSE.Queueitem).toself" ><strong>WAREHOUSE.Queueitem.toself</strong></a>
|
|
|
|
<p>Self request, i.e. warehouse requests assets from itself.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(WAREHOUSE.Queueitem).transportassets" ><strong>WAREHOUSE.Queueitem.transportassets</strong></a>
|
|
|
|
<p>Table of transport carrier assets. Each element of the table is a <a href="##(WAREHOUSE).Assetitem">WAREHOUSE.Assetitem</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).transportattribute" ><strong>WAREHOUSE.Queueitem.transportattribute</strong></a>
|
|
|
|
<p>Attribute of transport assets of type <a href="##(WAREHOUSE).Attribute">WAREHOUSE.Attribute</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).transportcategory" ><strong>WAREHOUSE.Queueitem.transportcategory</strong></a>
|
|
|
|
<p>Category of transport assets of type <a href="##(WAREHOUSE).Category">WAREHOUSE.Category</a>.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE.TransportType)">#WAREHOUSE.TransportType</a>
|
|
<a id="#(WAREHOUSE.Queueitem).transporttype" ><strong>WAREHOUSE.Queueitem.transporttype</strong></a>
|
|
|
|
<p>Transport unit type.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(WAREHOUSE.Queueitem).uid" ><strong>WAREHOUSE.Queueitem.uid</strong></a>
|
|
|
|
<p>Unique id of the queue item.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
<a href="##(WAREHOUSE)">#WAREHOUSE</a>
|
|
<a id="#(WAREHOUSE.Queueitem).warehouse" ><strong>WAREHOUSE.Queueitem.warehouse</strong></a>
|
|
|
|
<p>Requesting warehouse.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##WAREHOUSE.TransportType')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(WAREHOUSE.TransportType)">Type <strong>WAREHOUSE.TransportType</strong></a></h2></div>
|
|
<div id= "#Types##WAREHOUSE.TransportType" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Cargo transport type.</p>
|
|
|
|
|
|
<p>Defines how assets are transported to their destination.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).AIRCRAFTCARRIER" ><strong>WAREHOUSE.TransportType.AIRCRAFTCARRIER</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).AIRPLANE" ><strong>WAREHOUSE.TransportType.AIRPLANE</strong></a>
|
|
|
|
<p>Transports are carried out by airplanes.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).APC" ><strong>WAREHOUSE.TransportType.APC</strong></a>
|
|
|
|
<p>Transports are conducted by APCs.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).ARMEDSHIP" ><strong>WAREHOUSE.TransportType.ARMEDSHIP</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).HELICOPTER" ><strong>WAREHOUSE.TransportType.HELICOPTER</strong></a>
|
|
|
|
<p>Transports are carried out by helicopters.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).SELFPROPELLED" ><strong>WAREHOUSE.TransportType.SELFPROPELLED</strong></a>
|
|
|
|
<p>Assets go to their destination by themselves. No transport carrier needed.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).SHIP" ><strong>WAREHOUSE.TransportType.SHIP</strong></a>
|
|
|
|
<p>Transports are conducted by ships. Not implemented yet.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).TRAIN" ><strong>WAREHOUSE.TransportType.TRAIN</strong></a>
|
|
|
|
<p>Transports are conducted by trains. Not implemented yet. Also trains are buggy in DCS.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#string
|
|
<a id="#(WAREHOUSE.TransportType).WARSHIP" ><strong>WAREHOUSE.TransportType.WARSHIP</strong></a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="functions w3-container w3-theme-l2">
|
|
<h2>Function(s)</h2>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div onclick="myFunction('#Types##_WAREHOUSEDB')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(_WAREHOUSEDB)">Type <strong>_WAREHOUSEDB</strong></a></h2></div>
|
|
<div id= "#Types##_WAREHOUSEDB" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
|
<div class="w3-white" id="record_type">
|
|
|
|
<p>Warehouse database.</p>
|
|
|
|
|
|
<p>Note that this is a global array to have easier exchange between warehouses.</p>
|
|
|
|
<div class="fields w3-container w3-theme-l2">
|
|
<h2>Field(s)</h2>
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(_WAREHOUSEDB).AssetID" ><strong>_WAREHOUSEDB.AssetID</strong></a>
|
|
|
|
<p>Unique ID of each asset. This is a running number, which is increased each time a new asset is added.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(_WAREHOUSEDB).Assets" ><strong>_WAREHOUSEDB.Assets</strong></a>
|
|
|
|
<p>Table holding registered assets, which are of type <a href="Functional.Warehouse.html##(WAREHOUSE).Assetitem">Functional.Warehouse#WAREHOUSE.Assetitem</a>.#</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#number
|
|
<a id="#(_WAREHOUSEDB).WarehouseID" ><strong>_WAREHOUSEDB.WarehouseID</strong></a>
|
|
|
|
<p>Unique ID of the warehouse. Running number.</p>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div>
|
|
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
|
|
|
#table
|
|
<a id="#(_WAREHOUSEDB).Warehouses" ><strong>_WAREHOUSEDB.Warehouses</strong></a>
|
|
|
|
<p>Table holding all defined <a href="##(WAREHOUSE)">#WAREHOUSE</a> objects by their unique ids.</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/Warehouse.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>
|