mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Documentation improvements.
This commit is contained in:
FlightControl_Master
parent
a8e77bddd4
commit
7cab0ca22a
@ -1,67 +1,21 @@
|
||||
--- **Functional** -- This module monitors airbases traffic.
|
||||
--- **Functional** -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.
|
||||
--
|
||||
-- ===
|
||||
--
|
||||
-- 1) @{AirbasePolice#AIRBASEPOLICE_BASE} class, extends @{Base#BASE}
|
||||
-- ==================================================================
|
||||
-- The @{AirbasePolice#AIRBASEPOLICE_BASE} class provides the main methods to monitor CLIENT behaviour at airbases.
|
||||
-- CLIENTS should not be allowed to:
|
||||
--
|
||||
-- * Don't taxi faster than 40 km/h.
|
||||
-- * Don't take-off on taxiways.
|
||||
-- * Avoid to hit other planes on the airbase.
|
||||
-- * Obey ground control orders.
|
||||
--
|
||||
-- 2) @{AirbasePolice#AIRBASEPOLICE_CAUCASUS} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE}
|
||||
-- =============================================================================================
|
||||
-- All the airbases on the caucasus map can be monitored using this class.
|
||||
-- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names.
|
||||
-- The following names can be given:
|
||||
-- * AnapaVityazevo
|
||||
-- * Batumi
|
||||
-- * Beslan
|
||||
-- * Gelendzhik
|
||||
-- * Gudauta
|
||||
-- * Kobuleti
|
||||
-- * KrasnodarCenter
|
||||
-- * KrasnodarPashkovsky
|
||||
-- * Krymsk
|
||||
-- * Kutaisi
|
||||
-- * MaykopKhanskaya
|
||||
-- * MineralnyeVody
|
||||
-- * Mozdok
|
||||
-- * Nalchik
|
||||
-- * Novorossiysk
|
||||
-- * SenakiKolkhi
|
||||
-- * SochiAdler
|
||||
-- * Soganlug
|
||||
-- * SukhumiBabushara
|
||||
-- * TbilisiLochini
|
||||
-- * Vaziani
|
||||
--
|
||||
-- 3) @{AirbasePolice#AIRBASEPOLICE_NEVADA} class, extends @{AirbasePolice#AIRBASEPOLICE_BASE}
|
||||
-- =============================================================================================
|
||||
-- All the airbases on the NEVADA map can be monitored using this class.
|
||||
-- If you want to monitor specific airbases, you need to use the @{#AIRBASEPOLICE_BASE.Monitor}() method, which takes a table or airbase names.
|
||||
-- The following names can be given:
|
||||
-- * Nellis
|
||||
-- * McCarran
|
||||
-- * Creech
|
||||
-- * Groom Lake
|
||||
--
|
||||
-- ### Contributions: Dutch Baron - Concept & Testing
|
||||
-- ### Author: FlightControl - Framework Design & Programming
|
||||
--
|
||||
-- ===
|
||||
--
|
||||
-- @module AirbasePolice
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
--- @type AIRBASEPOLICE_BASE
|
||||
-- @field Core.Set#SET_CLIENT SetClient
|
||||
-- @extends Core.Base#BASE
|
||||
|
||||
--- Base class for AIRBASEPOLICE implementations.
|
||||
-- @field #AIRBASEPOLICE_BASE
|
||||
AIRBASEPOLICE_BASE = {
|
||||
ClassName = "AIRBASEPOLICE_BASE",
|
||||
SetClient = nil,
|
||||
@ -224,9 +178,82 @@ end
|
||||
|
||||
|
||||
--- @type AIRBASEPOLICE_CAUCASUS
|
||||
-- @field Core.Set#SET_CLIENT SetClient
|
||||
-- @extends #AIRBASEPOLICE_BASE
|
||||
|
||||
--- # AIRBASEPOLICE_CAUCASUS, extends @{#AIRBASEPOLICE_BASE}
|
||||
--
|
||||
-- 
|
||||
--
|
||||
-- The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.
|
||||
-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
|
||||
--
|
||||
-- The maximum speed for the airbases at Caucasus is **50 km/h**.
|
||||
--
|
||||
-- The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving
|
||||
-- faster than the maximum allowed speed, the pilot will be kicked.
|
||||
--
|
||||
-- Different airbases have different maximum speeds, according safety regulations.
|
||||
--
|
||||
-- # Airbases monitored
|
||||
--
|
||||
-- The following airbases are monitored at the Caucasus region:
|
||||
--
|
||||
-- * Anapa Vityazevo
|
||||
-- * Batumi
|
||||
-- * Beslan
|
||||
-- * Gelendzhik
|
||||
-- * Gudauta
|
||||
-- * Kobuleti
|
||||
-- * Krasnodar Center
|
||||
-- * Krasnodar Pashkovsky
|
||||
-- * Krymsk
|
||||
-- * Kutaisi
|
||||
-- * Maykop Khanskaya
|
||||
-- * Mineralnye Vody
|
||||
-- * Mozdok
|
||||
-- * Nalchik
|
||||
-- * Novorossiysk
|
||||
-- * Senaki Kolkhi
|
||||
-- * Sochi Adler
|
||||
-- * Soganlug
|
||||
-- * Sukhumi Babushara
|
||||
-- * Tbilisi Lochini
|
||||
-- * Vaziani
|
||||
--
|
||||
--
|
||||
-- # Installation
|
||||
--
|
||||
-- ## In Single Player Missions
|
||||
--
|
||||
-- AIRBASEPOLICE is fully functional in single player.
|
||||
--
|
||||
-- ## In Multi Player Missions
|
||||
--
|
||||
-- AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission.
|
||||
-- Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player.
|
||||
-- To work around this problem, a much better solution has been made, using the slot blocker script designed
|
||||
-- by Ciribob. With the help of __Ciribob__, this script has been extended to also kick client players while in flight.
|
||||
-- AIRBASEPOLICE is communicating with this modified script to kick players!
|
||||
--
|
||||
-- Install the file **SimpleSlotBlockGameGUI.lua** on the server, following the installation instructions described by Ciribob.
|
||||
--
|
||||
-- [Simple Slot Blocker from Ciribob & FlightControl](https://github.com/ciribob/DCS-SimpleSlotBlock)
|
||||
--
|
||||
-- # Script it!
|
||||
--
|
||||
-- ## 1. AIRBASEPOLICE_CAUCASUS Constructor
|
||||
--
|
||||
-- Creates a new AIRBASEPOLICE_CAUCASUS object that will monitor pilots taxiing behaviour.
|
||||
--
|
||||
-- -- This creates a new AIRBASEPOLICE_CAUCASUS object.
|
||||
--
|
||||
-- -- Create a set of all clients in the mission.
|
||||
-- AllClientsSet = SET_CLIENT:New():FilterStart()
|
||||
--
|
||||
-- -- Monitor for these clients the airbases.
|
||||
-- AirbasePoliceCaucasus = AIRBASEPOLICE_CAUCASUS:New( AllClientsSet )
|
||||
--
|
||||
-- @field #AIRBASEPOLICE_CAUCASUS
|
||||
AIRBASEPOLICE_CAUCASUS = {
|
||||
ClassName = "AIRBASEPOLICE_CAUCASUS",
|
||||
Airbases = {
|
||||
@ -966,6 +993,63 @@ end
|
||||
|
||||
--- @type AIRBASEPOLICE_NEVADA
|
||||
-- @extends Functional.AirbasePolice#AIRBASEPOLICE_BASE
|
||||
|
||||
|
||||
--- # AIRBASEPOLICE_NEVADA, extends @{#AIRBASEPOLICE_BASE}
|
||||
--
|
||||
-- 
|
||||
--
|
||||
-- The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi.
|
||||
-- The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.
|
||||
--
|
||||
-- The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving
|
||||
-- faster than the maximum allowed speed, the pilot will be kicked.
|
||||
--
|
||||
-- Different airbases have different maximum speeds, according safety regulations.
|
||||
--
|
||||
-- # Airbases monitored
|
||||
--
|
||||
-- The following airbases are monitored at the Caucasus region:
|
||||
--
|
||||
-- * Nellis
|
||||
-- * McCarran
|
||||
-- * Creech
|
||||
-- * GroomLake
|
||||
--
|
||||
--
|
||||
-- # Installation
|
||||
--
|
||||
-- ## In Single Player Missions
|
||||
--
|
||||
-- AIRBASEPOLICE is fully functional in single player.
|
||||
--
|
||||
-- ## In Multi Player Missions
|
||||
--
|
||||
-- AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission.
|
||||
-- Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player.
|
||||
-- To work around this problem, a much better solution has been made, using the slot blocker script designed
|
||||
-- by Ciribob. With the help of Ciribob, this script has been extended to also kick client players while in flight.
|
||||
-- AIRBASEPOLICE is communicating with this modified script to kick players!
|
||||
--
|
||||
-- Install the file **SimpleSlotBlockGameGUI.lua** on the server, following the installation instructions described by Ciribob.
|
||||
--
|
||||
-- [Simple Slot Blocker from Ciribob & FlightControl](https://github.com/ciribob/DCS-SimpleSlotBlock)
|
||||
--
|
||||
-- # Script it!
|
||||
--
|
||||
-- ## 1. AIRBASEPOLICE_NEVADA Constructor
|
||||
--
|
||||
-- Creates a new AIRBASEPOLICE_NEVADA object that will monitor pilots taxiing behaviour.
|
||||
--
|
||||
-- -- This creates a new AIRBASEPOLICE_NEVADA object.
|
||||
--
|
||||
-- -- Create a set of all clients in the mission.
|
||||
-- AllClientsSet = SET_CLIENT:New():FilterStart()
|
||||
--
|
||||
-- -- Monitor for these clients the airbases.
|
||||
-- AirbasePoliceCaucasus = AIRBASEPOLICE_NEVADA:New( AllClientsSet )
|
||||
--
|
||||
-- @field #AIRBASEPOLICE_NEVADA
|
||||
AIRBASEPOLICE_NEVADA = {
|
||||
ClassName = "AIRBASEPOLICE_NEVADA",
|
||||
Airbases = {
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -436,7 +437,7 @@ A SET_CLIENT object that will contain the CLIENT objects to be monitored if they
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Functional.Spawn.html##(SPAWN)">Functional.Spawn#SPAWN</a> SpawnAI </em></code>:
|
||||
<p><code><em><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a> SpawnAI </em></code>:
|
||||
The default Spawn object to spawn new AI Groups when needed.</p>
|
||||
|
||||
</li>
|
||||
@ -543,7 +544,7 @@ The SET of <a href="Set.html##(SET_AIRBASE)">Set#SET_AIRBASE</a>s to evaluate wh
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="Functional.Spawn.html##(SPAWN)">Functional.Spawn#SPAWN</a></em>
|
||||
<em><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a></em>
|
||||
<a id="#(AI_BALANCER).SpawnAI" >
|
||||
<strong>AI_BALANCER.SpawnAI</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -830,7 +831,7 @@ Use the method <a href="##(AI_PATROL_ZONE).ManageDamage">AI<em>PATROL</em>ZONE.M
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="Functional.Spawn.html##(SPAWN)">Functional.Spawn#SPAWN</a></em>
|
||||
<em><a href="Core.Spawn.html##(SPAWN)">Core.Spawn#SPAWN</a></em>
|
||||
<a id="#(AI_PATROL_ZONE).CoordTest" >
|
||||
<strong>AI_PATROL_ZONE.CoordTest</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -114,79 +115,49 @@
|
||||
<div id="content">
|
||||
<h1>Module <code>AirbasePolice</code></h1>
|
||||
|
||||
<p><strong>Functional</strong> -- This module monitors airbases traffic.</p>
|
||||
<p><strong>Functional</strong> -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.</p>
|
||||
|
||||
|
||||
|
||||
<hr/>
|
||||
|
||||
<h1>1) <a href="AirbasePolice.html##(AIRBASEPOLICE_BASE)">AirbasePolice#AIRBASEPOLICE_BASE</a> class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
<p>The <a href="AirbasePolice.html##(AIRBASEPOLICE_BASE)">AirbasePolice#AIRBASEPOLICE_BASE</a> class provides the main methods to monitor CLIENT behaviour at airbases.
|
||||
CLIENTS should not be allowed to:</p>
|
||||
|
||||
<ul>
|
||||
<li>Don't taxi faster than 40 km/h.</li>
|
||||
<li>Don't take-off on taxiways.</li>
|
||||
<li>Avoid to hit other planes on the airbase.</li>
|
||||
<li>Obey ground control orders.</li>
|
||||
</ul>
|
||||
|
||||
<h1>2) <a href="AirbasePolice.html##(AIRBASEPOLICE_CAUCASUS)">AirbasePolice#AIRBASEPOLICE_CAUCASUS</a> class, extends <a href="AirbasePolice.html##(AIRBASEPOLICE_BASE)">AirbasePolice#AIRBASEPOLICE_BASE</a></h1>
|
||||
<p>All the airbases on the caucasus map can be monitored using this class.
|
||||
If you want to monitor specific airbases, you need to use the <a href="##(AIRBASEPOLICE_BASE).Monitor">AIRBASEPOLICE_BASE.Monitor</a>() method, which takes a table or airbase names.
|
||||
The following names can be given:
|
||||
* AnapaVityazevo
|
||||
* Batumi
|
||||
* Beslan
|
||||
* Gelendzhik
|
||||
* Gudauta
|
||||
* Kobuleti
|
||||
* KrasnodarCenter
|
||||
* KrasnodarPashkovsky
|
||||
* Krymsk
|
||||
* Kutaisi
|
||||
* MaykopKhanskaya
|
||||
* MineralnyeVody
|
||||
* Mozdok
|
||||
* Nalchik
|
||||
* Novorossiysk
|
||||
* SenakiKolkhi
|
||||
* SochiAdler
|
||||
* Soganlug
|
||||
* SukhumiBabushara
|
||||
* TbilisiLochini
|
||||
* Vaziani</p>
|
||||
|
||||
<h1>3) <a href="AirbasePolice.html##(AIRBASEPOLICE_NEVADA)">AirbasePolice#AIRBASEPOLICE_NEVADA</a> class, extends <a href="AirbasePolice.html##(AIRBASEPOLICE_BASE)">AirbasePolice#AIRBASEPOLICE_BASE</a></h1>
|
||||
<p>All the airbases on the NEVADA map can be monitored using this class.
|
||||
If you want to monitor specific airbases, you need to use the <a href="##(AIRBASEPOLICE_BASE).Monitor">AIRBASEPOLICE_BASE.Monitor</a>() method, which takes a table or airbase names.
|
||||
The following names can be given:
|
||||
* Nellis
|
||||
* McCarran
|
||||
* Creech
|
||||
* Groom Lake</p>
|
||||
|
||||
<h3>Contributions: Dutch Baron - Concept & Testing</h3>
|
||||
<h3>Author: FlightControl - Framework Design & Programming</h3>
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
<h2>Global(s)</h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#AIRBASEPOLICE_BASE">AIRBASEPOLICE_BASE</a></td>
|
||||
<td class="summary">
|
||||
|
||||
<p>Base class for AIRBASEPOLICE implementations.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#AIRBASEPOLICE_CAUCASUS">AIRBASEPOLICE_CAUCASUS</a></td>
|
||||
<td class="summary">
|
||||
<h1>AIRBASEPOLICE_CAUCASUS, extends <a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a></h1>
|
||||
|
||||
<p><img src="..\Presentations\AIRBASEPOLICE\Dia1.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<p>The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#AIRBASEPOLICE_NEVADA">AIRBASEPOLICE_NEVADA</a></td>
|
||||
<td class="summary">
|
||||
<h1>AIRBASEPOLICE_NEVADA, extends <a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a></h1>
|
||||
|
||||
<p><img src="..\Presentations\AIRBASEPOLICE\Dia1.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<p>The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#SSB">SSB</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
@ -197,12 +168,30 @@ The following names can be given:
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_BASE).AirbaseNames">AIRBASEPOLICE_BASE.AirbaseNames</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_BASE).Monitor">AIRBASEPOLICE_BASE:Monitor(AirbaseNames)</a></td>
|
||||
<td class="summary">
|
||||
<p>Monitor a table of airbase names.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_BASE).New">AIRBASEPOLICE_BASE:New(SetClient, Airbases)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates a new AIRBASEPOLICE_BASE object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_BASE).SetClient">AIRBASEPOLICE_BASE.SetClient</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_BASE)._AirbaseMonitor">AIRBASEPOLICE_BASE:_AirbaseMonitor()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -210,9 +199,9 @@ The following names can be given:
|
||||
<h2><a id="#(AIRBASEPOLICE_CAUCASUS)">Type <code>AIRBASEPOLICE_CAUCASUS</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_CAUCASUS).SetClient">AIRBASEPOLICE_CAUCASUS.SetClient</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_CAUCASUS).New">AIRBASEPOLICE_CAUCASUS:New(SetClient)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
<p>Creates a new AIRBASEPOLICE_CAUCASUS object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -220,18 +209,6 @@ The following names can be given:
|
||||
<h2><a id="#(AIRBASEPOLICE_NEVADA)">Type <code>AIRBASEPOLICE_NEVADA</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_NEVADA).Airbases">AIRBASEPOLICE_NEVADA.Airbases</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_NEVADA).ClassName">AIRBASEPOLICE_NEVADA.ClassName</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(AIRBASEPOLICE_NEVADA).New">AIRBASEPOLICE_NEVADA:New(SetClient)</a></td>
|
||||
<td class="summary">
|
||||
<p>Creates a new AIRBASEPOLICE_NEVADA object.</p>
|
||||
@ -243,27 +220,104 @@ The following names can be given:
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em><a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a></em>
|
||||
<a id="AIRBASEPOLICE_BASE" >
|
||||
<strong>AIRBASEPOLICE_BASE</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<p>Base class for AIRBASEPOLICE implementations.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em><a href="##(AIRBASEPOLICE_CAUCASUS)">#AIRBASEPOLICE_CAUCASUS</a></em>
|
||||
<a id="AIRBASEPOLICE_CAUCASUS" >
|
||||
<strong>AIRBASEPOLICE_CAUCASUS</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<h1>AIRBASEPOLICE_CAUCASUS, extends <a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a></h1>
|
||||
|
||||
<p><img src="..\Presentations\AIRBASEPOLICE\Dia1.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<p>The AIRBASEPOLICE_CAUCASUS class monitors the speed of the airplanes at the airbase during taxi.</p>
|
||||
|
||||
|
||||
<p>The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.</p>
|
||||
|
||||
<p>The maximum speed for the airbases at Caucasus is <strong>50 km/h</strong>.</p>
|
||||
|
||||
<p>The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving
|
||||
faster than the maximum allowed speed, the pilot will be kicked.</p>
|
||||
|
||||
<p>Different airbases have different maximum speeds, according safety regulations.</p>
|
||||
|
||||
<h1>Airbases monitored</h1>
|
||||
|
||||
<p>The following airbases are monitored at the Caucasus region:</p>
|
||||
|
||||
<ul>
|
||||
<li>Anapa Vityazevo</li>
|
||||
<li>Batumi</li>
|
||||
<li>Beslan</li>
|
||||
<li>Gelendzhik</li>
|
||||
<li>Gudauta</li>
|
||||
<li>Kobuleti</li>
|
||||
<li>Krasnodar Center</li>
|
||||
<li>Krasnodar Pashkovsky</li>
|
||||
<li>Krymsk</li>
|
||||
<li>Kutaisi</li>
|
||||
<li>Maykop Khanskaya</li>
|
||||
<li>Mineralnye Vody</li>
|
||||
<li>Mozdok</li>
|
||||
<li>Nalchik</li>
|
||||
<li>Novorossiysk</li>
|
||||
<li>Senaki Kolkhi</li>
|
||||
<li>Sochi Adler</li>
|
||||
<li>Soganlug</li>
|
||||
<li>Sukhumi Babushara</li>
|
||||
<li>Tbilisi Lochini</li>
|
||||
<li>Vaziani</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h1>Installation</h1>
|
||||
|
||||
<h2>In Single Player Missions</h2>
|
||||
|
||||
<p>AIRBASEPOLICE is fully functional in single player.</p>
|
||||
|
||||
<h2>In Multi Player Missions</h2>
|
||||
|
||||
<p>AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission.
|
||||
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player.
|
||||
To work around this problem, a much better solution has been made, using the slot blocker script designed
|
||||
by Ciribob. With the help of <strong>Ciribob</strong>, this script has been extended to also kick client players while in flight.
|
||||
AIRBASEPOLICE is communicating with this modified script to kick players!</p>
|
||||
|
||||
<p>Install the file <strong>SimpleSlotBlockGameGUI.lua</strong> on the server, following the installation instructions described by Ciribob.</p>
|
||||
|
||||
<p><a href="https://github.com/ciribob/DCS-SimpleSlotBlock">Simple Slot Blocker from Ciribob & FlightControl</a></p>
|
||||
|
||||
<h1>Script it!</h1>
|
||||
|
||||
<h2>1. AIRBASEPOLICE_CAUCASUS Constructor</h2>
|
||||
|
||||
<p>Creates a new AIRBASEPOLICE_CAUCASUS object that will monitor pilots taxiing behaviour.</p>
|
||||
|
||||
<pre><code>-- This creates a new AIRBASEPOLICE_CAUCASUS object.
|
||||
|
||||
-- Create a set of all clients in the mission.
|
||||
AllClientsSet = SET_CLIENT:New():FilterStart()
|
||||
|
||||
-- Monitor for these clients the airbases.
|
||||
AirbasePoliceCaucasus = AIRBASEPOLICE_CAUCASUS:New( AllClientsSet )
|
||||
</code></pre>
|
||||
|
||||
|
||||
</dd>
|
||||
@ -278,7 +332,82 @@ The following names can be given:
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<h1>AIRBASEPOLICE_NEVADA, extends <a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a></h1>
|
||||
|
||||
<p><img src="..\Presentations\AIRBASEPOLICE\Dia1.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<p>The AIRBASEPOLICE_NEVADA class monitors the speed of the airplanes at the airbase during taxi.</p>
|
||||
|
||||
|
||||
<p>The pilots may not drive faster than the maximum speed for the airbase, or they will be despawned.</p>
|
||||
|
||||
<p>The pilot will receive 3 times a warning during speeding. After the 3rd warning, if the pilot is still driving
|
||||
faster than the maximum allowed speed, the pilot will be kicked.</p>
|
||||
|
||||
<p>Different airbases have different maximum speeds, according safety regulations.</p>
|
||||
|
||||
<h1>Airbases monitored</h1>
|
||||
|
||||
<p>The following airbases are monitored at the Caucasus region:</p>
|
||||
|
||||
<ul>
|
||||
<li>Nellis</li>
|
||||
<li>McCarran</li>
|
||||
<li>Creech</li>
|
||||
<li>GroomLake</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<h1>Installation</h1>
|
||||
|
||||
<h2>In Single Player Missions</h2>
|
||||
|
||||
<p>AIRBASEPOLICE is fully functional in single player.</p>
|
||||
|
||||
<h2>In Multi Player Missions</h2>
|
||||
|
||||
<p>AIRBASEPOLICE is NOT functional in multi player, for client machines connecting to the server, running the mission.
|
||||
Due to a bug in DCS since release 1.5, the despawning of clients are not anymore working in multi player.
|
||||
To work around this problem, a much better solution has been made, using the slot blocker script designed
|
||||
by Ciribob. With the help of Ciribob, this script has been extended to also kick client players while in flight.
|
||||
AIRBASEPOLICE is communicating with this modified script to kick players!</p>
|
||||
|
||||
<p>Install the file <strong>SimpleSlotBlockGameGUI.lua</strong> on the server, following the installation instructions described by Ciribob.</p>
|
||||
|
||||
<p><a href="https://github.com/ciribob/DCS-SimpleSlotBlock">Simple Slot Blocker from Ciribob & FlightControl</a></p>
|
||||
|
||||
<h1>Script it!</h1>
|
||||
|
||||
<h2>1. AIRBASEPOLICE_NEVADA Constructor</h2>
|
||||
|
||||
<p>Creates a new AIRBASEPOLICE_NEVADA object that will monitor pilots taxiing behaviour.</p>
|
||||
|
||||
<pre><code>-- This creates a new AIRBASEPOLICE_NEVADA object.
|
||||
|
||||
-- Create a set of all clients in the mission.
|
||||
AllClientsSet = SET_CLIENT:New():FilterStart()
|
||||
|
||||
-- Monitor for these clients the airbases.
|
||||
AirbasePoliceCaucasus = AIRBASEPOLICE_NEVADA:New( AllClientsSet )
|
||||
</code></pre>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="SSB" >
|
||||
<strong>SSB</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
|
||||
<p> This is simple slot blocker is used on the server. </p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
@ -298,6 +427,66 @@ The following names can be given:
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AIRBASEPOLICE_BASE).Monitor" >
|
||||
<strong>AIRBASEPOLICE_BASE:Monitor(AirbaseNames)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Monitor a table of airbase names.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="##(AIRBASEPOLICE_BASE.AirbaseNames)">#AIRBASEPOLICE_BASE.AirbaseNames</a> AirbaseNames </em></code>:
|
||||
A list of AirbaseNames to monitor. If this parameters is nil, then all airbases will be monitored.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AIRBASEPOLICE_BASE).New" >
|
||||
<strong>AIRBASEPOLICE_BASE:New(SetClient, Airbases)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Creates a new AIRBASEPOLICE_BASE object.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> SetClient </em></code>:
|
||||
A SET_CLIENT object that will contain the CLIENT objects to be monitored if they follow the rules of the airbase.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Airbases </em></code>:
|
||||
A table of Airbase Names.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(AIRBASEPOLICE_BASE)">#AIRBASEPOLICE_BASE</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@ -312,6 +501,19 @@ The following names can be given:
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AIRBASEPOLICE_BASE)._AirbaseMonitor" >
|
||||
<strong>AIRBASEPOLICE_BASE:_AirbaseMonitor()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
@ -322,14 +524,27 @@ The following names can be given:
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="Core.Set.html##(SET_CLIENT)">Core.Set#SET_CLIENT</a></em>
|
||||
<a id="#(AIRBASEPOLICE_CAUCASUS).SetClient" >
|
||||
<strong>AIRBASEPOLICE_CAUCASUS.SetClient</strong>
|
||||
<a id="#(AIRBASEPOLICE_CAUCASUS).New" >
|
||||
<strong>AIRBASEPOLICE_CAUCASUS:New(SetClient)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Creates a new AIRBASEPOLICE_CAUCASUS object.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> SetClient </em></code>:
|
||||
A SET_CLIENT object that will contain the CLIENT objects to be monitored if they follow the rules of the airbase.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(AIRBASEPOLICE_CAUCASUS)">#AIRBASEPOLICE_CAUCASUS</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
@ -339,34 +554,6 @@ The following names can be given:
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(AIRBASEPOLICE_NEVADA).Airbases" >
|
||||
<strong>AIRBASEPOLICE_NEVADA.Airbases</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#string</em>
|
||||
<a id="#(AIRBASEPOLICE_NEVADA).ClassName" >
|
||||
<strong>AIRBASEPOLICE_NEVADA.ClassName</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(AIRBASEPOLICE_NEVADA).New" >
|
||||
<strong>AIRBASEPOLICE_NEVADA:New(SetClient)</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -169,6 +170,14 @@
|
||||
<td class="name" nowrap="nowrap"><a href="#CARGOS">CARGOS</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#CARGO_CRATE">CARGO_CRATE</a></td>
|
||||
<td class="summary">
|
||||
<h1>CARGO_CRATE class, extends <a href="##(CARGO_REPRESENTABLE)">#CARGO_REPRESENTABLE</a></h1>
|
||||
|
||||
<p>The CARGO_CRATE class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -194,7 +203,7 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="#CARGO_REPRESENTABLE">CARGO_REPRESENTABLE</a></td>
|
||||
<td class="summary">
|
||||
|
||||
<p>Models CARGO that is representable by a Unit.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -542,6 +551,46 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO).__UnLoad">CARGO:__UnLoad(DelaySeconds, ToPointVec2)</a></td>
|
||||
<td class="summary">
|
||||
<p>UnLoads the cargo to a Carrier.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h2><a id="#(CARGO_CRATE)">Type <code>CARGO_CRATE</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).CargoCarrier">CARGO_CRATE.CargoCarrier</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).CargoObject">CARGO_CRATE.CargoObject</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).New">CARGO_CRATE:New(CrateName, Type, Name, Weight, ReportRadius, NearRadius, CargoCrateName)</a></td>
|
||||
<td class="summary">
|
||||
<p>CARGO_CRATE Constructor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).OnUnLoadedCallBack">CARGO_CRATE.OnUnLoadedCallBack</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).onenterLoaded">CARGO_CRATE:onenterLoaded(Event, From, To, CargoCarrier)</a></td>
|
||||
<td class="summary">
|
||||
<p>Loaded State.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_CRATE).onenterUnLoaded">CARGO_CRATE:onenterUnLoaded(Event, From, To, Core, ToPointVec2)</a></td>
|
||||
<td class="summary">
|
||||
<p>Enter UnLoaded State.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -771,6 +820,12 @@
|
||||
<h2><a id="#(CARGO_REPRESENTABLE)">Type <code>CARGO_REPRESENTABLE</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_REPRESENTABLE).Destroy">CARGO_REPRESENTABLE:Destroy()</a></td>
|
||||
<td class="summary">
|
||||
<p>CARGO_REPRESENTABLE Destructor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_REPRESENTABLE).New">CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject)</a></td>
|
||||
<td class="summary">
|
||||
<p>CARGO_REPRESENTABLE Constructor.</p>
|
||||
@ -808,12 +863,6 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).CargoObject">CARGO_UNIT.CargoObject</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(CARGO_UNIT).Destroy">CARGO_UNIT:Destroy()</a></td>
|
||||
<td class="summary">
|
||||
<p>CARGO_UNIT Destructor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -957,6 +1006,28 @@ There are 2 moments when state transition methods will be called by the state ma
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="##(CARGO_CRATE)">#CARGO_CRATE</a></em>
|
||||
<a id="CARGO_CRATE" >
|
||||
<strong>CARGO_CRATE</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<h1>CARGO_CRATE class, extends <a href="##(CARGO_REPRESENTABLE)">#CARGO_REPRESENTABLE</a></h1>
|
||||
|
||||
<p>The CARGO_CRATE class defines a cargo that is represented by a UNIT object within the simulator, and can be transported by a carrier.</p>
|
||||
|
||||
|
||||
<p>Use the event functions as described above to Load, UnLoad, Board, UnBoard the CARGO_CRATE objects to and from carriers.</p>
|
||||
|
||||
<hr/>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@ -1017,7 +1088,7 @@ There are 2 moments when state transition methods will be called by the state ma
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
<p>Models CARGO that is representable by a Unit.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
@ -2190,6 +2261,188 @@ The amount of seconds to delay the action.</p>
|
||||
|
||||
<h2><a id="#(CARGO.CargoObjects)" >Type <code>CARGO.CargoObjects</code></a></h2>
|
||||
|
||||
<h2><a id="#(CARGO_CRATE)" >Type <code>CARGO_CRATE</code></a></h2>
|
||||
|
||||
<p>Models the behaviour of cargo crates, which can be slingloaded and boarded on helicopters using the DCS menus. </p>
|
||||
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_CRATE).CargoCarrier" >
|
||||
<strong>CARGO_CRATE.CargoCarrier</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(CARGO_CRATE).CargoObject" >
|
||||
<strong>CARGO_CRATE.CargoObject</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_CRATE).New" >
|
||||
<strong>CARGO_CRATE:New(CrateName, Type, Name, Weight, ReportRadius, NearRadius, CargoCrateName)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>CARGO_CRATE Constructor.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string CrateName </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Type </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Name </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number Weight </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number ReportRadius </em></code>:
|
||||
(optional)</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number NearRadius </em></code>:
|
||||
(optional)</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> CargoCrateName </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CARGO_CRATE)">#CARGO_CRATE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_CRATE).OnUnLoadedCallBack" >
|
||||
<strong>CARGO_CRATE.OnUnLoadedCallBack</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_CRATE).onenterLoaded" >
|
||||
<strong>CARGO_CRATE:onenterLoaded(Event, From, To, CargoCarrier)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Loaded State.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Event </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string From </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string To </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> CargoCarrier </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_CRATE).onenterUnLoaded" >
|
||||
<strong>CARGO_CRATE:onenterUnLoaded(Event, From, To, Core, ToPointVec2)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Enter UnLoaded State.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string Event </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string From </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string To </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Core </em></code>:
|
||||
Point#POINT_VEC2</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> ToPointVec2 </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h2><a id="#(CARGO_GROUP)" >Type <code>CARGO_GROUP</code></a></h2>
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
@ -3323,6 +3576,24 @@ The range till cargo will board.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_REPRESENTABLE).Destroy" >
|
||||
<strong>CARGO_REPRESENTABLE:Destroy()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>CARGO_REPRESENTABLE Destructor.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CARGO_REPRESENTABLE)">#CARGO_REPRESENTABLE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_REPRESENTABLE).New" >
|
||||
<strong>CARGO_REPRESENTABLE:New(Type, Name, Weight, ReportRadius, NearRadius, CargoObject)</strong>
|
||||
</a>
|
||||
@ -3420,7 +3691,7 @@ The range till cargo will board.</p>
|
||||
|
||||
<h2><a id="#(CARGO_UNIT)" >Type <code>CARGO_UNIT</code></a></h2>
|
||||
|
||||
<p>Hello </p>
|
||||
<p>Models CARGO in the form of units, which can be boarded, unboarded, loaded, unloaded. </p>
|
||||
|
||||
<h3>Field(s)</h3>
|
||||
<dl class="function">
|
||||
@ -3462,24 +3733,6 @@ The range till cargo will board.</p>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(CARGO_UNIT).Destroy" >
|
||||
<strong>CARGO_UNIT:Destroy()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>CARGO_UNIT Destructor.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(CARGO_UNIT)">#CARGO_UNIT</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -1105,7 +1106,7 @@ function below will use the range 1-7 just in case</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em>#number</em>
|
||||
<a id="#(DESIGNATE).LaseDuration" >
|
||||
<strong>DESIGNATE.LaseDuration</strong>
|
||||
</a>
|
||||
@ -1159,6 +1160,7 @@ function below will use the range 1-7 just in case</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(DESIGNATE).LaserCodes" >
|
||||
<strong>DESIGNATE.LaserCodes</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -4060,7 +4061,7 @@ Return false to cancel Transition.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em>#number</em>
|
||||
<a id="#(DETECTION_BASE).RefreshTimeInterval" >
|
||||
<strong>DETECTION_BASE.RefreshTimeInterval</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -1982,7 +1983,6 @@ The height in meters to add to the altitude of the positionable.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em><a href="Core.Spot.html##(SPOT)">Core.Spot#SPOT</a></em>
|
||||
<a id="#(POSITIONABLE).Spot" >
|
||||
<strong>POSITIONABLE.Spot</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -1249,7 +1250,7 @@ true if metric.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em>#boolean</em>
|
||||
<a id="#(SETTINGS).Metric" >
|
||||
<strong>SETTINGS.Metric</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -114,7 +115,7 @@
|
||||
<div id="content">
|
||||
<h1>Module <code>Spawn</code></h1>
|
||||
|
||||
<p><strong>Functional</strong> -- Spawn dynamically new GROUPs in your missions.</p>
|
||||
<p><strong>Core</strong> -- SPAWN class dynamically spawns new groups of units in your missions.</p>
|
||||
|
||||
|
||||
<p>
|
||||
@ -165,6 +166,10 @@
|
||||
<td class="summary">
|
||||
<h1>SPAWN class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
|
||||
<p>-- <img src="..\Presentations\SPAWN\SPAWN.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<hr/>
|
||||
|
||||
<p>The SPAWN class allows to spawn dynamically new groups.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -327,6 +332,18 @@ and any spaces before and after the resulting name are removed.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN).InitRandomizeTemplate">SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)</a></td>
|
||||
<td class="summary">
|
||||
<p>This method is rather complicated to understand.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN).InitRandomizeTemplatePrefixes">SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)</a></td>
|
||||
<td class="summary">
|
||||
<p>Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN).InitRandomizeTemplateSet">SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet)</a></td>
|
||||
<td class="summary">
|
||||
<p>Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -831,6 +848,12 @@ and any spaces before and after the resulting name are removed.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN)._TranslateRotate">SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(SPAWN).uncontrolled">SPAWN.uncontrolled</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -848,10 +871,14 @@ and any spaces before and after the resulting name are removed.</p>
|
||||
|
||||
<h1>SPAWN class, extends <a href="Base.html##(BASE)">Base#BASE</a></h1>
|
||||
|
||||
<p>-- <img src="..\Presentations\SPAWN\SPAWN.JPG" alt="Banner Image"/></p>
|
||||
|
||||
<hr/>
|
||||
|
||||
<p>The SPAWN class allows to spawn dynamically new groups.</p>
|
||||
|
||||
|
||||
<p>Each SPAWN object needs to be have a related <strong>template group</strong> setup in the Mission Editor (ME),
|
||||
<p>Each SPAWN object needs to be have related <strong>template groups</strong> setup in the Mission Editor (ME),
|
||||
which is a normal group with the <strong>Late Activation</strong> flag set.
|
||||
This template group will never be activated in your mission. <br/>
|
||||
SPAWN uses that <strong>template group</strong> to reference to all the characteristics
|
||||
@ -1825,6 +1852,99 @@ Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SPAWN).InitRandomizeTemplatePrefixes" >
|
||||
<strong>SPAWN:InitRandomizeTemplatePrefixes(SpawnTemplatePrefixes)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.</p>
|
||||
|
||||
|
||||
<p>This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor,
|
||||
but they will all follow the same Template route and have the same prefix name.
|
||||
In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string SpawnTemplatePrefixes </em></code>:
|
||||
A string or a list of string that contains the prefixes of the groups that are possible unit representatives of the group to be spawned. </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(SPAWN)">#SPAWN</a>:</em></p>
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>-- NATO Tank Platoons invading Gori.
|
||||
|
||||
-- Choose between different 'US Tank Platoon Templates' configurations to be spawned for the
|
||||
-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
|
||||
|
||||
-- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
|
||||
-- with a limit set of maximum 12 Units alive simulteneously and 150 Groups to be spawned during the whole mission.
|
||||
|
||||
Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
|
||||
Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )
|
||||
Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SPAWN).InitRandomizeTemplateSet" >
|
||||
<strong>SPAWN:InitRandomizeTemplateSet(SpawnTemplateSet)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.</p>
|
||||
|
||||
|
||||
<p>This method becomes useful when you need to spawn groups with random templates of groups defined within the mission editor,
|
||||
but they will all follow the same Template route and have the same prefix name.
|
||||
In other words, this method randomizes between a defined set of groups the template to be used for each new spawn of a group.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Set.html##(SET_GROUP)">Core.Set#SET_GROUP</a> SpawnTemplateSet </em></code>:
|
||||
A SET_GROUP object set, that contains the groups that are possible unit representatives of the group to be spawned. </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(SPAWN)">#SPAWN</a>:</em></p>
|
||||
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code>-- NATO Tank Platoons invading Gori.
|
||||
|
||||
-- Choose between different 'US Tank Platoon Template' configurations to be spawned for the
|
||||
-- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SPAWN objects.
|
||||
|
||||
-- Each new SPAWN will randomize the route, with a defined time interval of 200 seconds with 40% time variation (randomization) and
|
||||
-- with a limit set of maximum 12 Units alive simulteneously and 150 Groups to be spawned during the whole mission.
|
||||
|
||||
Spawn_US_PlatoonSet = SET_GROUP:New():FilterPrefixes( "US Tank Platoon Templates" ):FilterOnce()
|
||||
|
||||
--- Now use the Spawn_US_PlatoonSet to define the templates using InitRandomizeTemplateSet.
|
||||
Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
|
||||
Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
|
||||
Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(SPAWN).InitRandomizeUnits" >
|
||||
<strong>SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)</strong>
|
||||
</a>
|
||||
@ -3165,7 +3285,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em>#boolean</em>
|
||||
<em></em>
|
||||
<a id="#(SPAWN).SpawnUnControlled" >
|
||||
<strong>SPAWN.SpawnUnControlled</strong>
|
||||
</a>
|
||||
@ -3189,7 +3309,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
|
||||
|
||||
|
||||
|
||||
<p> Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.</p>
|
||||
<p> When the first Spawn executes, all the Groups need to be made visible before start.</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
@ -3769,6 +3889,20 @@ True = Continue Scheduler</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(SPAWN).uncontrolled" >
|
||||
<strong>SPAWN.uncontrolled</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -156,6 +157,12 @@
|
||||
<td class="name" nowrap="nowrap"><a href="##(STATIC).GetThreatLevel">STATIC:GetThreatLevel()</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(STATIC).ReSpawn">STATIC:ReSpawn(Coordinate, Heading)</a></td>
|
||||
<td class="summary">
|
||||
<p>Respawn the <a href="Unit.html">Unit</a> using a (tweaked) template of the parent Group.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -284,6 +291,34 @@ Raise an error if not found.</p>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(STATIC).ReSpawn" >
|
||||
<strong>STATIC:ReSpawn(Coordinate, Heading)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Respawn the <a href="Unit.html">Unit</a> using a (tweaked) template of the parent Group.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em><a href="Core.Point.html##(COORDINATE)">Core.Point#COORDINATE</a> Coordinate </em></code>:
|
||||
The coordinate where to spawn the new Static.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#number Heading </em></code>:
|
||||
The heading of the unit respawn.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@ -322,6 +357,8 @@ Raise an error if not found.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h2><a id="#(UNIT)" >Type <code>UNIT</code></a></h2>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -575,6 +576,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(FSM_PROCESS).DeployZone" >
|
||||
<strong>FSM_PROCESS.DeployZone</strong>
|
||||
</a>
|
||||
@ -639,7 +641,7 @@ based on the tasking capabilities defined in <a href="Task.html##(TASK)">Task#TA
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<em>#number</em>
|
||||
<a id="#(TASK_CARGO).CargoLimit" >
|
||||
<strong>TASK_CARGO.CargoLimit</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -152,6 +153,12 @@
|
||||
<h2><a id="#(UNIT)">Type <code>UNIT</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(UNIT).Destroy">UNIT:Destroy()</a></td>
|
||||
<td class="summary">
|
||||
<p>Destroys the UNIT.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(UNIT).Find">UNIT:Find(DCSUnit)</a></td>
|
||||
<td class="summary">
|
||||
<p>Finds a UNIT from the _DATABASE using a DCSUnit object.</p>
|
||||
@ -498,6 +505,24 @@ If you want to obtain the complete <strong>3D position</strong> including ori<72>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(UNIT).Destroy" >
|
||||
<strong>UNIT:Destroy()</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Destroys the UNIT.</p>
|
||||
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#nil:</em>
|
||||
The DCS Unit is not existing or alive. </p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(UNIT).Find" >
|
||||
<strong>UNIT:Find(DCSUnit)</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -143,6 +144,12 @@
|
||||
<h2><a id="#(USERFLAG)">Type <code>USERFLAG</code></a></h2>
|
||||
<table class="function_list">
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(USERFLAG).Get">USERFLAG:Get(Number)</a></td>
|
||||
<td class="summary">
|
||||
<p>Get the userflag Number.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(USERFLAG).Is">USERFLAG:Is(Number)</a></td>
|
||||
<td class="summary">
|
||||
<p>Check if the userflag has a value of Number.</p>
|
||||
@ -201,6 +208,37 @@
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(USERFLAG).Get" >
|
||||
<strong>USERFLAG:Get(Number)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Get the userflag Number.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> Number </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em>#number:</em>
|
||||
Number The number value to be checked if it is the same as the userflag.</p>
|
||||
|
||||
<h3>Usage:</h3>
|
||||
<pre class="example"><code> local BlueVictory = USERFLAG:New( "VictoryBlue" )
|
||||
local BlueVictoryValue = BlueVictory:Get() -- Get the UserFlag VictoryBlue value.
|
||||
</code></pre>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(USERFLAG).Is" >
|
||||
<strong>USERFLAG:Is(Number)</strong>
|
||||
</a>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li>Zone</li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -431,7 +432,13 @@
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_POLYGON).New">ZONE_POLYGON:New(ZoneName, ZoneGroup)</a></td>
|
||||
<td class="summary">
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(ZONE_POLYGON).NewFromGroupName">ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName)</a></td>
|
||||
<td class="summary">
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the <strong>name</strong> of the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
@ -1676,7 +1683,7 @@ self</p>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the name of the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
|
||||
|
||||
<p>The <a href="Group.html##(GROUP)">Group#GROUP</a> waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.</p>
|
||||
@ -1701,6 +1708,42 @@ The GROUP waypoints as defined within the Mission Editor define the polygon shap
|
||||
<p><em><a href="##(ZONE_POLYGON)">#ZONE_POLYGON</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(ZONE_POLYGON).NewFromGroupName" >
|
||||
<strong>ZONE_POLYGON:NewFromGroupName(ZoneName, GroupName)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Constructor to create a ZONE_POLYGON instance, taking the zone name and the <strong>name</strong> of the <a href="Group.html##(GROUP)">Group#GROUP</a> defined within the Mission Editor.</p>
|
||||
|
||||
|
||||
<p>The <a href="Group.html##(GROUP)">Group#GROUP</a> waypoints define the polygon corners. The first and the last point are automatically connected by ZONE_POLYGON.</p>
|
||||
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string ZoneName </em></code>:
|
||||
Name of the zone.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string GroupName </em></code>:
|
||||
The group name of the GROUP defining the waypoints within the Mission Editor to define the polygon shape.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(ZONE_POLYGON)">#ZONE_POLYGON</a>:</em>
|
||||
self</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li>ZoneCaptureCoalition</li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li>ZoneGoal</li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -488,6 +489,7 @@ The name of the player.</p>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(ZONE_GOAL).SmokeTime" >
|
||||
<strong>ZONE_GOAL.SmokeTime</strong>
|
||||
</a>
|
||||
@ -496,6 +498,9 @@ The name of the player.</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<p>self.SmokeColor = nil</p>
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li>ZoneGoalCoalition</li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li>env</li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
@ -275,7 +276,7 @@ even when there are hardly any players in the mission.</strong></p>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="AirbasePolice.html">AirbasePolice</a></td>
|
||||
<td class="summary">
|
||||
<p><strong>Functional</strong> -- This module monitors airbases traffic.</p>
|
||||
<p><strong>Functional</strong> -- The AIRBASEPOLICE classes monitor airbase traffic and regulate speed while taxiing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -616,7 +617,7 @@ and creates a CSV file logging the scoring events and results for use at team or
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="Spawn.html">Spawn</a></td>
|
||||
<td class="summary">
|
||||
<p><strong>Functional</strong> -- Spawn dynamically new GROUPs in your missions.</p>
|
||||
<p><strong>Core</strong> -- SPAWN class dynamically spawns new groups of units in your missions.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -732,6 +733,12 @@ which are excellent tools to be reused in an OO environment!.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="ZoneGoal.html">ZoneGoal</a></td>
|
||||
<td class="summary">
|
||||
<p><strong>Functional (WIP)</strong> -- Base class that models processes to achieve goals involving a Zone.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></td>
|
||||
<td class="summary">
|
||||
<p><strong>Functional (WIP)</strong> -- Base class that models processes to achieve goals involving a Zone and Cargo.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li>land</li>
|
||||
|
||||
@ -105,6 +105,7 @@
|
||||
<li><a href="Zone.html">Zone</a></li>
|
||||
<li><a href="ZoneCaptureCoalition.html">ZoneCaptureCoalition</a></li>
|
||||
<li><a href="ZoneGoal.html">ZoneGoal</a></li>
|
||||
<li><a href="ZoneGoalCargo.html">ZoneGoalCargo</a></li>
|
||||
<li><a href="ZoneGoalCoalition.html">ZoneGoalCoalition</a></li>
|
||||
<li><a href="env.html">env</a></li>
|
||||
<li><a href="land.html">land</a></li>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user