<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html> <head> <!-- Global site tag (gtag.js) - Google Analytics --> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-97385487-1"></script> <script>window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('config', 'UA-97385487-1');</script> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.13/css/all.css" integrity="sha384-DNOHZ68U8hZfKXOrtjWvjxusGo9WQnrNx2sqG0tfsghAvtVlRW3tvkXWZh58N9jp" crossorigin="anonymous"> <link rel="stylesheet" href="https://www.w3schools.com/lib/w3-theme-indigo.css"> <link rel="stylesheet" href="../Highlight/styles/github.css"> <script src="../Highlight/highlight.pack.js"></script> <script>hljs.initHighlightingOnLoad();</script> <link rel="stylesheet" href="w3.css" type="text/css"/> <meta http-equiv="Content-Type" content="text/html;charset=utf-8"> <style> .picturebox { height:100px; } </style> </head> <body onload="myLoadFunction()" > <div id="myHeader" class="w3-container sticky w3-border-white w3-bottombar" style="background-image:url('../Images/MOOSE.JPG');"> <h1> <i class="fa fa-bars w3-text-white fa-2x" onclick="w3_open()"></i> </h1> </div> <div id="main"> <nav class="w3-sidenav w3-theme-l5 w3-animate-left" style="display:none"> <a href="javascript:void(0)" onclick="w3_close()" class="w3-closenav w3-large">Close ×</a> <div class="w3-row"> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Combat_Air_Patrol.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Cap.html">AI.AI_A2A_Cap</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of Combat Air Patrol (CAP) for airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Air_Dispatching.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Dispatcher.html">AI.AI_A2A_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Manages the process of an automatic A2A defense system based on an EWR network targets and coordinating CAP and GCI.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Ground_Control_Intercept.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Gci.html">AI.AI_A2A_Gci</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of Ground Controlled Interception (GCI) for airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_Patrolling.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2A_Patrol.html">AI.AI_A2A_Patrol</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of air patrol of airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_BAI.html">AI.AI_A2G_BAI</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of air to ground BAI engagement for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_CAS.html">AI.AI_A2G_CAS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of air to ground engagement for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Dispatching.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_Dispatcher.html">AI.AI_A2G_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Create an automated A2G defense system with reconnaissance units, coordinating SEAD, BAI and CAS operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_A2G_SEAD.html">AI.AI_A2G_SEAD</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of air to ground SEAD engagement for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air.html">AI.AI_Air</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of AI air operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Dispatching.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Dispatcher.html">AI.AI_Air_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Create an automated AIR defense system with reconnaissance units, coordinating SEAD, BAI and CAP operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Engage.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Engage.html">AI.AI_Air_Engage</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of air to ground engagement for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_To_Ground_Patrol.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Patrol.html">AI.AI_Air_Patrol</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the process of A2G patrolling and engaging ground targets for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Air_Squadron.html">AI.AI_Air_Squadron</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models squadrons for airplanes and helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Battlefield_Air_Interdiction.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_BAI.html">AI.AI_BAI</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Peform Battlefield Area Interdiction (BAI) within an engagement zone.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Balancing.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Balancer.html">AI.AI_Balancer</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Balance player slots with AI to create an engaging simulation environment, independent of the amount of players.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Combat_Air_Patrol.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_CAP.html">AI.AI_CAP</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Perform Combat Air Patrolling (CAP) for airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Close_Air_Support.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_CAS.html">AI.AI_CAS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Perform Close Air Support (CAS) near friendlies.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo.html">AI.AI_Cargo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_APC.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_APC.html">AI.AI_Cargo_APC</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of cargo using ground vehicles.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_Airplanes.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Airplane.html">AI.AI_Cargo_Airplane</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of cargo using airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher.html">AI.AI_Cargo_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_APC.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_APC.html">AI.AI_Cargo_Dispatcher_APC</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using APCs.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_Airplanes.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Airplane.html">AI.AI_Cargo_Dispatcher_Airplane</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using Planes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_Helicopters.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Helicopter.html">AI.AI_Cargo_Dispatcher_Helicopter</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using Helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Dispatcher_Ship.html">AI.AI_Cargo_Dispatcher_Ship</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo using Ships.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatching_For_Helicopters.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Helicopter.html">AI.AI_Cargo_Helicopter</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of cargo using helicopters.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Cargo_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Cargo_Ship.html">AI.AI_Cargo_Ship</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the intelligent transportation of infantry and other cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Escorting.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort.html">AI.AI_Escort</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Taking the lead of AI escorting your flight or of other AI.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Dispatcher.html">AI.AI_Escort_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the automatic assignment of AI escorts to player flights.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Dispatcher_Request.html">AI.AI_Escort_Dispatcher_Request</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Models the assignment of AI escorts to player flights upon request using the radio menu.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Escorting.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Escort_Request.html">AI.AI_Escort_Request</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Taking the lead of AI escorting your flight or of other AI, upon request using the menu.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Large_Formations.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Formation.html">AI.AI_Formation</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Build large airborne formations of aircraft.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Air_Patrolling.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="AI.AI_Patrol.html">AI.AI_Patrol</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>AI</strong> - Perform Air Patrolling for airplanes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Account.html">Actions.Act_Account</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Actions</strong> - ACT_ACCOUNT_ classes <strong>account for</strong> (detect, count & report) various DCS events occurring on UNITs.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Assign.html">Actions.Act_Assign</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p>(SP) (MP) (FSM) Accept or reject process for player (task) assignments.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Assist.html">Actions.Act_Assist</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Actions.Act_Route.html">Actions.Act_Route</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p>(SP) (MP) (FSM) Route AI or players through waypoints or to zones.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.Cargo.html">Cargo.Cargo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Cargo</strong> - Management of CARGO logistics, that can be transported from and to transportation carriers.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo_Crates.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoCrate.html">Cargo.CargoCrate</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Cargo</strong> - Management of single cargo crates, which are based on a STATIC object.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo_Groups.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoGroup.html">Cargo.CargoGroup</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Cargo</strong> - Management of grouped cargo logistics, which are based on a GROUP object.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo_Slingload.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoSlingload.html">Cargo.CargoSlingload</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Cargo</strong> - Management of single cargo crates, which are based on a STATIC object.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Cargo_Units.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Cargo.CargoUnit.html">Cargo.CargoUnit</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Cargo</strong> - Management of single cargo logistics, which are based on a UNIT object.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/CORE_Astar.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Astar.html">Core.Astar</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - A* Pathfinding.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Base.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Base.html">Core.Base</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - The base class within the framework.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Radio.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Beacon.html">Core.Beacon</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - TACAN and other beacons.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Menu.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ClientMenu.html">Core.ClientMenu</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Client Menu Management.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Condition.html">Core.Condition</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Define any or all conditions to be evaluated.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Database.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Database.html">Core.Database</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Manages several databases containing templates, mission objects, and mission information.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Event.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Event.html">Core.Event</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Models DCS event dispatching using a publish-subscribe model.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Finite_State_Machine.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Fsm.html">Core.Fsm</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - FSM (Finite State Machine) are objects that model and control long lasting business processes and workflow.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Goal.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Goal.html">Core.Goal</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Models the process to achieve goal(s).</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE_Core.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.MarkerOps_Base.html">Core.MarkerOps_Base</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Tap into markers added to the F10 map by users.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Menu.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Menu.html">Core.Menu</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Manage hierarchical menu structures and commands for players within a mission.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Message.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Message.html">Core.Message</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Informs the players using messages during a simulation.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/CORE_Pathline.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Pathline.html">Core.Pathline</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Path from A to B.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Coordinate.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Point.html">Core.Point</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Defines an extensive API to manage 3D points in the DCS World 3D simulation space.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Report.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Report.html">Core.Report</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Provides a handy means to create messages and reports.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Schedule_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.ScheduleDispatcher.html">Core.ScheduleDispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <ul> <li><strong>Core</strong> - SCHEDULEDISPATCHER dispatches the different schedules.</li> </ul> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Scheduler.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Scheduler.html">Core.Scheduler</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Prepares and handles the execution of functions over scheduled time (intervals).</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Sets.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Set.html">Core.Set</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Define collections of objects to perform bulk actions and logically group objects.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Settings.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Settings.html">Core.Settings</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Manages various settings for missions, providing a menu for players to tweak settings in running missions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Spawn.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spawn.html">Core.Spawn</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Spawn dynamically new groups of units in running missions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Spawnstatic.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.SpawnStatic.html">Core.SpawnStatic</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Spawn statics.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Spot.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Spot.html">Core.Spot</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Management of spotting logistics, that can be activated and deactivated upon command.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.TextAndSound.html">Core.TextAndSound</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - A Moose GetText system.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Scheduler.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Timer.html">Core.Timer</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Timer scheduler.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Userflag.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.UserFlag.html">Core.UserFlag</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Manage user flags to interact with the mission editor trigger system and server side scripts.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Velocity.html">Core.Velocity</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Models a velocity or speed, which can be expressed in various formats according the settings.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Zones.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone.html">Core.Zone</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Define zones within your mission of various forms, with various capabilities.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Core.Zone_Detection.html">Core.Zone_Detection</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - The ZONE_DETECTION class, defined by a zone name, a detection object and a radius.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="DCS.html">DCS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>DCS API</strong> Prototypes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AICSAR.html">Functional.AICSAR</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - AI CSAR system.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Air_Traffic_Control_Ground_Operations.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ATC_Ground.html">Functional.ATC_Ground</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Monitor airbase traffic and regulate speed while taxiing.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Artillery.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.AmmoTruck.html">Functional.AmmoTruck</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> -- Send a truck to supply artillery groups.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Artillery.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Artillery.html">Functional.Artillery</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Control artillery units.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Designation.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Autolase.html">Functional.Autolase</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Autolase targets in the field.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/CleanUp_Airbases.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.CleanUp.html">Functional.CleanUp</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Keep airbases clean of crashing or colliding airplanes, and kill missiles when being fired at airbases.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/clientwatch.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ClientWatch.html">Functional.ClientWatch</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Manage and track client slots easily to add your own client-based menus and modules to.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Designation.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Designate.html">Functional.Designate</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Management of target <strong>Designation</strong>.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Detection.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Detection.html">Functional.Detection</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Models the detection of enemy units by FACs or RECCEs and group them according various methods.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.DetectionZones.html">Functional.DetectionZones</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Captures the class DETECTION_ZONES.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Escorting.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Escort.html">Functional.Escort</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Taking the lead of AI escorting your flight.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Functional_FOX.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Fox.html">Functional.Fox</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Yet Another Missile Trainer.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Functional.Mantis.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Mantis.html">Functional.Mantis</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Modular, Automatic and Network capable Targeting and Interception System for Air Defenses.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Missile_Trainer.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.MissileTrainer.html">Functional.MissileTrainer</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Train missile defence and deflection.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Movement.html">Functional.Movement</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Limit the movement of simulaneous moving ground vehicles.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Pseudo_ATC.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.PseudoATC.html">Functional.PseudoATC</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Basic ATC.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/RAT.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.RAT.html">Functional.RAT</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Create random air traffic in your missions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Range.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Range.html">Functional.Range</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Range Practice.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Scoring.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Scoring.html">Functional.Scoring</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Administer the scoring of player achievements, file and log the scoring events for use at websites.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/SEAD.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Sead.html">Functional.Sead</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Make SAM sites evasive and execute defensive behaviour when being fired upon.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Functional.Shorad.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Shorad.html">Functional.Shorad</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Short Range Air Defense System.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Functional.Stratego.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Stratego.html">Functional.Stratego</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Stratego.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Suppression.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Suppression.html">Functional.Suppression</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Suppress fire of ground units when they get hit.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Functional.Tiresias.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Tiresias.html">Functional.Tiresias</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - TIRESIAS - manages AI behaviour.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Warehouse.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.Warehouse.html">Functional.Warehouse</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Simulation of logistic operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Capture_Zones.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneCaptureCoalition.html">Functional.ZoneCaptureCoalition</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Models the process to zone guarding and capturing.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoal.html">Functional.ZoneGoal</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Base class that models processes to achieve goals involving a Zone.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoalCargo.html">Functional.ZoneGoalCargo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional</strong> - Base class that models processes to achieve goals involving a Zone and Cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Functional.ZoneGoalCoalition.html">Functional.ZoneGoalCoalition</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Functional (WIP)</strong> - Base class modeling processes to achieve goals involving coalition zones.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_FlightControl.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="OPS.FlightControl.html">OPS.FlightControl</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>OPS</strong> - Air Traffic Control for AI and human players.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_ATIS.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ATIS.html">Ops.ATIS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_AWACS.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.AWACS.html">Ops.AWACS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - MOOSE AI AWACS Operations using text-to-speech.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Ops_Airboss.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airboss.html">Ops.Airboss</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Manages aircraft CASE X recoveries for carrier operations (X=I, II, III).</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_AirWing.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Airwing.html">Ops.Airwing</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Airwing Warehouse.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_ArmyGroup.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.ArmyGroup.html">Ops.ArmyGroup</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Enhanced Ground Group.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Auftrag.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Auftrag.html">Ops.Auftrag</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Brigade_.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Brigade.html">Ops.Brigade</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Brigade Warehouse.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_CSAR.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CSAR.html">Ops.CSAR</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Combat Search and Rescue.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_CTLD.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.CTLD.html">Ops.CTLD</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Combat Troops & Logistics Department.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Chief.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Chief.html">Ops.Chief</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Chief of Staff.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Cohort.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Cohort.html">Ops.Cohort</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Cohort encompassed all characteristics of SQUADRONs, PLATOONs and FLOTILLAs.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Commander.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Commander.html">Ops.Commander</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Commander of Airwings, Brigades and Fleets.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/AI_Combat_Air_Patrol.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.EasyGCICAP.html">Ops.EasyGCICAP</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <h2>Easy CAP/GCI Class, based on OPS classes</h2> <p>Documentation</p> <p>https://flightcontrol-master.github.io/MOOSE_DOCS_DEVELOP/Documentation/Ops.EasyGCICAP.html</p> <hr/> <p>Date: September 2023</p> <h2>Last Update: July 2024</h2> <ul> <li><strong>Ops</strong> - Easy GCI & CAP Manager</li> </ul> <hr/> <p><strong>Main Features:</strong></p> <ul> <li>Automatically create and manage A2A CAP/GCI defenses using an AirWing and Squadrons for one coalition</li> <li>Easy set-up</li> <li>Add additional AirWings on other airbases</li> <li>Each wing can have more than one Squadron - tasking to Squadrons is done on a random basis per AirWing</li> <li>Create borders and zones of engagement</li> <li>Detection can be ground based and/or via AWACS</li> </ul> <hr/> <h3>AUTHOR: <strong>applevangelist</strong></h3> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Fleet.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Fleet.html">Ops.Fleet</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Fleet Warehouse.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_FlightGroup.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.FlightGroup.html">Ops.FlightGroup</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Enhanced Airborne Group.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Flotilla.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Flotilla.html">Ops.Flotilla</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Flotilla is a small naval group belonging to a fleet.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Intel.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Intel.html">Ops.Intel</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Office of Military Intelligence.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Legion.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Legion.html">Ops.Legion</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Legion Warehouse.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_NavyGroup.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.NavyGroup.html">Ops.NavyGroup</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Enhanced Naval Group.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Operation.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Operation.html">Ops.Operation</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Operation with multiple phases.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_OpsGroup.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsGroup.html">Ops.OpsGroup</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Generic group enhancement.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_OpsTransport.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsTransport.html">Ops.OpsTransport</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Transport assignment for OPS groups and storage.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_OpsZone.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.OpsZone.html">Ops.OpsZone</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Strategic Zone.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Platoon.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Platoon.html">Ops.Platoon</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Brigade Platoon.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Ops_PlayerRecce.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerRecce.html">Ops.PlayerRecce</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Allow a player in a helo like the Gazelle, KA-50 to recon and lase ground targets.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_PlayerTask.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.PlayerTask.html">Ops.PlayerTask</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - PlayerTask (mission) for Players.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Ops_RecoveryTanker.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RecoveryTanker.html">Ops.RecoveryTanker</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Recovery tanker for carrier operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Ops_RescueHelo.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.RescueHelo.html">Ops.RescueHelo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Rescue helicopter for carrier operations.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Squadron.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Squadron.html">Ops.Squadron</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Airwing Squadron.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/OPS_Target.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Ops.Target.html">Ops.Target</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Ops</strong> - Target.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.CUBE.html">Shapes.CUBE</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3> <hr/> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.LINE.html">Shapes.LINE</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3> <hr/> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.OVAL.html">Shapes.OVAL</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3> <hr/> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.POLYGON.html">Shapes.POLYGON</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3> <hr/> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/CORE_Pathline.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.SHAPE_BASE.html">Shapes.SHAPE_BASE</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Shapes</strong> - Class that serves as the base shapes drawn in the Mission Editor</p> <h3>Author: <strong>nielsvaes/coconutcockpit</strong></h3> <hr/> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Shapes.TRIANGLE.html">Shapes.TRIANGLE</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p>TRIANGLE class with properties and methods for handling triangles.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Radio.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.Radio.html">Sound.Radio</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Sound</strong> - Radio transmissions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Radio.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioQueue.html">Sound.RadioQueue</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Sound</strong> - Queues Radio Transmissions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Radio.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.RadioSpeech.html">Sound.RadioSpeech</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Core</strong> - Makes the radio talk.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Sound_MSRS.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SRS.html">Sound.SRS</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Sound</strong> - Simple Radio Standalone (SRS) Integration and Text-to-Speech.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Sound_SoundOutput.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.SoundOutput.html">Sound.SoundOutput</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Sound</strong> - Sound output classes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Core_Usersound.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Sound.UserSound.html">Sound.UserSound</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Sound</strong> - Manage user sound.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Command_Center.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.CommandCenter.html">Tasking.CommandCenter</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - A command center governs multiple missions, and takes care of the reporting and communications.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Detection_Manager.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.DetectionManager.html">Tasking.DetectionManager</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - This module contains the DETECTION_MANAGER class and derived classes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Mission.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Mission.html">Tasking.Mission</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - A mission models a goal to be achieved through the execution and completion of tasks by human players.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task.html">Tasking.Task</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - A task object governs the main engine to administer human taskings.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.TaskInfo.html">Tasking.TaskInfo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Controls the information of a Task.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2A.html">Tasking.Task_A2A</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - The TASK_A2A models tasks for players in Air to Air engagements.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_A2A_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2A_Dispatcher.html">Tasking.Task_A2A_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Dynamically allocates A2A tasks to human players, based on detected airborne targets through an EWR network.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2G.html">Tasking.Task_A2G</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - The TASK_A2G models tasks for players in Air to Ground engagements.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_A2G_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_A2G_Dispatcher.html">Tasking.Task_A2G_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Dynamically allocates A2G tasks to human players, based on detected ground targets through reconnaissance.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_CARGO.html">Tasking.Task_CARGO</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Base class to model tasks for players to transport cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Capture_Dispatcher.html">Tasking.Task_Capture_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Creates and manages player TASK_ZONE_CAPTURE tasks.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Capture_Zone.html">Tasking.Task_Capture_Zone</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - The TASK_Protect models tasks for players to protect or capture specific zones.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Cargo_CSAR.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_CSAR.html">Tasking.Task_Cargo_CSAR</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Orchestrates the task for players to execute CSAR for downed pilots.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Cargo_Dispatcher.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_Dispatcher.html">Tasking.Task_Cargo_Dispatcher</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Creates and manages player TASK_CARGO tasks.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Task_Cargo_Transport.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Cargo_Transport.html">Tasking.Task_Cargo_Transport</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - Models tasks for players to transport cargo.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Tasking.Task_Manager.html">Tasking.Task_Manager</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Tasking</strong> - This module contains the TASK_MANAGER class and derived classes.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Enums.html">Utilities.Enums</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Utilities</strong> Enumerators.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.FiFo.html">Utilities.FiFo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p> <strong>UTILS</strong> - Classic FiFo Stack.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Utils_Profiler.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Profiler.html">Utilities.Profiler</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Utils</strong> - Lua Profiler.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Socket.html">Utilities.Socket</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Utilities</strong> - Socket.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Utilities.Utils.html">Utilities.Utils</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Utilities</strong> - Derived utilities taken from the MIST framework, added helpers from the MOOSE community.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Airbase.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Airbase.html">Wrapper.Airbase</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - AIRBASE is a wrapper class to handle the DCS Airbase objects.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Client.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Client.html">Wrapper.Client</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - CLIENT wraps DCS Unit objects acting as a <strong>Client</strong> or <strong>Player</strong> within a mission.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Controllable.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Controllable.html">Wrapper.Controllable</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - CONTROLLABLE is an intermediate class wrapping Group and Unit classes "controllers".</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Storage.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.DynamicCargo.html">Wrapper.DynamicCargo</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - Dynamic Cargo create from the F8 menu.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Group.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Group.html">Wrapper.Group</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - GROUP wraps the DCS Class Group objects.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Identifiable.html">Wrapper.Identifiable</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - IDENTIFIABLE is an intermediate class wrapping DCS Object class derived Objects.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE_Core.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Marker.html">Wrapper.Marker</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - Markers On the F10 map.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Utils_Profiler.jpg" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Net.html">Wrapper.Net</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - DCS net functions.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/MOOSE.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Object.html">Wrapper.Object</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - OBJECT wraps the DCS Object derived objects.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Positionable.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Positionable.html">Wrapper.Positionable</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - POSITIONABLE wraps DCS classes that are "positionable".</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Scenery.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Scenery.html">Wrapper.Scenery</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - SCENERY models scenery within the DCS simulator.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Static.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Static.html">Wrapper.Static</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - STATIC wraps the DCS StaticObject class.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Storage.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Storage.html">Wrapper.Storage</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - Warehouse storage of DCS airbases.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Unit.JPG" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Unit.html">Wrapper.Unit</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - UNIT is a wrapper class for the DCS Class Unit.</p> </p></div> </div> </div> <div class="w3-col s12 m6 l4"> <div class="w3-card-4 w3-white w3-margin-16"> <div class="w3-display-container w3-text-white w3-text-shadow"> <img src= "../Images/Wrapper_Weapon.png" alt="Image"> <div class="w3-display-bottommiddle" style="word-break:break-word;"><h2><strong><a href="Wrapper.Weapon.html">Wrapper.Weapon</a></strong></h2></div> </div> <div class="w3-container w3-padding w3-white picturebox" style="word-break:break-word;"><p> <p><strong>Wrapper</strong> - Weapon functions.</p> </p></div> </div> </div> </div> </nav> <img src="..\Images\OPS_Brigade_.png" alt="Banner Image"/> <div id="content"> <div class="w3-container w3-theme-d5" id="module_title"> <h1>Module <strong>Ops.Brigade</strong></h1> </div> <div class="w3-container w3-white" id="module_description"> <p><strong>Ops</strong> - Brigade Warehouse.</p> <p><strong>Main Features:</strong></p> <ul> <li>Manage platoons</li> <li>Carry out ARTY and PATROLZONE missions (AUFTRAG)</li> <li>Define rearming zones</li> </ul> <hr/> <h2>Example Missions:</h2> <p>Demo missions can be found on <a href="https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/develop/Ops/Brigade">github</a>.</p> <hr/> <h3>Author: <strong>funkyfranky</strong></h3> <hr/> </div> <div class="w3-container w3-theme-d2"><h2><strong>Global(s)</strong></h2></div> <div class="w3-theme-d2 w3-margin-top "> <table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##BRIGADE')"> <tr> <td class="style="width:40%;"><p><h2>Global <strong>BRIGADE</strong></h2></p></td> <td class="style="width:60%;"> <p><em>I am not afraid of an Army of lions lead by a sheep; I am afraid of sheep lead by a lion</em> -- Alexander the Great</p> <hr/> <h1>The BRIGADE Concept</h1> <p>A BRIGADE consists of one or multiple PLATOONs.</p> </td> </tr> </table> </div> <div id= "#Globals##BRIGADE" class="w3-container w3-white w3-padding-small"> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="##(BRIGADE)">#BRIGADE</a> <a id="BRIGADE" ><strong>BRIGADE</strong></a> <p><em>I am not afraid of an Army of lions lead by a sheep; I am afraid of sheep lead by a lion</em> -- Alexander the Great</p> <hr/> <h1>The BRIGADE Concept</h1> <p>A BRIGADE consists of one or multiple PLATOONs.</p> <p>These platoons "live" in a WAREHOUSE that has a phyiscal struction (STATIC or UNIT) and can be captured or destroyed.</p> </div> </div> <div class="w3-container w3-theme-l2 w3-margin-top"><h2><strong>Type(s)</strong></h2></div> <div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(BRIGADE)">Type <strong>BRIGADE</strong></a></h2></div> <div class="w3-card-4 w3-padding w3-margin w3-theme-l1"> <strong><a href="##(BRIGADE)">BRIGADE</a></strong> , extends <strong><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></strong> , extends <strong><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></strong> , extends <strong><a href="Core.Fsm.html##(FSM)">Core.Fsm#FSM</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 BRIGADE</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="##(BRIGADE).AddAssetToPlatoon">BRIGADE:AddAssetToPlatoon(Platoon, Nassets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add asset group(s) to platoon.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddPlatoon">BRIGADE:AddPlatoon(Platoon)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add a platoon to the brigade.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddRearmingZone">BRIGADE:AddRearmingZone(RearmingZone)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add a rearming zone.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddRefuellingZone">BRIGADE:AddRefuellingZone(RefuellingZone)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add a refuelling zone.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddRetreatZone">BRIGADE:AddRetreatZone(RetreatZone)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add a retreat zone.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).ArmyOnMission">BRIGADE:ArmyOnMission(ArmyGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "ArmyOnMission".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).ClassName">BRIGADE.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="##(BRIGADE).GetPlatoon">BRIGADE:GetPlatoon(PlatoonName)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get platoon by name.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetPlatoonOfAsset">BRIGADE:GetPlatoonOfAsset(Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get platoon of an asset.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetRetreatZones">BRIGADE:GetRetreatZones()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get retreat zones.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).LoadBackAssetInPosition">BRIGADE:LoadBackAssetInPosition(Templatename, Position)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>[ GROUND ] Function to load back an asset in the field that has been filed before.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).New">BRIGADE:New(WarehouseName, BrigadeName)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Create a new BRIGADE class object.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterArmyOnMission">BRIGADE:OnAfterArmyOnMission(From, Event, To, ArmyGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "ArmyOnMission" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RemoveAssetFromPlatoon">BRIGADE:RemoveAssetFromPlatoon(Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Remove asset from platoon.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).SetRetreatZones">BRIGADE:SetRetreatZones(RetreatZoneSet)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Define a set of retreat zones.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).Start">BRIGADE: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="##(BRIGADE).__ArmyOnMission">BRIGADE:__ArmyOnMission(delay, ArmyGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "ArmyOnMission" 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="##(BRIGADE).__Start">BRIGADE:__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="##(BRIGADE).__Stop">BRIGADE:__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="##(BRIGADE).lid">BRIGADE.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="##(BRIGADE).onafterArmyOnMission">BRIGADE:onafterArmyOnMission(From, Event, To, ArmyGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "ArmyOnMission".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterStart">BRIGADE:onafterStart(From, Event, To)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Start BRIGADE FSM.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterStatus">BRIGADE:onafterStatus(From, Event, To)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Update status.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).rearmingZones">BRIGADE.rearmingZones</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Rearming zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).refuellingZones">BRIGADE.refuellingZones</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Refuelling zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).retreatZones">BRIGADE.retreatZones</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Retreat zone set.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).verbose">BRIGADE.verbose</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Verbosity of output.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).version">BRIGADE.version</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>BRIGADE class version.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).warehouseOpsElement">BRIGADE.warehouseOpsElement</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).warehouseOpsGroup">BRIGADE.warehouseOpsGroup</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> </table> </div> <div class="w3-card w3-margin"> <table class="w3-table w3-border-bottom w3-border-theme-l2"> <tr class="w3-theme-l1"> <th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from LEGION</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="##(BRIGADE).AddCohort">BRIGADE:AddCohort(Cohort)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add cohort to cohort table of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddMission">BRIGADE:AddMission(Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add a mission for the legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AddOpsTransport">BRIGADE:AddOpsTransport(OpsTransport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Add transport assignment to queue. </p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AssignAssetsForEscort">BRIGADE:AssignAssetsForEscort(Cohorts, Assets, NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit and assign assets performing an escort mission for a given asset list.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).AssignAssetsForTransport">BRIGADE:AssignAssetsForTransport(Legions, CargoAssets, NcarriersMin, NcarriersMax, DeployZone, DisembarkZone, Categories, Attributes, Properties)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit and assign assets performing an OPSTRANSPORT for a given asset list.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CalculateAssetMissionScore">BRIGADE.CalculateAssetMissionScore(asset, MissionType, TargetVec2, IncludePayload, TotalWeight)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Calculate the mission score of an asset.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CheckMissionQueue">BRIGADE:CheckMissionQueue()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check mission queue and assign ONE mission.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CheckTransportQueue">BRIGADE:CheckTransportQueue()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check transport queue and assign ONE transport.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).ClassName">BRIGADE.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="##(BRIGADE).CountAssets">BRIGADE:CountAssets(InStock, MissionTypes, Attributes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count total number of assets of the legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CountAssetsOnMission">BRIGADE:CountAssetsOnMission(MissionTypes, Cohort)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count assets on mission.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CountAssetsWithPayloadsInStock">BRIGADE:CountAssetsWithPayloadsInStock(Payloads, MissionTypes, Attributes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count total number of assets in LEGION warehouse stock that also have a payload.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CountMissionsInQueue">BRIGADE:CountMissionsInQueue(MissionTypes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count missions in mission queue.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).CountPayloadsInStock">BRIGADE:CountPayloadsInStock(MissionTypes, UnitTypes, Payloads)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count payloads in stock.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).DelAsset">BRIGADE:DelAsset(Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Remove specific asset from legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).DelCohort">BRIGADE:DelCohort(Cohort)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Remove cohort from cohor table of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).FetchPayloadFromStock">BRIGADE:FetchPayloadFromStock(UnitType, MissionType, Payloads)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Fetch a payload from the airwing resources for a given unit and mission type.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetAircraftTypes">BRIGADE:GetAircraftTypes(onlyactive, cohorts)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get the unit types of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetAssetCurrentMission">BRIGADE:GetAssetCurrentMission(asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get the current mission 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="##(BRIGADE).GetAssetsOnMission">BRIGADE:GetAssetsOnMission(MissionTypes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get assets on mission.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetMissionByID">BRIGADE:GetMissionByID(mid)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Returns the mission for a given mission ID (Autragsnummer).</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetMissionFromRequest">BRIGADE:GetMissionFromRequest(Request)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Returns the mission 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="##(BRIGADE).GetMissionFromRequestID">BRIGADE:GetMissionFromRequestID(RequestID)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Returns the mission for a given request ID.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetName">BRIGADE:GetName()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get name of legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetOpsGroups">BRIGADE:GetOpsGroups(MissionTypes, Attributes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get OPSGROUPs that are spawned and alive.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).GetTransportByID">BRIGADE:GetTransportByID(uid)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Returns the mission for a given ID.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).IsAirwing">BRIGADE:IsAirwing()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check if the AIRWING class is calling.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).IsAssetOnMission">BRIGADE:IsAssetOnMission(asset, MissionTypes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check if an asset is currently on a mission (STARTED or EXECUTING).</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).IsBrigade">BRIGADE:IsBrigade()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check if a BRIGADE class is calling.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).IsCohort">BRIGADE:IsCohort(CohortName)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check if cohort is part of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).IsFleet">BRIGADE:IsFleet()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Check if the FLEET class is calling.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).LegionAssetReturned">BRIGADE:LegionAssetReturned(Cohort, Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "LegionAssetReturned".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).MissionAssign">BRIGADE:MissionAssign(Mission, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionAssign".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).MissionCancel">BRIGADE:MissionCancel(Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionCancel".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).MissionRequest">BRIGADE:MissionRequest(Mission, Assets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionRequest".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).New">BRIGADE:New(WarehouseName, LegionName)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Create a new LEGION class object.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterLegionAssetReturned">BRIGADE:OnAfterLegionAssetReturned(From, Event, To, Cohort, Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "LegionAssetReturned" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterMissionAssign">BRIGADE:OnAfterMissionAssign(From, Event, To, Mission, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionAssign" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterMissionCancel">BRIGADE:OnAfterMissionCancel(From, Event, To, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionCancel" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterMissionRequest">BRIGADE:OnAfterMissionRequest(From, Event, To, Mission, Assets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionRequest" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterOpsOnMission">BRIGADE:OnAfterOpsOnMission(From, Event, To, OpsGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "OpsOnMission" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterTransportAssign">BRIGADE:OnAfterTransportAssign(From, Event, To, Transport, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportAssign" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterTransportCancel">BRIGADE:OnAfterTransportCancel(From, Event, To, Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportCancel" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OnAfterTransportRequest">BRIGADE:OnAfterTransportRequest(From, Event, To, Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportRequest" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).OpsOnMission">BRIGADE:OpsOnMission(OpsGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "OpsOnMission".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RandomAssetScore">BRIGADE.RandomAssetScore</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Random score that is added to the asset score in the selection process.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RecruitAssetsForEscort">BRIGADE:RecruitAssetsForEscort(Mission, Assets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit assets performing an escort mission for a given asset.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RecruitAssetsForMission">BRIGADE:RecruitAssetsForMission(Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit assets for a given mission.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RecruitAssetsForTransport">BRIGADE:RecruitAssetsForTransport(Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit assets for a given OPS transport.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RecruitCohortAssets">BRIGADE.RecruitCohortAssets(Cohorts, MissionTypeRecruit, MissionTypeOpt, NreqMin, NreqMax, TargetVec2, Payloads, RangeMax, RefuelSystem, CargoWeight, TotalWeight, MaxWeight, Categories, Attributes, Properties, WeaponTypes)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit assets from Cohorts 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="##(BRIGADE).RelocateCohort">BRIGADE:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Relocate a cohort to another legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).RemoveMission">BRIGADE:RemoveMission(Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Remove mission from queue.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).ReturnPayloadFromAsset">BRIGADE:ReturnPayloadFromAsset(asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Return payload from asset back to stock.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).SetTacticalOverviewOn">BRIGADE:SetTacticalOverviewOn()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Set tactical overview on.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).SetVerbosity">BRIGADE:SetVerbosity(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="##(BRIGADE).Start">BRIGADE: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="##(BRIGADE).TransportAssign">BRIGADE:TransportAssign(Transport, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportAssign".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).TransportCancel">BRIGADE:TransportCancel(Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportCancel".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).TransportRequest">BRIGADE:TransportRequest(Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportRequest".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).UnRecruitAssets">BRIGADE.UnRecruitAssets(Assets, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Unrecruit assets.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._AddRequest">BRIGADE:_AddRequest(AssetDescriptor, AssetDescriptorValue, nAsset, Prio, Assignment)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Create a request and add it to the warehouse queue.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._CohortCan">BRIGADE._CohortCan(Cohort, MissionType, Categories, Attributes, Properties, WeaponTypes, TargetVec2, RangeMax, RefuelSystem, CargoWeight, MaxWeight)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Recruit assets from Cohorts 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="##(BRIGADE)._CountPayloads">BRIGADE:_CountPayloads(MissionType, Cohorts, Payloads)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Count payloads of all cohorts for all unit types.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._CreateFlightGroup">BRIGADE:_CreateFlightGroup(asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Create a new OPS group after an asset was spawned.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._GetCohort">BRIGADE:_GetCohort(CohortName)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get cohort by name.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._GetCohortOfAsset">BRIGADE:_GetCohortOfAsset(Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get cohort of an asset.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._GetCohorts">BRIGADE._GetCohorts(Legions, Cohorts, Operation, OpsQueue)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Get cohorts.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._OptimizeAssetSelection">BRIGADE._OptimizeAssetSelection(assets, MissionType, TargetVec2, IncludePayload, TotalWeight)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Optimize chosen assets for the mission at hand.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE)._TacticalOverview">BRIGADE:_TacticalOverview()</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Display tactical overview.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).__LegionAssetReturned">BRIGADE:__LegionAssetReturned(delay, Cohort, Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "LegionAssetReturned" 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="##(BRIGADE).__MissionAssign">BRIGADE:__MissionAssign(delay, Mission, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionAssign" 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="##(BRIGADE).__MissionCancel">BRIGADE:__MissionCancel(delay, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionCancel" 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="##(BRIGADE).__MissionRequest">BRIGADE:__MissionRequest(delay, Mission, Assets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "MissionRequest" 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="##(BRIGADE).__OpsOnMission">BRIGADE:__OpsOnMission(delay, OpsGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "OpsOnMission" 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="##(BRIGADE).__Start">BRIGADE:__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="##(BRIGADE).__Stop">BRIGADE:__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="##(BRIGADE).__TransportAssign">BRIGADE:__TransportAssign(delay, Transport, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportAssign" 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="##(BRIGADE).__TransportCancel">BRIGADE:__TransportCancel(delay, Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportCancel" 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="##(BRIGADE).__TransportRequest">BRIGADE:__TransportRequest(delay, Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Triggers the FSM event "TransportRequest" 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="##(BRIGADE).chief">BRIGADE.chief</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Chief of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).cohorts">BRIGADE.cohorts</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Cohorts of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).commander">BRIGADE.commander</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Commander of this legion.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).destbase">BRIGADE.destbase</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).homebase">BRIGADE.homebase</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).homezone">BRIGADE.homezone</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).lid">BRIGADE.lid</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Class id string for output to DCS log file.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).missionqueue">BRIGADE.missionqueue</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Mission queue table.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterAssetDead">BRIGADE: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="##(BRIGADE).onafterAssetSpawned">BRIGADE: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="##(BRIGADE).onafterCaptured">BRIGADE: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="##(BRIGADE).onafterDestroyed">BRIGADE: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="##(BRIGADE).onafterLegionAssetReturned">BRIGADE:onafterLegionAssetReturned(From, Event, To, Cohort, Asset)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "LegionAssetReturned" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterMissionAssign">BRIGADE:onafterMissionAssign(From, Event, To, Mission, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionAssign" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterMissionCancel">BRIGADE:onafterMissionCancel(From, Event, To, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionCancel" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterMissionRequest">BRIGADE:onafterMissionRequest(From, Event, To, Mission, Assets)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "MissionRequest" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterNewAsset">BRIGADE: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="##(BRIGADE).onafterOpsOnMission">BRIGADE:onafterOpsOnMission(From, Event, To, OpsGroup, Mission)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "OpsOnMission".</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterRequest">BRIGADE: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="##(BRIGADE).onafterRequestSpawned">BRIGADE: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="##(BRIGADE).onafterSelfRequest">BRIGADE: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="##(BRIGADE).onafterStart">BRIGADE:onafterStart(From, Event, To)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Start LEGION FSM.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterTransportAssign">BRIGADE:onafterTransportAssign(From, Event, To, Transport, Legions)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportAssign" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterTransportCancel">BRIGADE:onafterTransportCancel(From, Event, To, Transport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportCancel" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).onafterTransportRequest">BRIGADE:onafterTransportRequest(From, Event, To, Opstransport, OpsTransport)</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>On after "TransportRequest" event.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).queueid">BRIGADE.queueid</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).tacview">BRIGADE.tacview</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>If <code>true</code>, show tactical overview on status update.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).transportqueue">BRIGADE.transportqueue</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Transport queue.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).verbose">BRIGADE.verbose</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Verbosity of output.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).version">BRIGADE.version</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>LEGION class version.</p> </td> </tr> </table> </div> <div class="w3-card w3-margin"> <table class="w3-table w3-border-bottom w3-border-theme-l2"> <tr class="w3-theme-l1"> <th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from 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="##(BRIGADE).AddAsset">BRIGADE: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="##(BRIGADE).AddOffRoadPath">BRIGADE: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="##(BRIGADE).AddRequest">BRIGADE: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="##(BRIGADE).AddShippingLane">BRIGADE: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="##(BRIGADE).AirbaseCaptured">BRIGADE: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="##(BRIGADE).AirbaseRecaptured">BRIGADE: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="##(BRIGADE).Arrived">BRIGADE: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="##(BRIGADE).AssetDead">BRIGADE: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="##(BRIGADE).AssetLowFuel">BRIGADE: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="##(BRIGADE).AssetSpawned">BRIGADE: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="##(BRIGADE).Attacked">BRIGADE: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="##(BRIGADE).Attribute">BRIGADE.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="##(BRIGADE).Captured">BRIGADE: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="##(BRIGADE).ChangeCountry">BRIGADE: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="##(BRIGADE).ClassName">BRIGADE.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="##(BRIGADE).Debug">BRIGADE.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="##(BRIGADE).Defeated">BRIGADE: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="##(BRIGADE).Delivered">BRIGADE: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="##(BRIGADE).Descriptor">BRIGADE.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="##(BRIGADE).Destroyed">BRIGADE: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="##(BRIGADE).FilterStock">BRIGADE: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="##(BRIGADE).FindAssetInDB">BRIGADE: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="##(BRIGADE).FindNearestWarehouse">BRIGADE: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="##(BRIGADE).FindWarehouseInDB">BRIGADE: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="##(BRIGADE).GetAirbase">BRIGADE: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="##(BRIGADE).GetAirbaseCategory">BRIGADE: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="##(BRIGADE).GetAirbaseName">BRIGADE: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="##(BRIGADE).GetAssetByID">BRIGADE: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="##(BRIGADE).GetAssetByName">BRIGADE: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="##(BRIGADE).GetAssignment">BRIGADE: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="##(BRIGADE).GetCoalition">BRIGADE: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="##(BRIGADE).GetCoalitionName">BRIGADE: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="##(BRIGADE).GetCoordinate">BRIGADE: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="##(BRIGADE).GetCountry">BRIGADE: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="##(BRIGADE).GetCountryName">BRIGADE: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="##(BRIGADE).GetNumberOfAssets">BRIGADE: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="##(BRIGADE).GetRequestByID">BRIGADE: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="##(BRIGADE).GetRunwayRepairtime">BRIGADE: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="##(BRIGADE).GetSpawnZone">BRIGADE: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="##(BRIGADE).GetStockInfo">BRIGADE: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="##(BRIGADE).GetVec2">BRIGADE: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="##(BRIGADE).GetVec3">BRIGADE: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="##(BRIGADE).GetWarehouseZone">BRIGADE: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="##(BRIGADE).HasConnectionNaval">BRIGADE: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="##(BRIGADE).HasConnectionOffRoad">BRIGADE: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="##(BRIGADE).HasConnectionRail">BRIGADE: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="##(BRIGADE).HasConnectionRoad">BRIGADE: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="##(BRIGADE).IsAttacked">BRIGADE: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="##(BRIGADE).IsDestroyed">BRIGADE: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="##(BRIGADE).IsLoaded">BRIGADE: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="##(BRIGADE).IsNotReadyYet">BRIGADE: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="##(BRIGADE).IsPaused">BRIGADE: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="##(BRIGADE).IsRunning">BRIGADE: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="##(BRIGADE).IsRunwayOperational">BRIGADE: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="##(BRIGADE).IsShip">BRIGADE: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="##(BRIGADE).IsStatic">BRIGADE: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="##(BRIGADE).IsStopped">BRIGADE: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="##(BRIGADE).IsUnit">BRIGADE: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="##(BRIGADE).Load">BRIGADE: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="##(BRIGADE).New">BRIGADE: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="##(BRIGADE).NewAsset">BRIGADE: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="##(BRIGADE).OnAfterAirbaseCaptured">BRIGADE: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="##(BRIGADE).OnAfterAirbaseRecaptured">BRIGADE: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="##(BRIGADE).OnAfterArrived">BRIGADE: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="##(BRIGADE).OnAfterAssetDead">BRIGADE: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="##(BRIGADE).OnAfterAssetLowFuel">BRIGADE: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="##(BRIGADE).OnAfterAssetSpawned">BRIGADE: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="##(BRIGADE).OnAfterAttacked">BRIGADE: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="##(BRIGADE).OnAfterCaptured">BRIGADE: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="##(BRIGADE).OnAfterChangeCountry">BRIGADE: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="##(BRIGADE).OnAfterDefeate">BRIGADE: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="##(BRIGADE).OnAfterDelivered">BRIGADE: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="##(BRIGADE).OnAfterDestroyed">BRIGADE: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="##(BRIGADE).OnAfterLoad">BRIGADE: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="##(BRIGADE).OnAfterNewAsset">BRIGADE: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="##(BRIGADE).OnAfterRequest">BRIGADE: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="##(BRIGADE).OnAfterRespawn">BRIGADE: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="##(BRIGADE).OnAfterSave">BRIGADE: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="##(BRIGADE).OnAfterSelfRequest">BRIGADE: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="##(BRIGADE).OnBeforeRequest">BRIGADE: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="##(BRIGADE).Pause">BRIGADE: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="##(BRIGADE).Quantity">BRIGADE.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="##(BRIGADE).Report">BRIGADE.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="##(BRIGADE).Request">BRIGADE: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="##(BRIGADE).Respawn">BRIGADE: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="##(BRIGADE).Restart">BRIGADE: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="##(BRIGADE).Save">BRIGADE: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="##(BRIGADE).SelfRequest">BRIGADE: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="##(BRIGADE).SetAirbase">BRIGADE: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="##(BRIGADE).SetAllowSpawnOnClientParking">BRIGADE: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="##(BRIGADE).SetAutoDefenceOff">BRIGADE: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="##(BRIGADE).SetAutoDefenceOn">BRIGADE: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="##(BRIGADE).SetDebugOff">BRIGADE: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="##(BRIGADE).SetDebugOn">BRIGADE: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="##(BRIGADE).SetHarborZone">BRIGADE: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="##(BRIGADE).SetLowFuelThreshold">BRIGADE: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="##(BRIGADE).SetMarker">BRIGADE: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="##(BRIGADE).SetParkingIDs">BRIGADE: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="##(BRIGADE).SetPortZone">BRIGADE: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="##(BRIGADE).SetRailConnection">BRIGADE: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="##(BRIGADE).SetReportOff">BRIGADE: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="##(BRIGADE).SetReportOn">BRIGADE: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="##(BRIGADE).SetRespawnAfterDestroyed">BRIGADE: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="##(BRIGADE).SetRoadConnection">BRIGADE: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="##(BRIGADE).SetRunwayRepairtime">BRIGADE: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="##(BRIGADE).SetSafeParkingOff">BRIGADE: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="##(BRIGADE).SetSafeParkingOn">BRIGADE: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="##(BRIGADE).SetSaveOnMissionEnd">BRIGADE: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="##(BRIGADE).SetSpawnZone">BRIGADE: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="##(BRIGADE).SetStatusUpdate">BRIGADE: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="##(BRIGADE).SetVerbosityLevel">BRIGADE: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="##(BRIGADE).SetWarehouseZone">BRIGADE: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="##(BRIGADE).Start">BRIGADE: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="##(BRIGADE).Status">BRIGADE: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="##(BRIGADE).Stop">BRIGADE: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="##(BRIGADE).TransportType">BRIGADE.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="##(BRIGADE).UnPause">BRIGADE: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="##(BRIGADE)._Arrived">BRIGADE:_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="##(BRIGADE)._AssetItemInfo">BRIGADE:_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="##(BRIGADE)._CheckAirbaseOwner">BRIGADE:_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="##(BRIGADE)._CheckAssetStatus">BRIGADE:_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="##(BRIGADE)._CheckConquered">BRIGADE:_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="##(BRIGADE)._CheckFuel">BRIGADE:_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="##(BRIGADE)._CheckParkingAsset">BRIGADE:_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="##(BRIGADE)._CheckParkingValid">BRIGADE:_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="##(BRIGADE)._CheckQueue">BRIGADE:_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="##(BRIGADE)._CheckRequestConsistancy">BRIGADE:_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="##(BRIGADE)._CheckRequestNow">BRIGADE:_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="##(BRIGADE)._CheckRequestValid">BRIGADE:_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="##(BRIGADE)._DebugMessage">BRIGADE:_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="##(BRIGADE)._DeleteQueueItem">BRIGADE:_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="##(BRIGADE)._DeleteQueueItemByID">BRIGADE:_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="##(BRIGADE)._DeleteStockItem">BRIGADE:_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="##(BRIGADE)._DisplayStatus">BRIGADE:_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="##(BRIGADE)._DisplayStockItems">BRIGADE:_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="##(BRIGADE)._ErrorMessage">BRIGADE:_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="##(BRIGADE)._FilterStock">BRIGADE:_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="##(BRIGADE)._FindParkingForAssets">BRIGADE:_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="##(BRIGADE)._Fireworks">BRIGADE:_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="##(BRIGADE)._GetAttribute">BRIGADE:_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="##(BRIGADE)._GetFlightplan">BRIGADE:_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="##(BRIGADE)._GetIDsFromGroup">BRIGADE:_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="##(BRIGADE)._GetIDsFromGroupName">BRIGADE:_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="##(BRIGADE)._GetMaxHeight">BRIGADE:_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="##(BRIGADE)._GetNameWithOut">BRIGADE:_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="##(BRIGADE)._GetObjectSize">BRIGADE:_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="##(BRIGADE)._GetRequestOfGroup">BRIGADE:_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="##(BRIGADE)._GetStockAssetsText">BRIGADE:_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="##(BRIGADE)._GetTerminal">BRIGADE:_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="##(BRIGADE)._GetTransportsForAssets">BRIGADE:_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="##(BRIGADE)._GroupIsTransport">BRIGADE:_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="##(BRIGADE)._HasAttribute">BRIGADE:_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="##(BRIGADE)._InfoMessage">BRIGADE:_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="##(BRIGADE)._JobDone">BRIGADE:_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="##(BRIGADE)._NewLane">BRIGADE:_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="##(BRIGADE)._OnEventArrived">BRIGADE:_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="##(BRIGADE)._OnEventBaseCaptured">BRIGADE:_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="##(BRIGADE)._OnEventBirth">BRIGADE:_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="##(BRIGADE)._OnEventCrashOrDead">BRIGADE:_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="##(BRIGADE)._OnEventEngineShutdown">BRIGADE:_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="##(BRIGADE)._OnEventEngineStartup">BRIGADE:_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="##(BRIGADE)._OnEventLanding">BRIGADE:_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="##(BRIGADE)._OnEventMissionEnd">BRIGADE:_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="##(BRIGADE)._OnEventTakeOff">BRIGADE:_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="##(BRIGADE)._PassingWaypoint">BRIGADE:_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="##(BRIGADE)._PrintQueue">BRIGADE:_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="##(BRIGADE)._QuantityRel2Abs">BRIGADE:_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="##(BRIGADE)._RegisterAsset">BRIGADE:_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="##(BRIGADE)._RouteAir">BRIGADE:_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="##(BRIGADE)._RouteGround">BRIGADE:_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="##(BRIGADE)._RouteNaval">BRIGADE:_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="##(BRIGADE)._RouteTrain">BRIGADE:_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="##(BRIGADE)._SimpleTaskFunction">BRIGADE:_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="##(BRIGADE)._SimpleTaskFunctionWP">BRIGADE:_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="##(BRIGADE)._SortQueue">BRIGADE:_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="##(BRIGADE)._SpawnAssetAircraft">BRIGADE:_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="##(BRIGADE)._SpawnAssetGroundNaval">BRIGADE:_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="##(BRIGADE)._SpawnAssetPrepareTemplate">BRIGADE:_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="##(BRIGADE)._SpawnAssetRequest">BRIGADE:_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="##(BRIGADE)._UnitDead">BRIGADE:_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="##(BRIGADE)._UpdateWarehouseMarkText">BRIGADE:_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="##(BRIGADE).__AddAsset">BRIGADE:__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="##(BRIGADE).__AddRequest">BRIGADE:__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="##(BRIGADE).__AirbaseCaptured">BRIGADE:__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="##(BRIGADE).__AirbaseRecaptured">BRIGADE:__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="##(BRIGADE).__Arrived">BRIGADE:__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="##(BRIGADE).__AssetDead">BRIGADE:__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="##(BRIGADE).__AssetLowFuel">BRIGADE:__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="##(BRIGADE).__AssetSpawned">BRIGADE:__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="##(BRIGADE).__Attacked">BRIGADE:__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="##(BRIGADE).__Captured">BRIGADE:__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="##(BRIGADE).__ChangeCountry">BRIGADE:__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="##(BRIGADE).__Defeated">BRIGADE:__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="##(BRIGADE).__Delivered">BRIGADE:__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="##(BRIGADE).__Destroyed">BRIGADE:__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="##(BRIGADE).__Load">BRIGADE:__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="##(BRIGADE).__NewAsset">BRIGADE:__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="##(BRIGADE).__Pause">BRIGADE:__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="##(BRIGADE).__Request">BRIGADE:__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="##(BRIGADE).__Respawn">BRIGADE:__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="##(BRIGADE).__Restart">BRIGADE:__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="##(BRIGADE).__Save">BRIGADE:__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="##(BRIGADE).__SelfRequest">BRIGADE:__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="##(BRIGADE).__Start">BRIGADE:__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="##(BRIGADE).__Status">BRIGADE:__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="##(BRIGADE).__Stop">BRIGADE:__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="##(BRIGADE).__Unpause">BRIGADE:__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="##(BRIGADE).airbase">BRIGADE.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="##(BRIGADE).airbasename">BRIGADE.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="##(BRIGADE).alias">BRIGADE.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="##(BRIGADE).allowSpawnOnClientSpots">BRIGADE.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="##(BRIGADE).autodefence">BRIGADE.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="##(BRIGADE).autosave">BRIGADE.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="##(BRIGADE).autosavefile">BRIGADE.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="##(BRIGADE).autosavepath">BRIGADE.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="##(BRIGADE).clientcoords">BRIGADE.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="##(BRIGADE).coalition">BRIGADE.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="##(BRIGADE).countryid">BRIGADE.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="##(BRIGADE).dTstatus">BRIGADE.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="##(BRIGADE).defending">BRIGADE.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="##(BRIGADE).delivered">BRIGADE.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="##(BRIGADE).flightcontrol">BRIGADE.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="##(BRIGADE).harborzone">BRIGADE.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="##(BRIGADE).isShip">BRIGADE.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="##(BRIGADE).isUnit">BRIGADE.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="##(BRIGADE).lid">BRIGADE.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="##(BRIGADE).lowfuelthresh">BRIGADE.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="##(BRIGADE).markerOn">BRIGADE.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="##(BRIGADE).markerRail">BRIGADE.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="##(BRIGADE).markerRoad">BRIGADE.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="##(BRIGADE).markerWarehouse">BRIGADE.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="##(BRIGADE).markerid">BRIGADE.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="##(BRIGADE).markrail">BRIGADE.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="##(BRIGADE).markroad">BRIGADE.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="##(BRIGADE).offroadpaths">BRIGADE.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="##(BRIGADE).onafterAddAsset">BRIGADE: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="##(BRIGADE).onafterAddRequest">BRIGADE: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="##(BRIGADE).onafterAirbaseCaptured">BRIGADE: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="##(BRIGADE).onafterAirbaseRecaptured">BRIGADE: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="##(BRIGADE).onafterArrived">BRIGADE: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="##(BRIGADE).onafterAssetDead">BRIGADE: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="##(BRIGADE).onafterAssetSpawned">BRIGADE: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="##(BRIGADE).onafterAttacked">BRIGADE: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="##(BRIGADE).onafterCaptured">BRIGADE: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="##(BRIGADE).onafterChangeCountry">BRIGADE: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="##(BRIGADE).onafterDefeated">BRIGADE: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="##(BRIGADE).onafterDelivered">BRIGADE: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="##(BRIGADE).onafterDestroyed">BRIGADE: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="##(BRIGADE).onafterLoad">BRIGADE: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="##(BRIGADE).onafterNewAsset">BRIGADE: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="##(BRIGADE).onafterPause">BRIGADE: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="##(BRIGADE).onafterRequest">BRIGADE: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="##(BRIGADE).onafterRequestSpawned">BRIGADE: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="##(BRIGADE).onafterRespawn">BRIGADE: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="##(BRIGADE).onafterRestart">BRIGADE: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="##(BRIGADE).onafterRunwayDestroyed">BRIGADE: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="##(BRIGADE).onafterRunwayRepaired">BRIGADE: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="##(BRIGADE).onafterSave">BRIGADE: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="##(BRIGADE).onafterSelfRequest">BRIGADE: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="##(BRIGADE).onafterStart">BRIGADE: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="##(BRIGADE).onafterStatus">BRIGADE: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="##(BRIGADE).onafterStop">BRIGADE: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="##(BRIGADE).onafterUnloaded">BRIGADE: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="##(BRIGADE).onafterUnpause">BRIGADE: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="##(BRIGADE).onbeforeAddRequest">BRIGADE: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="##(BRIGADE).onbeforeArrived">BRIGADE: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="##(BRIGADE).onbeforeCaptured">BRIGADE: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="##(BRIGADE).onbeforeChangeCountry">BRIGADE: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="##(BRIGADE).onbeforeLoad">BRIGADE: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="##(BRIGADE).onbeforeRequest">BRIGADE: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="##(BRIGADE).parkingIDs">BRIGADE.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="##(BRIGADE).pending">BRIGADE.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="##(BRIGADE).portzone">BRIGADE.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="##(BRIGADE).queue">BRIGADE.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="##(BRIGADE).queueid">BRIGADE.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="##(BRIGADE).rail">BRIGADE.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="##(BRIGADE).respawnafterdestroyed">BRIGADE.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="##(BRIGADE).respawndelay">BRIGADE.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="##(BRIGADE).road">BRIGADE.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="##(BRIGADE).runwaydestroyed">BRIGADE.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="##(BRIGADE).runwayrepairtime">BRIGADE.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="##(BRIGADE).safeparking">BRIGADE.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="##(BRIGADE).shippinglanes">BRIGADE.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="##(BRIGADE).spawnzone">BRIGADE.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="##(BRIGADE).spawnzonemaxdist">BRIGADE.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="##(BRIGADE).stock">BRIGADE.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="##(BRIGADE).transporting">BRIGADE.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="##(BRIGADE).uid">BRIGADE.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="##(BRIGADE).verbosity">BRIGADE.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="##(BRIGADE).version">BRIGADE.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="##(BRIGADE).warehouse">BRIGADE.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="##(BRIGADE).wid">BRIGADE.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="##(BRIGADE).zone">BRIGADE.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="##(BRIGADE).AddEndState">BRIGADE: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="##(BRIGADE).AddProcess">BRIGADE: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="##(BRIGADE).AddScore">BRIGADE: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="##(BRIGADE).AddScoreProcess">BRIGADE: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="##(BRIGADE).AddTransition">BRIGADE: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="##(BRIGADE).CallScheduler">BRIGADE.CallScheduler</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).Events">BRIGADE.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="##(BRIGADE).GetCurrentState">BRIGADE: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="##(BRIGADE).GetEndStates">BRIGADE: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="##(BRIGADE).GetProcess">BRIGADE: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="##(BRIGADE).GetProcesses">BRIGADE: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="##(BRIGADE).GetScores">BRIGADE: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="##(BRIGADE).GetStartState">BRIGADE: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="##(BRIGADE).GetState">BRIGADE: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="##(BRIGADE).GetSubs">BRIGADE: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="##(BRIGADE).GetTransitions">BRIGADE: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="##(BRIGADE).Is">BRIGADE: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="##(BRIGADE).LoadCallBacks">BRIGADE: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="##(BRIGADE).New">BRIGADE: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="##(BRIGADE).Scores">BRIGADE.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="##(BRIGADE).SetProcess">BRIGADE: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="##(BRIGADE).SetStartState">BRIGADE: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="##(BRIGADE)._EndStates">BRIGADE._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="##(BRIGADE)._EventSchedules">BRIGADE._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="##(BRIGADE)._Processes">BRIGADE._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="##(BRIGADE)._Scores">BRIGADE._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="##(BRIGADE)._StartState">BRIGADE._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="##(BRIGADE)._Transitions">BRIGADE._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="##(BRIGADE)._add_to_map">BRIGADE:_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="##(BRIGADE)._call_handler">BRIGADE:_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="##(BRIGADE)._create_transition">BRIGADE:_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="##(BRIGADE)._delayed_transition">BRIGADE:_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="##(BRIGADE)._eventmap">BRIGADE:_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="##(BRIGADE)._gosub">BRIGADE:_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="##(BRIGADE)._handler">BRIGADE:_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="##(BRIGADE)._isendstate">BRIGADE:_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="##(BRIGADE)._submap">BRIGADE:_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="##(BRIGADE).can">BRIGADE: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="##(BRIGADE).cannot">BRIGADE: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="##(BRIGADE).current">BRIGADE.current</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).endstates">BRIGADE.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="##(BRIGADE).is">BRIGADE: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="##(BRIGADE).options">BRIGADE.options</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE).subs">BRIGADE.subs</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="#(BRIGADE.SupplyZone)">Type <strong>BRIGADE.SupplyZone</strong></a></h2></div> <div class="w3-card-4 w3-padding w3-margin w3-theme-l1"> <strong><a href="##(BRIGADE.SupplyZone)">BRIGADE.SupplyZone</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 BRIGADE.SupplyZone</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="##(BRIGADE.SupplyZone).marker">BRIGADE.SupplyZone.marker</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>F10 marker.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE.SupplyZone).markerOn">BRIGADE.SupplyZone.markerOn</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>If <code>true</code>, marker is on.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE.SupplyZone).mission">BRIGADE.SupplyZone.mission</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>Mission assigned to supply ammo or fuel.</p> </td> </tr> <tr class="w3-border"> <td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(BRIGADE.SupplyZone).zone">BRIGADE.SupplyZone.zone</a></p></td> <td class="summary w3-half w3-container" style="word-wrap: break-word"> <p>The zone.</p> </td> </tr> </table> </div> <div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Ops.Brigade)" >Type <strong>Ops.Brigade</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##BRIGADE')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(BRIGADE)">Type <strong>BRIGADE</strong></a></h2></div> <div id= "#Types##BRIGADE" class="w3-container w3-white w3-padding-16" id="module_other_types"> <div class="w3-white" id="record_type"> <p>BRIGADE 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"> #string <a id="#(BRIGADE).ClassName" ><strong>BRIGADE.ClassName</strong></a> <p>Name of the class.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).lid" ><strong>BRIGADE.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"> #table <a id="#(BRIGADE).rearmingZones" ><strong>BRIGADE.rearmingZones</strong></a> <p>Rearming zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #table <a id="#(BRIGADE).refuellingZones" ><strong>BRIGADE.refuellingZones</strong></a> <p>Refuelling zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> <a id="#(BRIGADE).retreatZones" ><strong>BRIGADE.retreatZones</strong></a> <p>Retreat zone set.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #number <a id="#(BRIGADE).verbose" ><strong>BRIGADE.verbose</strong></a> <p>Verbosity of output.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).version" ><strong>BRIGADE.version</strong></a> <p>BRIGADE class version.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).warehouseOpsElement" ><strong>BRIGADE.warehouseOpsElement</strong></a> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Ops.NavyGroup.html##(NAVYGROUP)">Ops.NavyGroup#NAVYGROUP</a> <a id="#(BRIGADE).warehouseOpsGroup" ><strong>BRIGADE.warehouseOpsGroup</strong></a> </div> </div> <div class="functions w3-container w3-theme-l2"> <h2>Function(s)</h2> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddAssetToPlatoon" ><strong>BRIGADE:AddAssetToPlatoon(Platoon, Nassets)</strong></a></h2> </div> <p>Add asset group(s) to platoon.</p> <div id= "#Functions##AddAssetToPlatoon" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Platoon.html##(PLATOON)">Ops.Platoon#PLATOON</a> <strong><strong>Platoon</strong></strong> </p> </div> <div class="w3-half"> <p>The platoon object.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>Nassets</strong></strong> </p> </div> <div class="w3-half"> <p>Number of asset groups to add.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddPlatoon" ><strong>BRIGADE:AddPlatoon(Platoon)</strong></a></h2> </div> <p>Add a platoon to the brigade.</p> <div id= "#Functions##AddPlatoon" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Platoon.html##(PLATOON)">Ops.Platoon#PLATOON</a> <strong><strong>Platoon</strong></strong> </p> </div> <div class="w3-half"> <p>The platoon 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="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddRearmingZone" ><strong>BRIGADE:AddRearmingZone(RearmingZone)</strong></a></h2> </div> <p>Add a rearming zone.</p> <div id= "#Functions##AddRearmingZone" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>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>RearmingZone</strong></strong> </p> </div> <div class="w3-half"> <p>Rearming 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="##(BRIGADE.SupplyZone)">#BRIGADE.SupplyZone</a>:</p> </div> <div class="w3-half"> <p>The rearming zone 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="#(BRIGADE).AddRefuellingZone" ><strong>BRIGADE:AddRefuellingZone(RefuellingZone)</strong></a></h2> </div> <p>Add a refuelling zone.</p> <div id= "#Functions##AddRefuellingZone" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>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>RefuellingZone</strong></strong> </p> </div> <div class="w3-half"> <p>Refuelling 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="##(BRIGADE.SupplyZone)">#BRIGADE.SupplyZone</a>:</p> </div> <div class="w3-half"> <p>The refuelling zone 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="#(BRIGADE).AddRetreatZone" ><strong>BRIGADE:AddRetreatZone(RetreatZone)</strong></a></h2> </div> <p>Add a retreat zone.</p> <div id= "#Functions##AddRetreatZone" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>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>RetreatZone</strong></strong> </p> </div> <div class="w3-half"> <p>Retreat 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="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).ArmyOnMission" ><strong>BRIGADE:ArmyOnMission(ArmyGroup, Mission)</strong></a></h2> </div> <p>Triggers the FSM event "ArmyOnMission".</p> <div id= "#Functions##ArmyOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.ArmyGroup.html##(ARMYGROUP)">Ops.ArmyGroup#ARMYGROUP</a> <strong><strong>ArmyGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The ARMYGROUP on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetPlatoon" ><strong>BRIGADE:GetPlatoon(PlatoonName)</strong></a></h2> </div> <p>Get platoon by name.</p> <div id= "#Functions##GetPlatoon" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </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>PlatoonName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the platoon.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.Platoon.html##(PLATOON)">Ops.Platoon#PLATOON</a>:</p> </div> <div class="w3-half"> <p>The Platoon 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="#(BRIGADE).GetPlatoonOfAsset" ><strong>BRIGADE:GetPlatoonOfAsset(Asset)</strong></a></h2> </div> <p>Get platoon of an asset.</p> <div id= "#Functions##GetPlatoonOfAsset" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The platoon 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="Ops.Platoon.html##(PLATOON)">Ops.Platoon#PLATOON</a>:</p> </div> <div class="w3-half"> <p>The platoon 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="#(BRIGADE).GetRetreatZones" ><strong>BRIGADE:GetRetreatZones()</strong></a></h2> </div> <p>Get retreat zones.</p> <div id= "#Functions##GetRetreatZones" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a>:</p> </div> <div class="w3-half"> <p>Set of retreat zones.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).LoadBackAssetInPosition" ><strong>BRIGADE:LoadBackAssetInPosition(Templatename, Position)</strong></a></h2> </div> <p>[ GROUND ] Function to load back an asset in the field that has been filed before.</p> <div id= "#Functions##LoadBackAssetInPosition" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </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>Templatename</strong></strong> </p> </div> <div class="w3-half"> <p>e.g."1 PzDv LogRg I_AID-976" - that's the alias (name) of an platoon spawned as <code>"platoon - alias"_AID-"asset-ID"</code></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>Position</strong></strong> </p> </div> <div class="w3-half"> <p>where to spawn the platoon</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> <h2><strong>Usage:</strong></h2> <pre class="example"><code>Prerequisites: Save the assets spawned by BRIGADE/CHIEF regularly (~every 5 mins) into a file, e.g. like this: local Path = FilePath or "C:\\Users\\<yourname>\\Saved Games\\DCS\\Missions\\" -- example path local BlueOpsFilename = BlueFileName or "ExamplePlatoonSave.csv" -- example filename local BlueSaveOps = SET_OPSGROUP:New():FilterCoalitions("blue"):FilterCategoryGround():FilterOnce() UTILS.SaveSetOfOpsGroups(BlueSaveOps,Path,BlueOpsFilename) where Path and Filename are strings, as chosen by you. You can then load back the assets at the start of your next mission run. Be aware that it takes a couple of seconds for the platoon data to arrive in brigade, so make this an action after ~20 seconds, e.g. like so: function LoadBackAssets() local Path = FilePath or "C:\\Users\\<yourname>\\Saved Games\\DCS\\Missions\\" -- example path local BlueOpsFilename = BlueFileName or "ExamplePlatoonSave.csv" -- example filename if UTILS.CheckFileExists(Path,BlueOpsFilename) then local loadback = UTILS.LoadSetOfOpsGroups(Path,BlueOpsFilename,false) for _,_platoondata in pairs (loadback) do local groupname = _platoondata.groupname -- #string local coordinate = _platoondata.coordinate -- Core.Point#COORDINATE Your_Brigade:LoadBackAssetInPosition(groupname,coordinate) end end end local AssetLoader = TIMER:New(LoadBackAssets) AssetLoader:Start(20) The assets loaded back into the mission will be considered for AUFTRAG type missions from CHIEF and BRIGADE.</code></pre> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).New" ><strong>BRIGADE:New(WarehouseName, BrigadeName)</strong></a></h2> </div> <p>Create a new BRIGADE class 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>BRIGADE</p> </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>WarehouseName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the warehouse STATIC or UNIT object representing the warehouse.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>BrigadeName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the brigade.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterArmyOnMission" ><strong>BRIGADE:OnAfterArmyOnMission(From, Event, To, ArmyGroup, Mission)</strong></a></h2> </div> <p>On after "ArmyOnMission" event.</p> <div id= "#Functions##OnAfterArmyOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.ArmyGroup.html##(ARMYGROUP)">Ops.ArmyGroup#ARMYGROUP</a> <strong><strong>ArmyGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The ARMYGROUP on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).RemoveAssetFromPlatoon" ><strong>BRIGADE:RemoveAssetFromPlatoon(Asset)</strong></a></h2> </div> <p>Remove asset from platoon.</p> <div id= "#Functions##RemoveAssetFromPlatoon" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The platoon 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="#(BRIGADE).SetRetreatZones" ><strong>BRIGADE:SetRetreatZones(RetreatZoneSet)</strong></a></h2> </div> <p>Define a set of retreat zones.</p> <div id= "#Functions##SetRetreatZones" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> <strong><strong>RetreatZoneSet</strong></strong> </p> </div> <div class="w3-half"> <p>Set of retreat zones.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(BRIGADE)">#BRIGADE</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Start" ><strong>BRIGADE:Start()</strong></a></h2> </div> <p>Triggers the FSM event "Start".</p> <p>Starts the BRIGADE. 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>BRIGADE</p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__ArmyOnMission" ><strong>BRIGADE:__ArmyOnMission(delay, ArmyGroup, Mission)</strong></a></h2> </div> <p>Triggers the FSM event "ArmyOnMission" after a delay.</p> <div id= "#Functions##__ArmyOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.ArmyGroup.html##(ARMYGROUP)">Ops.ArmyGroup#ARMYGROUP</a> <strong><strong>ArmyGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The ARMYGROUP on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__Start" ><strong>BRIGADE:__Start(delay)</strong></a></h2> </div> <p>Triggers the FSM event "Start" after a delay.</p> <p>Starts the BRIGADE. 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>BRIGADE</p> </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="#(BRIGADE).__Stop" ><strong>BRIGADE:__Stop(delay)</strong></a></h2> </div> <p>Triggers the FSM event "Stop" after a delay.</p> <p>Stops the BRIGADE and all its event handlers.</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>BRIGADE</p> </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="#(BRIGADE).onafterArmyOnMission" ><strong>BRIGADE:onafterArmyOnMission(From, Event, To, ArmyGroup, Mission)</strong></a></h2> </div> <p>On after "ArmyOnMission".</p> <div id= "#Functions##onafterArmyOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p>BRIGADE</p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.ArmyGroup.html##(ARMYGROUP)">Ops.ArmyGroup#ARMYGROUP</a> <strong><strong>ArmyGroup</strong></strong> </p> </div> <div class="w3-half"> <p>Ops army group on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The requested mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterStart" ><strong>BRIGADE:onafterStart(From, Event, To)</strong></a></h2> </div> <p>Start BRIGADE FSM.</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>BRIGADE</p> </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>To</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="#(BRIGADE).onafterStatus" ><strong>BRIGADE:onafterStatus(From, Event, To)</strong></a></h2> </div> <p>Update status.</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>BRIGADE</p> </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>To</strong></strong> </p> </div> <div class="w3-half"> <p></p> </div> </div> </div> </div> </div> <div class="fields w3-container w3-theme-l2"> <h2>Field(s)</h2> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).ClassName" ><strong>BRIGADE.ClassName</strong></a> <p>Name of the class.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).lid" ><strong>BRIGADE.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"> #table <a id="#(BRIGADE).rearmingZones" ><strong>BRIGADE.rearmingZones</strong></a> <p>Rearming zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #table <a id="#(BRIGADE).refuellingZones" ><strong>BRIGADE.refuellingZones</strong></a> <p>Refuelling zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> <a id="#(BRIGADE).retreatZones" ><strong>BRIGADE.retreatZones</strong></a> <p>Retreat zone set.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #number <a id="#(BRIGADE).verbose" ><strong>BRIGADE.verbose</strong></a> <p>Verbosity of output.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).version" ><strong>BRIGADE.version</strong></a> <p>BRIGADE class version.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).warehouseOpsElement" ><strong>BRIGADE.warehouseOpsElement</strong></a> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Ops.NavyGroup.html##(NAVYGROUP)">Ops.NavyGroup#NAVYGROUP</a> <a id="#(BRIGADE).warehouseOpsGroup" ><strong>BRIGADE.warehouseOpsGroup</strong></a> </div> </div> <div class="functions w3-container w3-theme-l2"> <h2>Function(s)</h2> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddCohort" ><strong>BRIGADE:AddCohort(Cohort)</strong></a></h2> </div> <p>Add cohort to cohort table of this legion.</p> <div id= "#Functions##AddCohort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort to be added.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddMission" ><strong>BRIGADE:AddMission(Mission)</strong></a></h2> </div> <p>Add a mission for the legion.</p> <p>It will pick the best available assets for the mission and lauch it when ready. </p> <div id= "#Functions##AddMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>Mission for this legion.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddOpsTransport" ><strong>BRIGADE:AddOpsTransport(OpsTransport)</strong></a></h2> </div> <p>Add transport assignment to queue. </p> <div id= "#Functions##AddOpsTransport" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>OpsTransport</strong></strong> </p> </div> <div class="w3-half"> <p>Transport assignment.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AssignAssetsForEscort" ><strong>BRIGADE:AssignAssetsForEscort(Cohorts, Assets, NescortMin, NescortMax, MissionType, TargetTypes, EngageRange)</strong></a></h2> </div> <p>Recruit and assign assets performing an escort mission for a given asset list.</p> <p>Note that each asset gets an escort.</p> <div id= "#Functions##AssignAssetsForEscort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Cohorts</strong></strong> </p> </div> <div class="w3-half"> <p>Cohorts for escorting assets.</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>Table of assets to be escorted.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NescortMin</strong></strong> </p> </div> <div class="w3-half"> <p>Min number of escort groups required per escorted 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>NescortMax</strong></strong> </p> </div> <div class="w3-half"> <p>Max number of escort groups required per escorted 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>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>TargetTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types of targets that are engaged.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>EngageRange</strong></strong> </p> </div> <div class="w3-half"> <p>EngageRange in Nautical Miles.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <code>true</code>, enough assets could be recruited or no escort was required in the first place.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AssignAssetsForTransport" ><strong>BRIGADE:AssignAssetsForTransport(Legions, CargoAssets, NcarriersMin, NcarriersMax, DeployZone, DisembarkZone, Categories, Attributes, Properties)</strong></a></h2> </div> <p>Recruit and assign assets performing an OPSTRANSPORT for a given asset list.</p> <div id= "#Functions##AssignAssetsForTransport" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>Transport legions.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>CargoAssets</strong></strong> </p> </div> <div class="w3-half"> <p>Weight of the heaviest cargo group to be transported.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NcarriersMin</strong></strong> </p> </div> <div class="w3-half"> <p>Min number of carrier assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NcarriersMax</strong></strong> </p> </div> <div class="w3-half"> <p>Max number of carrier assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> <strong><strong>DeployZone</strong></strong> </p> </div> <div class="w3-half"> <p>Deploy zone.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Core.Zone.html##(ZONE)">Core.Zone#ZONE</a> <strong><strong>DisembarkZone</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Disembark zone. </p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Categories</strong></strong> </p> </div> <div class="w3-half"> <p>Group categories.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>Generalizes group attributes.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Properties</strong></strong> </p> </div> <div class="w3-half"> <p>DCS attributes.</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 <code>true</code>, enough assets could be recruited and an OPSTRANSPORT object was created.</p> </div> <div class="w3-half"> <p><a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a>:</p> </div> <div class="w3-half"> <p>Transport The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).CalculateAssetMissionScore" ><strong>BRIGADE.CalculateAssetMissionScore(asset, MissionType, TargetVec2, IncludePayload, TotalWeight)</strong></a></h2> </div> <p>Calculate the mission score of an asset.</p> <div id= "#Functions##CalculateAssetMissionScore" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>asset</strong></strong> </p> </div> <div class="w3-half"> <p>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>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type for which the best assets are desired.</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##(Vec2)">DCS#Vec2</a> <strong><strong>TargetVec2</strong></strong> </p> </div> <div class="w3-half"> <p>Target 2D vector.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #boolean <strong><strong>IncludePayload</strong></strong> </p> </div> <div class="w3-half"> <p>If <code>true</code>, include the payload in the calulation if the asset has one attached.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>TotalWeight</strong></strong> </p> </div> <div class="w3-half"> <p>The total weight of the cargo to be transported, if applicable.</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>Mission score.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).CheckMissionQueue" ><strong>BRIGADE:CheckMissionQueue()</strong></a></h2> </div> <p>Check mission queue and assign ONE mission.</p> <div id= "#Functions##CheckMissionQueue" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <code>true</code>, a mission was found and requested.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).CheckTransportQueue" ><strong>BRIGADE:CheckTransportQueue()</strong></a></h2> </div> <p>Check transport queue and assign ONE transport.</p> <div id= "#Functions##CheckTransportQueue" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <code>true</code>, a transport was found and requested.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).CountAssets" ><strong>BRIGADE:CountAssets(InStock, MissionTypes, Attributes)</strong></a></h2> </div> <p>Count total number of assets of the legion.</p> <div id= "#Functions##CountAssets" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #boolean <strong><strong>InStock</strong></strong> </p> </div> <div class="w3-half"> <p>If <code>true</code>, only assets that are in the warehouse stock/inventory are counted. If <code>false</code>, only assets that are NOT in stock (i.e. spawned) are counted. If <code>nil</code>, all assets are counted.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Count only assest that can perform certain mission type(s). Default is all types.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Count only assest that have a certain attribute(s), e.g. <code>GROUP.Attribute.AIR_BOMBER</code>.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#number:</p> </div> <div class="w3-half"> <p>Amount of asset groups 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="#(BRIGADE).CountAssetsOnMission" ><strong>BRIGADE:CountAssetsOnMission(MissionTypes, Cohort)</strong></a></h2> </div> <p>Count assets on mission.</p> <div id= "#Functions##CountAssetsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types on mission to be checked. Default all.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>Only count assets of this cohort. Default count assets of all cohorts.</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>Number of pending and queued assets.</p> </div> <div class="w3-half"> <p>#number:</p> </div> <div class="w3-half"> <p>Number of pending assets.</p> </div> <div class="w3-half"> <p>#number:</p> </div> <div class="w3-half"> <p>Number of queued 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="#(BRIGADE).CountAssetsWithPayloadsInStock" ><strong>BRIGADE:CountAssetsWithPayloadsInStock(Payloads, MissionTypes, Attributes)</strong></a></h2> </div> <p>Count total number of assets in LEGION warehouse stock that also have a payload.</p> <div id= "#Functions##CountAssetsWithPayloadsInStock" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #boolean <strong><strong>Payloads</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Specifc payloads to consider. Default all.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Count only assest that can perform certain mission type(s). Default is all types.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Count only assest that have a certain attribute(s), e.g. <code>WAREHOUSE.Attribute.AIR_BOMBER</code>.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#number:</p> </div> <div class="w3-half"> <p>Amount of asset groups 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="#(BRIGADE).CountMissionsInQueue" ><strong>BRIGADE:CountMissionsInQueue(MissionTypes)</strong></a></h2> </div> <p>Count missions in mission queue.</p> <div id= "#Functions##CountMissionsInQueue" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types on mission to be checked. Default <em>all</em> possible types <code>AUFTRAG.Type</code>.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#number:</p> </div> <div class="w3-half"> <p>Number of missions that are not over 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="#(BRIGADE).CountPayloadsInStock" ><strong>BRIGADE:CountPayloadsInStock(MissionTypes, UnitTypes, Payloads)</strong></a></h2> </div> <p>Count payloads in stock.</p> <div id= "#Functions##CountPayloadsInStock" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types on mission to be checked. Default <em>all</em> possible types <code>AUFTRAG.Type</code>.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>UnitTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types of units.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Payloads</strong></strong> </p> </div> <div class="w3-half"> <p>Specific payloads to be counted only.</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>Count of available payloads 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="#(BRIGADE).DelAsset" ><strong>BRIGADE:DelAsset(Asset)</strong></a></h2> </div> <p>Remove specific asset from legion.</p> <div id= "#Functions##DelAsset" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).DelCohort" ><strong>BRIGADE:DelCohort(Cohort)</strong></a></h2> </div> <p>Remove cohort from cohor table of this legion.</p> <div id= "#Functions##DelCohort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort to be added.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).FetchPayloadFromStock" ><strong>BRIGADE:FetchPayloadFromStock(UnitType, MissionType, Payloads)</strong></a></h2> </div> <p>Fetch a payload from the airwing resources for a given unit and mission type.</p> <p>The payload with the highest priority is preferred.</p> <div id= "#Functions##FetchPayloadFromStock" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>UnitType</strong></strong> </p> </div> <div class="w3-half"> <p>The type of the unit.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>The mission type.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Payloads</strong></strong> </p> </div> <div class="w3-half"> <p>Specific payloads only to be 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><a href="Ops.Airwing.html##(AIRWING.Payload)">Ops.Airwing#AIRWING.Payload</a>:</p> </div> <div class="w3-half"> <p>Payload table or <em>nil</em>.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetAircraftTypes" ><strong>BRIGADE:GetAircraftTypes(onlyactive, cohorts)</strong></a></h2> </div> <p>Get the unit types of this legion.</p> <p>These are the unit types of all assigned cohorts.</p> <div id= "#Functions##GetAircraftTypes" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #boolean <strong><strong>onlyactive</strong></strong> </p> </div> <div class="w3-half"> <p>Count only the active ones.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>cohorts</strong></strong> </p> </div> <div class="w3-half"> <p>Table of cohorts. Default 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>#table:</p> </div> <div class="w3-half"> <p>Table of unit types.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetAssetCurrentMission" ><strong>BRIGADE:GetAssetCurrentMission(asset)</strong></a></h2> </div> <p>Get the current mission of the asset.</p> <div id= "#Functions##GetAssetCurrentMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>:</p> </div> <div class="w3-half"> <p>Current mission or <em>nil</em>.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetAssetsOnMission" ><strong>BRIGADE:GetAssetsOnMission(MissionTypes)</strong></a></h2> </div> <p>Get assets on mission.</p> <div id= "#Functions##GetAssetsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types on mission to be checked. Default 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>#table:</p> </div> <div class="w3-half"> <p>Assets on pending requests.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetMissionByID" ><strong>BRIGADE:GetMissionByID(mid)</strong></a></h2> </div> <p>Returns the mission for a given mission ID (Autragsnummer).</p> <div id= "#Functions##GetMissionByID" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>mid</strong></strong> </p> </div> <div class="w3-half"> <p>Mission ID (Auftragsnummer).</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>:</p> </div> <div class="w3-half"> <p>Mission 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="#(BRIGADE).GetMissionFromRequest" ><strong>BRIGADE:GetMissionFromRequest(Request)</strong></a></h2> </div> <p>Returns the mission for a given request.</p> <div id= "#Functions##GetMissionFromRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Queueitem)">Functional.Warehouse#WAREHOUSE.Queueitem</a> <strong><strong>Request</strong></strong> </p> </div> <div class="w3-half"> <p>The warehouse 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><a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>:</p> </div> <div class="w3-half"> <p>Mission table or <em>nil</em>.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetMissionFromRequestID" ><strong>BRIGADE:GetMissionFromRequestID(RequestID)</strong></a></h2> </div> <p>Returns the mission for a given request ID.</p> <div id= "#Functions##GetMissionFromRequestID" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>RequestID</strong></strong> </p> </div> <div class="w3-half"> <p>Unique ID 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><a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a>:</p> </div> <div class="w3-half"> <p>Mission table or <em>nil</em>.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetName" ><strong>BRIGADE:GetName()</strong></a></h2> </div> <p>Get name of legion.</p> <p>This is the alias of the warehouse.</p> <div id= "#Functions##GetName" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#string:</p> </div> <div class="w3-half"> <p>Name of legion.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetOpsGroups" ><strong>BRIGADE:GetOpsGroups(MissionTypes, Attributes)</strong></a></h2> </div> <p>Get OPSGROUPs that are spawned and alive.</p> <div id= "#Functions##GetOpsGroups" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Get only assest that can perform certain mission type(s). Default is all types.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Get only assest that have a certain attribute(s), e.g. <code>WAREHOUSE.Attribute.AIR_BOMBER</code>.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Core.Set.html##(SET_OPSGROUP)">Core.Set#SET_OPSGROUP</a>:</p> </div> <div class="w3-half"> <p>The set of OPSGROUPs. Can be empty if no groups are spawned or alive!</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).GetTransportByID" ><strong>BRIGADE:GetTransportByID(uid)</strong></a></h2> </div> <p>Returns the mission for a given ID.</p> <div id= "#Functions##GetTransportByID" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Transport UID.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a>:</p> </div> <div class="w3-half"> <p>Transport assignment.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).IsAirwing" ><strong>BRIGADE:IsAirwing()</strong></a></h2> </div> <p>Check if the AIRWING class is calling.</p> <div id= "#Functions##IsAirwing" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, this is an AIRWING.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).IsAssetOnMission" ><strong>BRIGADE:IsAssetOnMission(asset, MissionTypes)</strong></a></h2> </div> <p>Check if an asset is currently on a mission (STARTED or EXECUTING).</p> <div id= "#Functions##IsAssetOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>MissionTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Types on mission to be checked. Default 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>#boolean:</p> </div> <div class="w3-half"> <p>If true, asset has at least one mission of that type in the 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="#(BRIGADE).IsBrigade" ><strong>BRIGADE:IsBrigade()</strong></a></h2> </div> <p>Check if a BRIGADE class is calling.</p> <div id= "#Functions##IsBrigade" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, this is a BRIGADE.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).IsCohort" ><strong>BRIGADE:IsCohort(CohortName)</strong></a></h2> </div> <p>Check if cohort is part of this legion.</p> <div id= "#Functions##IsCohort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>CohortName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the platoon.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <code>true</code>, cohort is part of this legion.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).IsFleet" ><strong>BRIGADE:IsFleet()</strong></a></h2> </div> <p>Check if the FLEET class is calling.</p> <div id= "#Functions##IsFleet" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, this is a FLEET.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).LegionAssetReturned" ><strong>BRIGADE:LegionAssetReturned(Cohort, Asset)</strong></a></h2> </div> <p>Triggers the FSM event "LegionAssetReturned".</p> <div id= "#Functions##LegionAssetReturned" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort the asset belongs to.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset that returned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).MissionAssign" ><strong>BRIGADE:MissionAssign(Mission, Legions)</strong></a></h2> </div> <p>Triggers the FSM event "MissionAssign".</p> <div id= "#Functions##MissionAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) from which the mission assets are requested.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).MissionCancel" ><strong>BRIGADE:MissionCancel(Mission)</strong></a></h2> </div> <p>Triggers the FSM event "MissionCancel".</p> <div id= "#Functions##MissionCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).MissionRequest" ><strong>BRIGADE:MissionRequest(Mission, Assets)</strong></a></h2> </div> <p>Triggers the FSM event "MissionRequest".</p> <div id= "#Functions##MissionRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</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>(Optional) Assets to add.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).New" ><strong>BRIGADE:New(WarehouseName, LegionName)</strong></a></h2> </div> <p>Create a new LEGION class 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="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>WarehouseName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the warehouse STATIC or UNIT object representing the warehouse.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>LegionName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the legion. Must be <strong>unique</strong>!</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterLegionAssetReturned" ><strong>BRIGADE:OnAfterLegionAssetReturned(From, Event, To, Cohort, Asset)</strong></a></h2> </div> <p>On after "LegionAssetReturned" event.</p> <p>Triggered when an asset group returned to its Legion.</p> <div id= "#Functions##OnAfterLegionAssetReturned" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort the asset belongs to.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset that returned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterMissionAssign" ><strong>BRIGADE:OnAfterMissionAssign(From, Event, To, Mission, Legions)</strong></a></h2> </div> <p>On after "MissionAssign" event.</p> <div id= "#Functions##OnAfterMissionAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) from which the mission assets are requested.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterMissionCancel" ><strong>BRIGADE:OnAfterMissionCancel(From, Event, To, Mission)</strong></a></h2> </div> <p>On after "MissionCancel" event.</p> <div id= "#Functions##OnAfterMissionCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterMissionRequest" ><strong>BRIGADE:OnAfterMissionRequest(From, Event, To, Mission, Assets)</strong></a></h2> </div> <p>On after "MissionRequest" event.</p> <div id= "#Functions##OnAfterMissionRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</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>(Optional) Assets to add.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterOpsOnMission" ><strong>BRIGADE:OnAfterOpsOnMission(From, Event, To, OpsGroup, Mission)</strong></a></h2> </div> <p>On after "OpsOnMission" event.</p> <div id= "#Functions##OnAfterOpsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> <strong><strong>OpsGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The OPS group on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterTransportAssign" ><strong>BRIGADE:OnAfterTransportAssign(From, Event, To, Transport, Legions)</strong></a></h2> </div> <p>On after "TransportAssign" event.</p> <div id= "#Functions##OnAfterTransportAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) to which this transport is assigned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterTransportCancel" ><strong>BRIGADE:OnAfterTransportCancel(From, Event, To, Transport)</strong></a></h2> </div> <p>On after "TransportCancel" event.</p> <div id= "#Functions##OnAfterTransportCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OnAfterTransportRequest" ><strong>BRIGADE:OnAfterTransportRequest(From, Event, To, Transport)</strong></a></h2> </div> <p>On after "TransportRequest" event.</p> <div id= "#Functions##OnAfterTransportRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).OpsOnMission" ><strong>BRIGADE:OpsOnMission(OpsGroup, Mission)</strong></a></h2> </div> <p>Triggers the FSM event "OpsOnMission".</p> <div id= "#Functions##OpsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> <strong><strong>OpsGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The OPS group on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).RecruitAssetsForEscort" ><strong>BRIGADE:RecruitAssetsForEscort(Mission, Assets)</strong></a></h2> </div> <p>Recruit assets performing an escort mission for a given asset.</p> <div id= "#Functions##RecruitAssetsForEscort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</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>Table of 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 <code>true</code>, enough assets could be recruited or no escort was required in the first place.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).RecruitAssetsForMission" ><strong>BRIGADE:RecruitAssetsForMission(Mission)</strong></a></h2> </div> <p>Recruit assets for a given mission.</p> <div id= "#Functions##RecruitAssetsForMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</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 <code>true</code> enough assets could be recruited.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>Recruited assets.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>Legions of recruited 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="#(BRIGADE).RecruitAssetsForTransport" ><strong>BRIGADE:RecruitAssetsForTransport(Transport)</strong></a></h2> </div> <p>Recruit assets for a given OPS transport.</p> <div id= "#Functions##RecruitAssetsForTransport" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The OPS transport.</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 <code>true</code>, enough assets could be recruited.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>assets Recruited assets.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>legions Legions of recruited 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="#(BRIGADE).RecruitCohortAssets" ><strong>BRIGADE.RecruitCohortAssets(Cohorts, MissionTypeRecruit, MissionTypeOpt, NreqMin, NreqMax, TargetVec2, Payloads, RangeMax, RefuelSystem, CargoWeight, TotalWeight, MaxWeight, Categories, Attributes, Properties, WeaponTypes)</strong></a></h2> </div> <p>Recruit assets from Cohorts for the given parameters.</p> <p><strong>NOTE</strong> that we set the <code>asset.isReserved=true</code> flag so it cannot be recruited by anyone else.</p> <div id= "#Functions##RecruitCohortAssets" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Cohorts</strong></strong> </p> </div> <div class="w3-half"> <p>Cohorts included.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>MissionTypeRecruit</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type for recruiting the cohort assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>MissionTypeOpt</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type for which the assets are optimized. Default is the same as <code>MissionTypeRecruit</code>.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NreqMin</strong></strong> </p> </div> <div class="w3-half"> <p>Minimum number of required assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NreqMax</strong></strong> </p> </div> <div class="w3-half"> <p>Maximum number of required assets.</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##(Vec2)">DCS#Vec2</a> <strong><strong>TargetVec2</strong></strong> </p> </div> <div class="w3-half"> <p>Target position as 2D vector.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Payloads</strong></strong> </p> </div> <div class="w3-half"> <p>Special payloads.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>RangeMax</strong></strong> </p> </div> <div class="w3-half"> <p>Max range in meters.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>RefuelSystem</strong></strong> </p> </div> <div class="w3-half"> <p>Refuelsystem.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>CargoWeight</strong></strong> </p> </div> <div class="w3-half"> <p>Cargo weight for recruiting transport carriers.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>TotalWeight</strong></strong> </p> </div> <div class="w3-half"> <p>Total cargo weight 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>MaxWeight</strong></strong> </p> </div> <div class="w3-half"> <p>Max weight [kg] 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> #table <strong><strong>Categories</strong></strong> </p> </div> <div class="w3-half"> <p>Group categories. </p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>Group attributes. See <code>GROUP.Attribute.</code></p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Properties</strong></strong> </p> </div> <div class="w3-half"> <p>DCS attributes.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>WeaponTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Bit of weapon types.</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 <code>true</code> enough assets could be recruited.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>Recruited assets. <strong>NOTE</strong> that we set the <code>asset.isReserved=true</code> flag so it cant be recruited by anyone else.</p> </div> <div class="w3-half"> <p>#table:</p> </div> <div class="w3-half"> <p>Legions of recruited 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="#(BRIGADE).RelocateCohort" ><strong>BRIGADE:RelocateCohort(Cohort, Legion, Delay, NcarriersMin, NcarriersMax, TransportLegions)</strong></a></h2> </div> <p>Relocate a cohort to another legion.</p> <p>Assets in stock are spawned and routed to the new legion. If assets are spawned, running missions will be cancelled. Cohort assets will not be available until relocation is finished.</p> <div id= "#Functions##RelocateCohort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort to be relocated.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a> <strong><strong>Legion</strong></strong> </p> </div> <div class="w3-half"> <p>The legion where the cohort is relocated to.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>Delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds before relocation takes place. Default <code>nil</code>, <em>i.e.</em> ASAP.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>NcarriersMin</strong></strong> </p> </div> <div class="w3-half"> <p>Min number of transport carriers in case the troops should be transported. Default <code>nil</code> for no 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>NcarriersMax</strong></strong> </p> </div> <div class="w3-half"> <p>Max number of transport carriers.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>TransportLegions</strong></strong> </p> </div> <div class="w3-half"> <p>Legion(s) assigned for transportation. Default is that transport assets can only be recruited from this legion.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).RemoveMission" ><strong>BRIGADE:RemoveMission(Mission)</strong></a></h2> </div> <p>Remove mission from queue.</p> <div id= "#Functions##RemoveMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>Mission to be removed.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).ReturnPayloadFromAsset" ><strong>BRIGADE:ReturnPayloadFromAsset(asset)</strong></a></h2> </div> <p>Return payload from asset back to stock.</p> <div id= "#Functions##ReturnPayloadFromAsset" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>asset</strong></strong> </p> </div> <div class="w3-half"> <p>The squadron 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="#(BRIGADE).SetTacticalOverviewOn" ><strong>BRIGADE:SetTacticalOverviewOn()</strong></a></h2> </div> <p>Set tactical overview on.</p> <div id= "#Functions##SetTacticalOverviewOn" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</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="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).SetVerbosity" ><strong>BRIGADE:SetVerbosity(VerbosityLevel)</strong></a></h2> </div> <p>Set verbosity level.</p> <div id= "#Functions##SetVerbosity" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="##(LEGION)">#LEGION</a>:</p> </div> <div class="w3-half"> <p>self</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Start" ><strong>BRIGADE:Start()</strong></a></h2> </div> <p>Triggers the FSM event "Start".</p> <p>Starts the LEGION. 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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).TransportAssign" ><strong>BRIGADE:TransportAssign(Transport, Legions)</strong></a></h2> </div> <p>Triggers the FSM event "TransportAssign".</p> <div id= "#Functions##TransportAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) to which this transport is assigned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).TransportCancel" ><strong>BRIGADE:TransportCancel(Transport)</strong></a></h2> </div> <p>Triggers the FSM event "TransportCancel".</p> <div id= "#Functions##TransportCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).TransportRequest" ><strong>BRIGADE:TransportRequest(Transport)</strong></a></h2> </div> <p>Triggers the FSM event "TransportRequest".</p> <div id= "#Functions##TransportRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).UnRecruitAssets" ><strong>BRIGADE.UnRecruitAssets(Assets, Mission)</strong></a></h2> </div> <p>Unrecruit assets.</p> <p>Set <code>isReserved</code> to false, return payload to airwing and (optionally) remove from assigned mission.</p> <div id= "#Functions##UnRecruitAssets" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Assets</strong></strong> </p> </div> <div class="w3-half"> <p>List of assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) The mission from which the assets will 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="#(BRIGADE)._AddRequest" ><strong>BRIGADE:_AddRequest(AssetDescriptor, AssetDescriptorValue, nAsset, Prio, Assignment)</strong></a></h2> </div> <p>Create a request and add it to the warehouse queue.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Descriptor)">Functional.Warehouse#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> #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> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Functional.Warehouse.html##(WAREHOUSE.Queueitem)">Functional.Warehouse#WAREHOUSE.Queueitem</a>:</p> </div> <div class="w3-half"> <p>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="#(BRIGADE)._CohortCan" ><strong>BRIGADE._CohortCan(Cohort, MissionType, Categories, Attributes, Properties, WeaponTypes, TargetVec2, RangeMax, RefuelSystem, CargoWeight, MaxWeight)</strong></a></h2> </div> <p>Recruit assets from Cohorts for the given parameters.</p> <p><strong>NOTE</strong> that we set the <code>asset.isReserved=true</code> flag so it cant be recruited by anyone else.</p> <div id= "#Functions##_CohortCan" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The Cohort.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>Misson type(s).</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Categories</strong></strong> </p> </div> <div class="w3-half"> <p>Group categories.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Attributes</strong></strong> </p> </div> <div class="w3-half"> <p>Group attributes. See <code>GROUP.Attribute.</code></p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Properties</strong></strong> </p> </div> <div class="w3-half"> <p>DCS attributes.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>WeaponTypes</strong></strong> </p> </div> <div class="w3-half"> <p>Bit of weapon types.</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##(Vec2)">DCS#Vec2</a> <strong><strong>TargetVec2</strong></strong> </p> </div> <div class="w3-half"> <p>Target position.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <strong><strong>RangeMax</strong></strong> </p> </div> <div class="w3-half"> <p>Max range in meters.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>RefuelSystem</strong></strong> </p> </div> <div class="w3-half"> <p>Refueling system (boom or probe).</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>CargoWeight</strong></strong> </p> </div> <div class="w3-half"> <p>Cargo weight [kg]. This checks the cargo bay of the cohort assets and ensures that it is large enough to carry the given cargo weight.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>MaxWeight</strong></strong> </p> </div> <div class="w3-half"> <p>Max weight [kg]. This checks whether the cohort asset group is not too heavy.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>Returns <code>true</code> if given cohort can meet all requirements.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CountPayloads" ><strong>BRIGADE:_CountPayloads(MissionType, Cohorts, Payloads)</strong></a></h2> </div> <p>Count payloads of all cohorts for all unit types.</p> <div id= "#Functions##_CountPayloads" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Cohorts</strong></strong> </p> </div> <div class="w3-half"> <p>Cohorts included.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Payloads</strong></strong> </p> </div> <div class="w3-half"> <p>(Optional) Special payloads.</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 payloads for each unit type.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CreateFlightGroup" ><strong>BRIGADE:_CreateFlightGroup(asset)</strong></a></h2> </div> <p>Create a new OPS group after an asset was spawned.</p> <div id= "#Functions##_CreateFlightGroup" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.FlightGroup.html##(FLIGHTGROUP)">Ops.FlightGroup#FLIGHTGROUP</a>:</p> </div> <div class="w3-half"> <p>The created flightgroup 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="#(BRIGADE)._GetCohort" ><strong>BRIGADE:_GetCohort(CohortName)</strong></a></h2> </div> <p>Get cohort by name.</p> <div id= "#Functions##_GetCohort" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>CohortName</strong></strong> </p> </div> <div class="w3-half"> <p>Name of the platoon.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a>:</p> </div> <div class="w3-half"> <p>The Cohort 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="#(BRIGADE)._GetCohortOfAsset" ><strong>BRIGADE:_GetCohortOfAsset(Asset)</strong></a></h2> </div> <p>Get cohort of an asset.</p> <div id= "#Functions##_GetCohortOfAsset" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset.</p> </div> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a>:</p> </div> <div class="w3-half"> <p>The Cohort 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="#(BRIGADE)._GetCohorts" ><strong>BRIGADE._GetCohorts(Legions, Cohorts, Operation, OpsQueue)</strong></a></h2> </div> <p>Get cohorts.</p> <div id= "#Functions##_GetCohorts" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>Special legions.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Cohorts</strong></strong> </p> </div> <div class="w3-half"> <p>Special cohorts.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Operation.html##(OPERATION)">Ops.Operation#OPERATION</a> <strong><strong>Operation</strong></strong> </p> </div> <div class="w3-half"> <p>Operation.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>OpsQueue</strong></strong> </p> </div> <div class="w3-half"> <p>Queue of operations.</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>Cohorts.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._OptimizeAssetSelection" ><strong>BRIGADE._OptimizeAssetSelection(assets, MissionType, TargetVec2, IncludePayload, TotalWeight)</strong></a></h2> </div> <p>Optimize chosen assets for the mission at hand.</p> <div id= "#Functions##_OptimizeAssetSelection" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>assets</strong></strong> </p> </div> <div class="w3-half"> <p>Table of (unoptimized) assets.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>MissionType</strong></strong> </p> </div> <div class="w3-half"> <p>Mission type.</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##(Vec2)">DCS#Vec2</a> <strong><strong>TargetVec2</strong></strong> </p> </div> <div class="w3-half"> <p>Target position as 2D vector.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #boolean <strong><strong>IncludePayload</strong></strong> </p> </div> <div class="w3-half"> <p>If <code>true</code>, include the payload in the calulation if the asset has one attached.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>TotalWeight</strong></strong> </p> </div> <div class="w3-half"> <p>The total weight of the cargo to be transported, if applicable.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._TacticalOverview" ><strong>BRIGADE:_TacticalOverview()</strong></a></h2> </div> <p>Display tactical overview.</p> <div id= "#Functions##_TacticalOverview" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__LegionAssetReturned" ><strong>BRIGADE:__LegionAssetReturned(delay, Cohort, Asset)</strong></a></h2> </div> <p>Triggers the FSM event "LegionAssetReturned" after a delay.</p> <div id= "#Functions##__LegionAssetReturned" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds. </p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort the asset belongs to.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset that returned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__MissionAssign" ><strong>BRIGADE:__MissionAssign(delay, Mission, Legions)</strong></a></h2> </div> <p>Triggers the FSM event "MissionAssign" after a delay.</p> <div id= "#Functions##__MissionAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) from which the mission assets are requested.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__MissionCancel" ><strong>BRIGADE:__MissionCancel(delay, Mission)</strong></a></h2> </div> <p>Triggers the FSM event "MissionCancel" after a delay.</p> <div id= "#Functions##__MissionCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__MissionRequest" ><strong>BRIGADE:__MissionRequest(delay, Mission, Assets)</strong></a></h2> </div> <p>Triggers the FSM event "MissionRequest" after a delay.</p> <div id= "#Functions##__MissionRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</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>(Optional) Assets to add.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__OpsOnMission" ><strong>BRIGADE:__OpsOnMission(delay, OpsGroup, Mission)</strong></a></h2> </div> <p>Triggers the FSM event "OpsOnMission" after a delay.</p> <div id= "#Functions##__OpsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> <strong><strong>OpsGroup</strong></strong> </p> </div> <div class="w3-half"> <p>The OPS group on mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__Start" ><strong>BRIGADE:__Start(delay)</strong></a></h2> </div> <p>Triggers the FSM event "Start" after a delay.</p> <p>Starts the LEGION. 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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="#(BRIGADE).__Stop" ><strong>BRIGADE:__Stop(delay)</strong></a></h2> </div> <p>Triggers the FSM event "Stop" after a delay.</p> <p>Stops the LEGION and all its event handlers.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="#(BRIGADE).__TransportAssign" ><strong>BRIGADE:__TransportAssign(delay, Transport, Legions)</strong></a></h2> </div> <p>Triggers the FSM event "TransportAssign" after a delay.</p> <div id= "#Functions##__TransportAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) to which this transport is assigned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__TransportCancel" ><strong>BRIGADE:__TransportCancel(delay, Transport)</strong></a></h2> </div> <p>Triggers the FSM event "TransportCancel" after a delay.</p> <div id= "#Functions##__TransportCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).__TransportRequest" ><strong>BRIGADE:__TransportRequest(delay, Transport)</strong></a></h2> </div> <p>Triggers the FSM event "TransportRequest" after a delay.</p> <div id= "#Functions##__TransportRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #number <strong><strong>delay</strong></strong> </p> </div> <div class="w3-half"> <p>Delay in seconds.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterAssetDead" ><strong>BRIGADE: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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#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="Functional.Warehouse.html##(WAREHOUSE.Pendingitem)">Functional.Warehouse#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="#(BRIGADE).onafterAssetSpawned" ><strong>BRIGADE: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> <p>Creates a new flightgroup element and adds the mission to the flightgroup queue.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#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="Functional.Warehouse.html##(WAREHOUSE.Pendingitem)">Functional.Warehouse#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="#(BRIGADE).onafterCaptured" ><strong>BRIGADE:onafterCaptured(From, Event, To, Coalition, Country)</strong></a></h2> </div> <p>On after "Captured" event.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="#(BRIGADE).onafterDestroyed" ><strong>BRIGADE:onafterDestroyed(From, Event, To)</strong></a></h2> </div> <p>On after "Destroyed" event.</p> <p>Remove assets from cohorts. Stop cohorts.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="#(BRIGADE).onafterLegionAssetReturned" ><strong>BRIGADE:onafterLegionAssetReturned(From, Event, To, Cohort, Asset)</strong></a></h2> </div> <p>On after "LegionAssetReturned" event.</p> <p>Triggered when an asset group returned to its legion.</p> <div id= "#Functions##onafterLegionAssetReturned" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Cohort.html##(COHORT)">Ops.Cohort#COHORT</a> <strong><strong>Cohort</strong></strong> </p> </div> <div class="w3-half"> <p>The cohort the asset belongs to.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#WAREHOUSE.Assetitem</a> <strong><strong>Asset</strong></strong> </p> </div> <div class="w3-half"> <p>The asset that returned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterMissionAssign" ><strong>BRIGADE:onafterMissionAssign(From, Event, To, Mission, Legions)</strong></a></h2> </div> <p>On after "MissionAssign" event.</p> <p>Mission is added to a LEGION mission queue and already requested. Needs assets to be added to the mission already.</p> <div id= "#Functions##onafterMissionAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The LEGIONs.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterMissionCancel" ><strong>BRIGADE:onafterMissionCancel(From, Event, To, Mission)</strong></a></h2> </div> <p>On after "MissionCancel" event.</p> <p>Cancels the missions of all flightgroups. Deletes request from warehouse queue.</p> <div id= "#Functions##onafterMissionCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The mission to be cancelled.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterMissionRequest" ><strong>BRIGADE:onafterMissionRequest(From, Event, To, Mission, Assets)</strong></a></h2> </div> <p>On after "MissionRequest" event.</p> <p>Performs a self request to the warehouse for the mission assets. Sets mission status to REQUESTED.</p> <div id= "#Functions##onafterMissionRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The requested mission.</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>(Optional) Assets to add.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterNewAsset" ><strong>BRIGADE:onafterNewAsset(From, Event, To, asset, assignment)</strong></a></h2> </div> <p>On after "NewAsset" event.</p> <p>Asset is added to the given cohort (asset assignment).</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Assetitem)">Functional.Warehouse#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="#(BRIGADE).onafterOpsOnMission" ><strong>BRIGADE:onafterOpsOnMission(From, Event, To, OpsGroup, Mission)</strong></a></h2> </div> <p>On after "OpsOnMission".</p> <div id= "#Functions##onafterOpsOnMission" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsGroup.html##(OPSGROUP)">Ops.OpsGroup#OPSGROUP</a> <strong><strong>OpsGroup</strong></strong> </p> </div> <div class="w3-half"> <p>Ops group on mission</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <strong><strong>Mission</strong></strong> </p> </div> <div class="w3-half"> <p>The requested mission.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterRequest" ><strong>BRIGADE:onafterRequest(From, Event, To, Request)</strong></a></h2> </div> <p>On after "Request" event.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Queueitem)">Functional.Warehouse#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="#(BRIGADE).onafterRequestSpawned" ><strong>BRIGADE:onafterRequestSpawned(From, Event, To, Request, CargoGroupSet, TransportGroupSet)</strong></a></h2> </div> <p>On after "RequestSpawned" event.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Pendingitem)">Functional.Warehouse#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="#(BRIGADE).onafterSelfRequest" ><strong>BRIGADE:onafterSelfRequest(From, Event, To, groupset, request)</strong></a></h2> </div> <p>On after "SelfRequest" event.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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="Functional.Warehouse.html##(WAREHOUSE.Pendingitem)">Functional.Warehouse#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="#(BRIGADE).onafterStart" ><strong>BRIGADE:onafterStart(From, Event, To)</strong></a></h2> </div> <p>Start LEGION FSM.</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><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </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>To</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="#(BRIGADE).onafterTransportAssign" ><strong>BRIGADE:onafterTransportAssign(From, Event, To, Transport, Legions)</strong></a></h2> </div> <p>On after "TransportAssign" event.</p> <p>Transport is added to a LEGION transport queue and assets are requested from the LEGION warehouse.</p> <div id= "#Functions##onafterTransportAssign" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #table <strong><strong>Legions</strong></strong> </p> </div> <div class="w3-half"> <p>The legion(s) to which the transport is assigned.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterTransportCancel" ><strong>BRIGADE:onafterTransportCancel(From, Event, To, Transport)</strong></a></h2> </div> <p>On after "TransportCancel" event.</p> <div id= "#Functions##onafterTransportCancel" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Transport</strong></strong> </p> </div> <div class="w3-half"> <p>The transport to be cancelled.</p> </div> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).onafterTransportRequest" ><strong>BRIGADE:onafterTransportRequest(From, Event, To, Opstransport, OpsTransport)</strong></a></h2> </div> <p>On after "TransportRequest" event.</p> <p>Performs a self request to the warehouse for the transport assets. Sets transport status to REQUESTED.</p> <div id= "#Functions##onafterTransportRequest" class="w3-show w3-white"> <div class="w3-container w3-white" id="functiontype"> <h2><strong>Defined in:</strong></h2> <div class="w3-margin-left"> <p><a href="Ops.Legion.html##(LEGION)">Ops.Legion#LEGION</a></p> </div> <h2><strong>Parameters:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>From</strong></strong> </p> </div> <div class="w3-half"> <p>From state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>Event</strong></strong> </p> </div> <div class="w3-half"> <p>Event.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> #string <strong><strong>To</strong></strong> </p> </div> <div class="w3-half"> <p>To state.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <a href="Ops.OpsTransport.html##(OPSTRANSPORT)">Ops.OpsTransport#OPSTRANSPORT</a> <strong><strong>Opstransport</strong></strong> </p> </div> <div class="w3-half"> <p>The requested mission.</p> </div> </div> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-half"> <p> <strong><strong>OpsTransport</strong></strong> </p> </div> <div class="w3-half"> <p></p> </div> </div> </div> </div> </div> <div class="fields w3-container w3-theme-l2"> <h2>Field(s)</h2> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).ClassName" ><strong>BRIGADE.ClassName</strong></a> <p>Name of the class.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).lid" ><strong>BRIGADE.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"> #table <a id="#(BRIGADE).rearmingZones" ><strong>BRIGADE.rearmingZones</strong></a> <p>Rearming zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #table <a id="#(BRIGADE).refuellingZones" ><strong>BRIGADE.refuellingZones</strong></a> <p>Refuelling zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> <a id="#(BRIGADE).retreatZones" ><strong>BRIGADE.retreatZones</strong></a> <p>Retreat zone set.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #number <a id="#(BRIGADE).verbose" ><strong>BRIGADE.verbose</strong></a> <p>Verbosity of output.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).version" ><strong>BRIGADE.version</strong></a> <p>BRIGADE class version.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).warehouseOpsElement" ><strong>BRIGADE.warehouseOpsElement</strong></a> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Ops.NavyGroup.html##(NAVYGROUP)">Ops.NavyGroup#NAVYGROUP</a> <a id="#(BRIGADE).warehouseOpsGroup" ><strong>BRIGADE.warehouseOpsGroup</strong></a> </div> </div> <div class="functions w3-container w3-theme-l2"> <h2>Function(s)</h2> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddAsset" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AddOffRoadPath" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AddRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AddShippingLane" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AirbaseCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AirbaseRecaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Arrived" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AssetDead" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AssetLowFuel" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).AssetSpawned" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Attacked" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Captured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).ChangeCountry" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Defeated" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Delivered" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Destroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).FilterStock" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).FindAssetInDB" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).FindNearestWarehouse" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).FindWarehouseInDB" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetAirbase" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Wrapper.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="#(BRIGADE).GetAirbaseCategory" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetAirbaseName" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#string:</p> </div> <div class="w3-half"> <p>name of the 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="#(BRIGADE).GetAssetByID" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetAssetByName" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetAssignment" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).GetCoalition" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetCoalitionName" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetCoordinate" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>:</p> </div> <div class="w3-half"> <p>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="#(BRIGADE).GetCountry" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetCountryName" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetNumberOfAssets" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetRequestByID" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetRunwayRepairtime" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).GetSpawnZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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.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="#(BRIGADE).GetStockInfo" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).GetVec2" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="DCS.html##(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="#(BRIGADE).GetVec3" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p><a href="DCS.html##(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="#(BRIGADE).GetWarehouseZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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.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="#(BRIGADE).HasConnectionNaval" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).HasConnectionOffRoad" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).HasConnectionRail" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).HasConnectionRoad" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).IsAttacked" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsDestroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsLoaded" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsNotReadyYet" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsPaused" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsRunning" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsRunwayOperational" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <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="#(BRIGADE).IsShip" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <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="#(BRIGADE).IsStatic" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <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="#(BRIGADE).IsStopped" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If true, 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="#(BRIGADE).IsUnit" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Return value:</strong></h2> <div class="w3-row w3-border-bottom w3-margin-left"> <div class="w3-half"> <p>#boolean:</p> </div> <div class="w3-half"> <p>If <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="#(BRIGADE).Load" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).New" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).NewAsset" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).OnAfterAirbaseCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterAirbaseRecaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterArrived" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterAssetDead" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterAssetLowFuel" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterAssetSpawned" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterAttacked" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterChangeCountry" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterDefeate" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterDelivered" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterDestroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterLoad" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterNewAsset" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterRespawn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterSave" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnAfterSelfRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).OnBeforeRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).Pause" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Request" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).Respawn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Restart" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Save" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SelfRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).SetAirbase" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).SetAllowSpawnOnClientParking" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetAutoDefenceOff" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetAutoDefenceOn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetDebugOff" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetDebugOn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetHarborZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE).SetLowFuelThreshold" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetMarker" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetParkingIDs" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetPortZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE).SetRailConnection" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE).SetReportOff" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetReportOn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetRespawnAfterDestroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetRoadConnection" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE).SetRunwayRepairtime" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetSafeParkingOff" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetSafeParkingOn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE).SetSaveOnMissionEnd" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetSpawnZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE).SetStatusUpdate" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetVerbosityLevel" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).SetWarehouseZone" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE).Start" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Status" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).Stop" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).UnPause" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._Arrived" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._AssetItemInfo" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._CheckAirbaseOwner" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CheckAssetStatus" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CheckConquered" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CheckFuel" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._CheckParkingAsset" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._CheckParkingValid" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._CheckQueue" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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="##(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="#(BRIGADE)._CheckRequestConsistancy" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._CheckRequestNow" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._CheckRequestValid" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._DebugMessage" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._DeleteQueueItem" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._DeleteQueueItemByID" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._DeleteStockItem" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._DisplayStatus" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._DisplayStockItems" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._ErrorMessage" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._FilterStock" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._FindParkingForAssets" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._Fireworks" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>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="#(BRIGADE)._GetAttribute" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetFlightplan" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetIDsFromGroup" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetIDsFromGroupName" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._GetMaxHeight" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._GetNameWithOut" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetObjectSize" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetRequestOfGroup" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetStockAssetsText" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._GetTerminal" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GetTransportsForAssets" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._GroupIsTransport" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._HasAttribute" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._InfoMessage" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._JobDone" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._NewLane" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._OnEventArrived" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventBaseCaptured" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventBirth" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventCrashOrDead" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventEngineShutdown" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventEngineStartup" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventLanding" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventMissionEnd" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._OnEventTakeOff" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><strong>Parameter:</strong></h2> <div class="w3-row w3-margin-left w3-border-bottom w3-border-l2"> <div class="w3-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="#(BRIGADE)._PassingWaypoint" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._PrintQueue" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._QuantityRel2Abs" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._RegisterAsset" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._RouteAir" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._RouteGround" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._RouteNaval" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._RouteTrain" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._SimpleTaskFunction" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._SimpleTaskFunctionWP" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._SortQueue" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> </div> </div> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE)._SpawnAssetAircraft" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._SpawnAssetGroundNaval" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE)._SpawnAssetPrepareTemplate" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._SpawnAssetRequest" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._UnitDead" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </div> <h2><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="#(BRIGADE)._UpdateWarehouseMarkText" ><strong>BRIGADE:_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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</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>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="#(BRIGADE).__AddAsset" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AddRequest" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AirbaseCaptured" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AirbaseRecaptured" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Arrived" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AssetDead" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AssetLowFuel" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__AssetSpawned" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Attacked" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Captured" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__ChangeCountry" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Defeated" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Delivered" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Destroyed" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Load" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__NewAsset" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Pause" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Request" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Respawn" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Restart" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Save" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__SelfRequest" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Start" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Status" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Stop" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).__Unpause" ><strong>BRIGADE:__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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAddAsset" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAddRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAirbaseCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAirbaseRecaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterArrived" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAssetDead" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAssetSpawned" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterAttacked" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterChangeCountry" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterDefeated" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterDelivered" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterDestroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterLoad" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterNewAsset" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterPause" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRequestSpawned" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRespawn" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRestart" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRunwayDestroyed" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterRunwayRepaired" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterSave" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterSelfRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterStart" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterStatus" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterStop" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterUnloaded" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onafterUnpause" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeAddRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeArrived" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeCaptured" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeChangeCountry" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeLoad" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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="#(BRIGADE).onbeforeRequest" ><strong>BRIGADE: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><a href="Functional.Warehouse.html##(WAREHOUSE)">Functional.Warehouse#WAREHOUSE</a></p> </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"> #string <a id="#(BRIGADE).ClassName" ><strong>BRIGADE.ClassName</strong></a> <p>Name of the class.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).lid" ><strong>BRIGADE.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"> #table <a id="#(BRIGADE).rearmingZones" ><strong>BRIGADE.rearmingZones</strong></a> <p>Rearming zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #table <a id="#(BRIGADE).refuellingZones" ><strong>BRIGADE.refuellingZones</strong></a> <p>Refuelling zones. Each element is of type <code>#BRIGADE.SupplyZone</code>.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Core.Set.html##(SET_ZONE)">Core.Set#SET_ZONE</a> <a id="#(BRIGADE).retreatZones" ><strong>BRIGADE.retreatZones</strong></a> <p>Retreat zone set.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #number <a id="#(BRIGADE).verbose" ><strong>BRIGADE.verbose</strong></a> <p>Verbosity of output.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #string <a id="#(BRIGADE).version" ><strong>BRIGADE.version</strong></a> <p>BRIGADE class version.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a id="#(BRIGADE).warehouseOpsElement" ><strong>BRIGADE.warehouseOpsElement</strong></a> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Ops.NavyGroup.html##(NAVYGROUP)">Ops.NavyGroup#NAVYGROUP</a> <a id="#(BRIGADE).warehouseOpsGroup" ><strong>BRIGADE.warehouseOpsGroup</strong></a> </div> </div> <div class="functions w3-container w3-theme-l2"> <h2>Function(s)</h2> </div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <div class="w3-theme-l2"> <h2><a id="#(BRIGADE).AddEndState" ><strong>BRIGADE: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="#(BRIGADE).AddProcess" ><strong>BRIGADE: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="#(BRIGADE).AddScore" ><strong>BRIGADE: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="#(BRIGADE).AddScoreProcess" ><strong>BRIGADE: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="#(BRIGADE).AddTransition" ><strong>BRIGADE: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="#(BRIGADE).GetCurrentState" ><strong>BRIGADE: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="#(BRIGADE).GetEndStates" ><strong>BRIGADE: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="#(BRIGADE).GetProcess" ><strong>BRIGADE: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="#(BRIGADE).GetProcesses" ><strong>BRIGADE: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="#(BRIGADE).GetScores" ><strong>BRIGADE: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="#(BRIGADE).GetStartState" ><strong>BRIGADE: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="#(BRIGADE).GetState" ><strong>BRIGADE: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="#(BRIGADE).GetSubs" ><strong>BRIGADE: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="#(BRIGADE).GetTransitions" ><strong>BRIGADE: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="#(BRIGADE).Is" ><strong>BRIGADE: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="#(BRIGADE).LoadCallBacks" ><strong>BRIGADE: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="#(BRIGADE).New" ><strong>BRIGADE: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="#(BRIGADE).SetProcess" ><strong>BRIGADE: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="#(BRIGADE).SetStartState" ><strong>BRIGADE: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="#(BRIGADE)._add_to_map" ><strong>BRIGADE:_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="#(BRIGADE)._call_handler" ><strong>BRIGADE:_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="#(BRIGADE)._create_transition" ><strong>BRIGADE:_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="#(BRIGADE)._delayed_transition" ><strong>BRIGADE:_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="#(BRIGADE)._eventmap" ><strong>BRIGADE:_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="#(BRIGADE)._gosub" ><strong>BRIGADE:_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="#(BRIGADE)._handler" ><strong>BRIGADE:_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="#(BRIGADE)._isendstate" ><strong>BRIGADE:_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="#(BRIGADE)._submap" ><strong>BRIGADE:_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="#(BRIGADE).can" ><strong>BRIGADE: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="#(BRIGADE).cannot" ><strong>BRIGADE: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="#(BRIGADE).is" ><strong>BRIGADE: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> </div> <div onclick="myFunction('#Types##BRIGADE.SupplyZone')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(BRIGADE.SupplyZone)">Type <strong>BRIGADE.SupplyZone</strong></a></h2></div> <div id= "#Types##BRIGADE.SupplyZone" class="w3-container w3-white w3-padding-16" id="module_other_types"> <div class="w3-white" id="record_type"> <p>Supply Zone.</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.Marker.html##(MARKER)">Wrapper.Marker#MARKER</a> <a id="#(BRIGADE.SupplyZone).marker" ><strong>BRIGADE.SupplyZone.marker</strong></a> <p>F10 marker.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> #boolean <a id="#(BRIGADE.SupplyZone).markerOn" ><strong>BRIGADE.SupplyZone.markerOn</strong></a> <p>If <code>true</code>, marker is on.</p> </div> </div> <div> <div class="w3-card-2 w3-padding-small w3-margin-top"> <a href="Ops.Auftrag.html##(AUFTRAG)">Ops.Auftrag#AUFTRAG</a> <a id="#(BRIGADE.SupplyZone).mission" ><strong>BRIGADE.SupplyZone.mission</strong></a> <p>Mission assigned to supply ammo or fuel.</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="#(BRIGADE.SupplyZone).zone" ><strong>BRIGADE.SupplyZone.zone</strong></a> <p>The zone.</p> </div> </div> <div class="functions w3-container w3-theme-l2"> <h2>Function(s)</h2> </div> </div> </div> </div> <script> function myLoadFunction() { document.getElementById("myHeader").style.backgroundImage = "url('../Images/OPS_Brigade_.png')"; } </script> </div> <script> function w3_open() { document.getElementsByClassName("w3-sidenav")[0].style.width = "95vw"; document.getElementsByClassName("w3-sidenav")[0].style.maxWidth = "1400px"; document.getElementsByClassName("w3-sidenav")[0].style.display = "block"; } function w3_close() { document.getElementsByClassName("w3-sidenav")[0].style.display = "none"; } function myFunction(id) { var x = document.getElementById(id); if (x.className.indexOf("w3-show") == -1) { x.className += " w3-show"; } else { x.className = x.className.replace(" w3-show", ""); } } </script> </body> </html>