weyne/MOOSE_DOCS
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE_DOCS.git synced 2025-08-15 10:37:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

MOOSE generated documentation [skip ci]

Browse Source
This commit is contained in:
Applevangelist
2021-09-07 18:00:08 +00:00
parent cd876d8dab
commit 12a93b163f
24 changed files with 876 additions and 957 deletions
Download Patch File Download Diff File Expand all files Collapse all files

355
Documentation/Ops.CTLD.html
View File

@@ -1594,6 +1594,12 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
-- add infantry unit called "Anti-Tank" using templates "AA" and "AA"", of type TROOP with size 4. No weight. We only have 2 in stock:
my_ctld:AddTroopsCargo("Anti-Air",{"AA","AA2"},CTLD_CARGO.Enum.TROOPS,4,nil,2)
-- add an engineers unit called "Wrenches" using template "Engineers", of type ENGINEERS with size 2. Engineers can be loaded, dropped,
-- and extracted like troops. However, they will seek to build and/or repair crates found in a given radius. Handy if you can\'t stay
-- to build or repair or under fire.
my_ctld:AddTroopsCargo("Wrenches",{"Engineers"},CTLD_CARGO.Enum.ENGINEERS,4)
myctld.EngineerSearch = 2000 -- teams will search for crates in this radius.
-- add vehicle called "Humvee" using template "Humvee", of type VEHICLE, size 2, i.e. needs two crates to be build
-- vehicles and FOB will be spawned as crates in a LOAD zone first. Once transported to DROP zones, they can be build into the objects
my_ctld:AddCratesCargo("Humvee",{"Humvee"},CTLD_CARGO.Enum.VEHICLE,2)
@@ -1607,6 +1613,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
-- add crates to repair FOB or VEHICLE type units - the 2nd parameter needs to match the template you want to repair
my_ctld:AddCratesRepair("Humvee Repair","Humvee",CTLD_CARGO.Enum.REPAIR,1)
my_ctld.repairtime = 300 -- takes 300 seconds to repair something
</code></pre>
<h2>1.3 Add logistics zones</h2>
@@ -1632,8 +1639,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
-- Add a zone of type SHIP to our setup. Players can load troops and crates from this ship
-- "Tarawa" is the unitname (callsign) of the ship from the ME. Players can load, if they are inside the zone.
-- The ship is 240 meters long and 20 meters wide.
-- Note that smoke, flares, beacons don't work for this type of loadzone (yet). Also, you need to adjust
-- the max hover height to deck height plus 5 meters or so for loading to work.
-- Note that you need to adjust the max hover height to deck height plus 5 meters or so for loading to work.
-- When the ship is moving, forcing hoverload might not be a good idea.
my_ctld:AddCTLDZone("Tarawa",CTLD.CargoZoneType.SHIP,SMOKECOLOR.Blue,true,true,240,20)
</code></pre>
@@ -1655,6 +1661,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
my_ctld.smokedistance = 2000 -- Only smoke or flare zones if requesting player unit is this far away (in meters)
my_ctld.suppressmessages = false -- Set to true if you want to script your own messages.
my_ctld.repairtime = 300 -- Number of seconds it takes to repair a unit.
my_ctld.cratecountry = country.id.GERMANY -- ID of crates. Don\'t forget to change this matching your coalition!
</code></pre>
<h2>2.1 User functions</h2>
@@ -1665,19 +1672,20 @@ Create the late-activated troops, vehicles (no statics at this point!) that will
<pre><code> -- E.g. update unit capabilities for testing. Please stay realistic in your mission design.
-- Make a Gazelle into a heavy truck, this type can load both crates and troops and eight of each type:
my_ctld:UnitCapabilities("SA342L", true, true, 8, 8)
my_ctld:UnitCapabilities("SA342L", true, true, 8, 8, 12)
Default unit type capabilities are:
-- Default unit type capabilities are:
["SA342Mistral"] = {type="SA342Mistral", crates=false, troops=true, cratelimit = 0, trooplimit = 4},
["SA342L"] = {type="SA342L", crates=false, troops=true, cratelimit = 0, trooplimit = 2},
["SA342M"] = {type="SA342M", crates=false, troops=true, cratelimit = 0, trooplimit = 4},
["SA342Minigun"] = {type="SA342Minigun", crates=false, troops=true, cratelimit = 0, trooplimit = 2},
["UH-1H"] = {type="UH-1H", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
["Mi-8MT"] = {type="Mi-8MT", crates=true, troops=true, cratelimit = 2, trooplimit = 12},
["Ka-50"] = {type="Ka-50", crates=false, troops=false, cratelimit = 0, trooplimit = 0},
["Mi-24P"] = {type="Mi-24P", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
["Mi-24V"] = {type="Mi-24V", crates=true, troops=true, cratelimit = 1, trooplimit = 8},
["SA342Mistral"] = {type="SA342Mistral", crates=false, troops=true, cratelimit = 0, trooplimit = 4, length = 12},
["SA342L"] = {type="SA342L", crates=false, troops=true, cratelimit = 0, trooplimit = 2, length = 12},
["SA342M"] = {type="SA342M", crates=false, troops=true, cratelimit = 0, trooplimit = 4, length = 12},
["SA342Minigun"] = {type="SA342Minigun", crates=false, troops=true, cratelimit = 0, trooplimit = 2, length = 12},
["UH-1H"] = {type="UH-1H", crates=true, troops=true, cratelimit = 1, trooplimit = 8, length = 15},
["Mi-8MT"] = {type="Mi-8MTV2", crates=true, troops=true, cratelimit = 2, trooplimit = 12, length = 15},
["Ka-50"] = {type="Ka-50", crates=false, troops=false, cratelimit = 0, trooplimit = 0, length = 15},
["Mi-24P"] = {type="Mi-24P", crates=true, troops=true, cratelimit = 2, trooplimit = 8, length = 18},
["Mi-24V"] = {type="Mi-24V", crates=true, troops=true, cratelimit = 2, trooplimit = 8, length = 18},
["Hercules"] = {type="Hercules", crates=true, troops=true, cratelimit = 7, trooplimit = 64, length = 25},
</code></pre>
@@ -2388,7 +2396,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).UnitCapabilities">CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).UnitCapabilities">CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>User - Function to add/adjust unittype capabilities.</p>
</td>
@@ -2418,7 +2426,7 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._AddRadioBeacon">CTLD:_AddRadioBeacon(Name, Sound, Mhz, Modulation)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD)._AddRadioBeacon">CTLD:_AddRadioBeacon(Name, Sound, Mhz, Modulation, IsShip)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>(Internal) Add radio beacon to zone.</p>
</td>
@@ -2661,6 +2669,12 @@ be loaded from the Rearm/Refuel menu, i.e. you can drop them into the field, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).coalitiontxt">CTLD.coalitiontxt</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD).cratecountry">CTLD.cratecountry</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -3935,6 +3949,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD.UnitCapabilities).crates">CTLD.UnitCapabilities.crates</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Can transport crate.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(CTLD.UnitCapabilities).length">CTLD.UnitCapabilities.length</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
</td>
</tr>
<tr class="w3-border">
@@ -5501,6 +5521,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -5556,6 +5587,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -5587,7 +5629,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -5630,6 +5672,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -5673,7 +5729,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -5850,6 +5906,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> radio beacons</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).Spawned_Cargo" ><strong>CTLD.Spawned_Cargo</strong></a>
</div>
</div>
@@ -5883,6 +5950,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -5960,6 +6038,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).cratecountry" ><strong>CTLD.cratecountry</strong></a>
<p> country of crates spawned</p>
</div>
</div>
@@ -6102,7 +6194,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> noob catch</p>
<p> time to repair a unit/group</p>
</div>
@@ -8464,7 +8556,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD).UnitCapabilities" ><strong>CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit)</strong></a></h2>
<h2><a id="#(CTLD).UnitCapabilities" ><strong>CTLD:UnitCapabilities(Unittype, Cancrates, Cantroops, Cratelimit, Trooplimit, Length)</strong></a></h2>
</div>
<p>User - Function to add/adjust unittype capabilities.</p>
@@ -8498,7 +8590,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Unit can load crates.</p>
<p>Unit can load crates. Default false.</p>
</div>
</div>
@@ -8511,7 +8603,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Unit can load troops.</p>
<p>Unit can load troops. Default false.</p>
</div>
</div>
@@ -8524,7 +8616,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Unit can carry number of crates.</p>
<p>Unit can carry number of crates. Default 0.</p>
</div>
</div>
@@ -8537,7 +8629,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
<div class="w3-half">
<p>Unit can carry number of troops.</p>
<p>Unit can carry number of troops. Default 0.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#number
<strong><strong>Length</strong></strong>
</p>
</div>
<div class="w3-half">
<p>Unit lenght (in mteres) for the load radius. Default 20.</p>
</div>
</div>
@@ -8549,7 +8654,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(CTLD)._AddRadioBeacon" ><strong>CTLD:_AddRadioBeacon(Name, Sound, Mhz, Modulation)</strong></a></h2>
<h2><a id="#(CTLD)._AddRadioBeacon" ><strong>CTLD:_AddRadioBeacon(Name, Sound, Mhz, Modulation, IsShip)</strong></a></h2>
</div>
<p>(Internal) Add radio beacon to zone.</p>
@@ -8614,6 +8719,19 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Modulation AM or FM.</p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#boolean
<strong><strong>IsShip</strong></strong>
</p>
</div>
<div class="w3-half">
<p>If true zone is a ship.</p>
</div>
</div>
</div>
@@ -11380,6 +11498,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -11435,6 +11564,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -11466,7 +11606,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -11509,6 +11649,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -11552,7 +11706,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -11729,6 +11883,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> radio beacons</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).Spawned_Cargo" ><strong>CTLD.Spawned_Cargo</strong></a>
</div>
</div>
@@ -11762,6 +11927,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -11839,6 +12015,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).cratecountry" ><strong>CTLD.cratecountry</strong></a>
<p> country of crates spawned</p>
</div>
</div>
@@ -11981,7 +12171,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> noob catch</p>
<p> time to repair a unit/group</p>
</div>
@@ -13518,6 +13708,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="fields w3-container w3-theme-l2">
<h2>Field(s)</h2>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CargoCounter" ><strong>CTLD.CargoCounter</strong></a>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -13573,6 +13774,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p>Name of the class.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).CrateCounter" ><strong>CTLD.CrateCounter</strong></a>
</div>
</div>
@@ -13604,7 +13816,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).CtldUnits" ><strong>CTLD.CtldUnits</strong></a>
@@ -13647,6 +13859,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).Engineers" ><strong>CTLD.Engineers</strong></a>
<p>use as counter</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
@@ -13690,7 +13916,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).FreeUHFFrequencies" ><strong>CTLD.FreeUHFFrequencies</strong></a>
@@ -13867,6 +14093,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> radio beacons</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#table
<a id="#(CTLD).Spawned_Cargo" ><strong>CTLD.Spawned_Cargo</strong></a>
</div>
</div>
@@ -13900,6 +14137,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD).TroopCounter" ><strong>CTLD.TroopCounter</strong></a>
</div>
</div>
@@ -13977,6 +14225,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a id="#(CTLD).cratecountry" ><strong>CTLD.cratecountry</strong></a>
<p> country of crates spawned</p>
</div>
</div>
@@ -14119,7 +14381,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<p> noob catch</p>
<p> time to repair a unit/group</p>
</div>
@@ -17902,6 +18164,17 @@ BASE:TraceOnOff( false )</code></pre>
<p>Can transport crate.</p>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
#number
<a id="#(CTLD.UnitCapabilities).length" ><strong>CTLD.UnitCapabilities.length</strong></a>
</div>
</div>
@@ -22494,6 +22767,17 @@ BASE:TraceOnOff( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<a id="#(CTLD_ENGINEERING).currwpt" ><strong>CTLD_ENGINEERING.currwpt</strong></a>
</div>
</div>
@@ -23147,6 +23431,17 @@ BASE:TraceOnOff( false )</code></pre>
</div>
</div>
<div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a>
<a id="#(CTLD_ENGINEERING).currwpt" ><strong>CTLD_ENGINEERING.currwpt</strong></a>
</div>
</div>