mirror of
https://github.com/FlightControl-Master/MOOSE_DOCS.git
synced 2025-08-15 10:37:49 +00:00
MOOSE generated documentation [skip ci]
This commit is contained in:
Applevangelist
@@ -1566,6 +1566,17 @@
|
||||
</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>
|
||||
@@ -1819,6 +1830,27 @@
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="w3-theme-d2 w3-margin-top ">
|
||||
<table class="w3-table w3-left-align w3-theme-d2" onclick="myFunction('#Globals##Warehouse')">
|
||||
<tr>
|
||||
<td class="style="width:40%;"><p><h2>Global <strong>Warehouse</strong></h2></p></td>
|
||||
<td class="style="width:60%;">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
<div id= "#Globals##Warehouse" class="w3-container w3-white w3-padding-small">
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<a href="##(Warehouse)">#Warehouse</a>
|
||||
<a id="Warehouse" ><strong>Warehouse</strong></a>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -3359,6 +3391,19 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).ID">Airbase.ID</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Identifier of an airbase. It assigned to an airbase by the Mission Editor automatically. This identifier is used in AI tasks to refer an airbase that exists (spawned and not dead) or not. </p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).autoCapture">Airbase:autoCapture(setting)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Enables or disables the airbase and FARP auto capture game mechanic where ownership of a base can change based on the presence of ground forces or the
|
||||
default setting assigned in the editor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).autoCaptureIsOn">Airbase:autoCaptureIsOn()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the current autoCapture setting for the passed base.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
@@ -3389,12 +3434,30 @@
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).getID">Airbase:getID()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns identifier of the airbase.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).getResourceMap">Airbase:getResourceMap()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the wsType of every object that exists in DCS.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).getUnit">Airbase:getUnit()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns Unit that is corresponded to the airbase.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).getWarehouse">Airbase:getWarehouse()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the warehouse object associated with the airbase object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Airbase).setCoalition">Airbase:setCoalition(coa)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Changes the passed airbase object's coalition to the set value.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -5362,6 +5425,73 @@ First value indicates if at least one of the unit's radar(s) is on.</p>
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Vec3).z">Vec3.z</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>is directed to the East</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Warehouse)">Type <strong>Warehouse</strong></a></h2></div>
|
||||
<div class="w3-card-4 w3-padding w3-margin w3-theme-l1">
|
||||
<strong><a href="##(Warehouse)">Warehouse</a></strong>
|
||||
</div>
|
||||
<div class="w3-card w3-margin">
|
||||
<table class="w3-table w3-border-bottom w3-border-theme-l2">
|
||||
<tr class="w3-theme-l1">
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16"word-wrap: break-word">Fields and Methods inherited from Warehouse</th>
|
||||
<th class="w3-half w3-left-align w3-container w3-padding-16">Description</th>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).addItem">Warehouse:addItem(itemName, count)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Adds the passed amount of a given item to the warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).addLiquid">Warehouse:addLiquid(liquidType, count)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Adds the passed amount of a liquid fuel into the warehouse inventory.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).getInventory">Warehouse:getInventory(itemName)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns a full itemized list of everything currently in a warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).getItemCount">Warehouse:getItemCount(itemName)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the number of the passed type of item currently in a warehouse object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).getLiquidAmount">Warehouse:getLiquidAmount(liquidType)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the amount of the passed liquid type within a given warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).getOwner">Warehouse:getOwner()</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Returns the airbase object associated with the warehouse object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).removeItem">Warehouse:removeItem(itemName, count)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Removes the amount of the passed item from the warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).setItem">Warehouse:setItem(itemName, count)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Sets the passed amount of a given item to the warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="w3-border">
|
||||
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(Warehouse).setLiquidAmount">Warehouse:setLiquidAmount(liquidType, count)</a></p></td>
|
||||
<td class="summary w3-half w3-container" style="word-wrap: break-word">
|
||||
<p>Removes the set amount of liquid from the inventory in a warehouse.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@@ -7886,6 +8016,70 @@ Represents airbases: airdromes, helipads and ships with flying decks or landing
|
||||
</div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Airbase).autoCapture" ><strong>Airbase:autoCapture(setting)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Enables or disables the airbase and FARP auto capture game mechanic where ownership of a base can change based on the presence of ground forces or the
|
||||
default setting assigned in the editor.</p>
|
||||
|
||||
<div id= "#Functions##autoCapture" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Airbase</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#boolean
|
||||
<strong><strong>setting</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p><code>true</code> : enables autoCapture behavior, <code>false</code> : disables autoCapture behavior</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Airbase).autoCaptureIsOn" ><strong>Airbase:autoCaptureIsOn()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the current autoCapture setting for the passed base.</p>
|
||||
|
||||
<div id= "#Functions##autoCaptureIsOn" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Airbase</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p>#boolean:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p><code>true</code> if autoCapture behavior is enabled and <code>false</code> 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="#(Airbase).getByName" ><strong>Airbase.getByName(name)</strong></a></h2>
|
||||
</div>
|
||||
@@ -8063,6 +8257,40 @@ Represents airbases: airdromes, helipads and ships with flying decks or landing
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Airbase).getResourceMap" ><strong>Airbase:getResourceMap()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the wsType of every object that exists in DCS.</p>
|
||||
|
||||
|
||||
<p>A wsType is a table consisting of 4 entries indexed numerically.
|
||||
It can be used to broadly categorize object types. The table can be broken down as: {mainCategory, subCat1, subCat2, index}</p>
|
||||
|
||||
<div id= "#Functions##getResourceMap" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Airbase</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>wsType of every object that exists in DCS.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -8096,6 +8324,76 @@ Represents airbases: airdromes, helipads and ships with flying decks or landing
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Airbase).getWarehouse" ><strong>Airbase:getWarehouse()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the warehouse object associated with the airbase object.</p>
|
||||
|
||||
|
||||
<p>Can then be used to call the warehouse class functions to modify the contents of the warehouse.</p>
|
||||
|
||||
<div id= "#Functions##getWarehouse" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Airbase</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(Warehouse)">#Warehouse</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The DCS warehouse object of this 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="#(Airbase).setCoalition" ><strong>Airbase:setCoalition(coa)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Changes the passed airbase object's coalition to the set value.</p>
|
||||
|
||||
|
||||
<p>Must be used with Airbase.autoCapture to disable auto capturing of the base,
|
||||
otherwise the base can revert back to a different coalition depending on the situation and built in game capture rules.</p>
|
||||
|
||||
<div id= "#Functions##setCoalition" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Airbase</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>coa</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The new owner coalition: 0=neutra, 1=red, 2=blue.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -12664,6 +12962,414 @@ If sensor type is not specified the function returns true if the unit has at lea
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div onclick="myFunction('#Types##Warehouse')" class="w3-container w3-theme-l2 w3-margin-top"><h2><a id="#(Warehouse)">Type <strong>Warehouse</strong></a></h2></div>
|
||||
<div id= "#Types##Warehouse" class="w3-container w3-white w3-padding-16" id="module_other_types">
|
||||
<div class="w3-white" id="record_type">
|
||||
|
||||
<p><a href="https://wiki.hoggitworld.com/view/DCS_Class_Warehouse">DCS Class Warehouse</a>
|
||||
The warehouse class gives control over warehouses that exist in airbase objects.</p>
|
||||
|
||||
|
||||
<p>These warehouses can limit the aircraft, munitions, and fuel available to coalition aircraft.</p>
|
||||
|
||||
<div class="fields w3-container w3-theme-l2">
|
||||
<h2>Field(s)</h2>
|
||||
</div>
|
||||
<div class="functions w3-container w3-theme-l2">
|
||||
<h2>Function(s)</h2>
|
||||
</div>
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).addItem" ><strong>Warehouse:addItem(itemName, count)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Adds the passed amount of a given item to the warehouse.</p>
|
||||
|
||||
|
||||
<p>itemName is the typeName associated with the item: "weapons.missiles.AIM_54C_Mk47"
|
||||
A wsType table can also be used, however the last digit with wsTypes has been known to change. {4, 4, 7, 322}</p>
|
||||
|
||||
<div id= "#Functions##addItem" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>itemName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Name of the item.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>count</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Number of items 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="#(Warehouse).addLiquid" ><strong>Warehouse:addLiquid(liquidType, count)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Adds the passed amount of a liquid fuel into the warehouse inventory.</p>
|
||||
|
||||
<div id= "#Functions##addLiquid" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>liquidType</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>count</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Amount of liquid 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="#(Warehouse).getInventory" ><strong>Warehouse:getInventory(itemName)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns a full itemized list of everything currently in a warehouse.</p>
|
||||
|
||||
|
||||
<p>If a category is set to unlimited then the table will be returned empty.
|
||||
Aircraft and weapons are indexed by strings. Liquids are indexed by number.</p>
|
||||
|
||||
<div id= "#Functions##getInventory" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>itemName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Name of the 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>Itemized list of everything currently in a warehouse</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).getItemCount" ><strong>Warehouse:getItemCount(itemName)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the number of the passed type of item currently in a warehouse object.</p>
|
||||
|
||||
<div id= "#Functions##getItemCount" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>itemName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Name of the item.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).getLiquidAmount" ><strong>Warehouse:getLiquidAmount(liquidType)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the amount of the passed liquid type within a given warehouse.</p>
|
||||
|
||||
<div id= "#Functions##getLiquidAmount" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameter:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>liquidType</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.</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 liquid.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).getOwner" ><strong>Warehouse:getOwner()</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Returns the airbase object associated with the warehouse object.</p>
|
||||
|
||||
<div id= "#Functions##getOwner" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Return value:</strong></h2>
|
||||
<div class="w3-row w3-border-bottom w3-margin-left">
|
||||
<div class="w3-half">
|
||||
<p><a href="##(Airbase)">#Airbase</a>:</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>The airbase object owning this warehouse.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).removeItem" ><strong>Warehouse:removeItem(itemName, count)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Removes the amount of the passed item from the warehouse.</p>
|
||||
|
||||
<div id= "#Functions##removeItem" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>itemName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Name of the item.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>count</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Number of items to be removed.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="w3-card-2 w3-padding-small w3-margin-top">
|
||||
|
||||
<div class="w3-theme-l2">
|
||||
<h2><a id="#(Warehouse).setItem" ><strong>Warehouse:setItem(itemName, count)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Sets the passed amount of a given item to the warehouse.</p>
|
||||
|
||||
<div id= "#Functions##setItem" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#string
|
||||
<strong><strong>itemName</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Name of the item.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>count</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Number of items 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="#(Warehouse).setLiquidAmount" ><strong>Warehouse:setLiquidAmount(liquidType, count)</strong></a></h2>
|
||||
</div>
|
||||
|
||||
<p>Removes the set amount of liquid from the inventory in a warehouse.</p>
|
||||
|
||||
<div id= "#Functions##setLiquidAmount" class="w3-show w3-white">
|
||||
<div class="w3-container w3-white" id="functiontype">
|
||||
<h2><strong>Defined in:</strong></h2>
|
||||
<div class="w3-margin-left">
|
||||
<p>Warehouse</p>
|
||||
</div>
|
||||
<h2><strong>Parameters:</strong></h2>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>liquidType</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Type of liquid to add: 0=jetfuel, 1=aviation gasoline, 2=MW50, 3=Diesel.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
|
||||
<div class="w3-half">
|
||||
<p>
|
||||
#number
|
||||
<strong><strong>count</strong></strong>
|
||||
</p>
|
||||
</div>
|
||||
<div class="w3-half">
|
||||
|
||||
<p>Amount of liquid.</p>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user