From 306ac64bd3c41efb7dbbd48c7959ad38358d3859 Mon Sep 17 00:00:00 2001
From: FlightControl
Date: Tue, 11 Apr 2017 20:35:46 +0200
Subject: [PATCH] Updated SPAWN
-- Revised documentation
-- Initial delay OFF by default for SpawnScheduled() spawning. Use the
InitDelayOn() to activate the delays.
---
Moose Development/Moose/Functional/Spawn.lua | 69 ++-
docs/Documentation/AI_Balancer.html | 1 +
docs/Documentation/AI_Cap.html | 1 +
docs/Documentation/AI_Cas.html | 1 +
docs/Documentation/AI_Patrol.html | 1 +
docs/Documentation/Account.html | 1 +
docs/Documentation/Airbase.html | 1 +
docs/Documentation/AirbasePolice.html | 1 +
docs/Documentation/Assign.html | 1 +
docs/Documentation/Base.html | 1 +
docs/Documentation/Cargo.html | 1 +
docs/Documentation/CleanUp.html | 1 +
docs/Documentation/Client.html | 1 +
docs/Documentation/CommandCenter.html | 1 +
docs/Documentation/Controllable.html | 1 +
docs/Documentation/DCSAirbase.html | 1 +
docs/Documentation/DCSCoalitionObject.html | 1 +
docs/Documentation/DCSCommand.html | 1 +
docs/Documentation/DCSController.html | 1 +
docs/Documentation/DCSGroup.html | 1 +
docs/Documentation/DCSObject.html | 1 +
docs/Documentation/DCSTask.html | 1 +
docs/Documentation/DCSTypes.html | 1 +
docs/Documentation/DCSUnit.html | 1 +
docs/Documentation/DCSVec3.html | 1 +
docs/Documentation/DCSWorld.html | 1 +
docs/Documentation/DCSZone.html | 1 +
docs/Documentation/DCScountry.html | 1 +
docs/Documentation/DCStimer.html | 1 +
docs/Documentation/DCStrigger.html | 1 +
docs/Documentation/Database.html | 210 +++++---
docs/Documentation/Detection.html | 1 +
docs/Documentation/DetectionManager.html | 1 +
docs/Documentation/Escort.html | 1 +
docs/Documentation/Event.html | 1 +
docs/Documentation/Fsm.html | 1 +
docs/Documentation/Group.html | 1 +
docs/Documentation/Identifiable.html | 1 +
docs/Documentation/MOVEMENT.html | 5 +
docs/Documentation/Menu.html | 1 +
docs/Documentation/Message.html | 1 +
docs/Documentation/MissileTrainer.html | 1 +
docs/Documentation/Mission.html | 1 +
docs/Documentation/Object.html | 1 +
docs/Documentation/Point.html | 1 +
docs/Documentation/Positionable.html | 1 +
docs/Documentation/Process_JTAC.html | 1 +
docs/Documentation/Process_Pickup.html | 1 +
docs/Documentation/Radio.html | 1 +
docs/Documentation/Route.html | 1 +
docs/Documentation/Scenery.html | 1 +
docs/Documentation/ScheduleDispatcher.html | 1 +
docs/Documentation/Scheduler.html | 1 +
docs/Documentation/Scoring.html | 1 +
docs/Documentation/Sead.html | 1 +
docs/Documentation/Set.html | 1 +
docs/Documentation/Smoke.html | 1 +
docs/Documentation/Spawn.html | 93 +++-
docs/Documentation/SpawnStatic.html | 493 +++++++++++++++++++
docs/Documentation/Static.html | 1 +
docs/Documentation/StaticObject.html | 1 +
docs/Documentation/Task.html | 1 +
docs/Documentation/Task_A2G.html | 1 +
docs/Documentation/Task_A2G_Dispatcher.html | 1 +
docs/Documentation/Task_PICKUP.html | 1 +
docs/Documentation/Unit.html | 1 +
docs/Documentation/Utils.html | 1 +
docs/Documentation/Zone.html | 1 +
docs/Documentation/env.html | 1 +
docs/Documentation/index.html | 7 +
docs/Documentation/land.html | 1 +
docs/Documentation/routines.html | 1 +
72 files changed, 869 insertions(+), 74 deletions(-)
create mode 100644 docs/Documentation/SpawnStatic.html
diff --git a/Moose Development/Moose/Functional/Spawn.lua b/Moose Development/Moose/Functional/Spawn.lua
index 02f757fed..b394fbdca 100644
--- a/Moose Development/Moose/Functional/Spawn.lua
+++ b/Moose Development/Moose/Functional/Spawn.lua
@@ -4,6 +4,10 @@
--
-- ====
--
+-- The documentation of the SPAWN class can be found further in this document.
+--
+-- ====
+--
-- # Demo Missions
--
-- ### [SPAWN Demo Missions source code](https://github.com/FlightControl-Master/MOOSE_MISSIONS/tree/master-release/SPA%20-%20Spawning)
@@ -174,30 +178,62 @@
--
-- A spawn object will behave differently based on the usage of **initialization** methods, which all start with the **Init** prefix:
--
+-- ### Unit Names
+--
-- * @{#SPAWN.InitKeepUnitNames}(): Keeps the unit names as defined within the mission editor, but note that anything after a # mark is ignored, and any spaces before and after the resulting name are removed. IMPORTANT! This method MUST be the first used after :New !!!
--- * @{#SPAWN.InitLimit}(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
+--
+-- ### Route randomization
+--
-- * @{#SPAWN.InitRandomizeRoute}(): Randomize the routes of spawned groups, and for air groups also optionally the height.
+--
+-- ### Group composition randomization
+--
-- * @{#SPAWN.InitRandomizeTemplate}(): Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.
+--
+-- ### Uncontrolled
+--
-- * @{#SPAWN.InitUnControlled}(): Spawn plane groups uncontrolled.
+--
+-- ### Array formation
+--
-- * @{#SPAWN.InitArray}(): Make groups visible before they are actually activated, and order these groups like a batallion in an array.
--- * @{#SPAWN.InitRepeat}(): Re-spawn groups when they land at the home base. Similar methods are @{#SPAWN.InitRepeatOnLanding} and @{#SPAWN.InitRepeatOnEngineShutDown}.
+--
+-- ### Position randomization
+--
-- * @{#SPAWN.InitRandomizePosition}(): Randomizes the position of @{Group}s that are spawned within a **radius band**, given an Outer and Inner radius, from the point that the spawn happens.
-- * @{#SPAWN.InitRandomizeUnits}(): Randomizes the @{Unit}s in the @{Group} that is spawned within a **radius band**, given an Outer and Inner radius.
-- * @{#SPAWN.InitRandomizeZones}(): Randomizes the spawning between a predefined list of @{Zone}s that are declared using this function. Each zone can be given a probability factor.
+--
+-- ### Enable / Disable AI when spawning a new @{Group}
+--
-- * @{#SPAWN.InitAIOn}(): Turns the AI On when spawning the new @{Group} object.
-- * @{#SPAWN.InitAIOff}(): Turns the AI Off when spawning the new @{Group} object.
-- * @{#SPAWN.InitAIOnOff}(): Turns the AI On or Off when spawning the new @{Group} object.
--- * @{#SPAWN.InitDelayOnOff}(): Turns the inital delay On/Off when spawning the first @{Group} object.
--- * @{#SPAWN.InitDelayOn}(): Turns the inital delay On when spawning the first @{Group} object.
--- * @{#SPAWN.InitDelayOff}(): Turns the inital delay On when spawning the first @{Group} object.
+--
+-- ### Limit scheduled spawning
+--
+-- * @{#SPAWN.InitLimit}(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
+--
+-- ### Delay initial scheduled spawn
+--
+-- * @{#SPAWN.InitDelayOnOff}(): Turns the inital delay On/Off when scheduled spawning the first @{Group} object.
+-- * @{#SPAWN.InitDelayOn}(): Turns the inital delay On when scheduled spawning the first @{Group} object.
+-- * @{#SPAWN.InitDelayOff}(): Turns the inital delay Off when scheduled spawning the first @{Group} object.
+--
+-- ### Repeat spawned @{Group}s upon landing
+--
+-- * @{#SPAWN.InitRepeat}() or @{#SPAWN.InitRepeatOnLanding}(): This method is used to re-spawn automatically the same group after it has landed.
+-- * @{#SPAWN.InitRepeatOnEngineShutDown}(): This method is used to re-spawn automatically the same group after it has landed and it shuts down the engines at the ramp.
+--
--
-- ## SPAWN **Spawn** methods
--
-- Groups can be spawned at different times and methods:
--
+-- ### **Single** spawning methods
+--
-- * @{#SPAWN.Spawn}(): Spawn one new group based on the last spawned index.
-- * @{#SPAWN.ReSpawn}(): Re-spawn a group based on a given index.
--- * @{#SPAWN.SpawnScheduled}(): Spawn groups at scheduled but randomized intervals. You can use @{#SPAWN.SpawnScheduleStart}() and @{#SPAWN.SpawnScheduleStop}() to start and stop the schedule respectively.
-- * @{#SPAWN.SpawnFromVec3}(): Spawn a new group from a Vec3 coordinate. (The group will can be spawned at a point in the air).
-- * @{#SPAWN.SpawnFromVec2}(): Spawn a new group from a Vec2 coordinate. (The group will be spawned at land height ).
-- * @{#SPAWN.SpawnFromStatic}(): Spawn a new group from a structure, taking the position of a @{Static}.
@@ -206,6 +242,14 @@
--
-- Note that @{#SPAWN.Spawn} and @{#SPAWN.ReSpawn} return a @{GROUP#GROUP.New} object, that contains a reference to the DCSGroup object.
-- You can use the @{GROUP} object to do further actions with the DCSGroup.
+--
+-- ### **Scheduled** spawning methods
+--
+-- * @{#SPAWN.SpawnScheduled}(): Spawn groups at scheduled but randomized intervals.
+-- * @{#SPAWN.SpawnScheduledStart}(): Start or continue to spawn groups at scheduled time intervals.
+-- * @{#SPAWN.SpawnScheduledStop}(): Stop the spawning of groups at scheduled time intervals.
+--
+--
--
-- ## Retrieve alive GROUPs spawned by the SPAWN object
--
@@ -242,6 +286,15 @@
-- As a result, your spawn event handling function requires one parameter to be declared, which will contain the spawned @{Group} object.
-- A coding example is provided at the description of the @{#SPAWN.OnSpawnGroup}( **function( SpawnedGroup ) end ** ) method.
--
+-- ## Delay the initial spawning
+--
+-- When using the @{#SPAWN.SpawnScheduled)() method, the default behaviour of this method will be that it will spawn the initial (first) @{Group}
+-- immediately when :SpawnScheduled() is initiated. The methods @{#SPAWN.InitDelayOnOff}() and @{#SPAWN.InitDelayOn}() can be used to
+-- activate a delay before the first @{Group} is spawned. For completeness, a method @{#SPAWN.InitDelayOff}() is also available, that
+-- can be used to switch off the initial delay. Because there is no delay by default, this method would only be used when a
+-- @{#SPAWN.SpawnScheduledStop}() ; @{#SPAWN.SpawnScheduledStart}() sequence would have been used.
+--
+--
-- @field #SPAWN SPAWN
--
SPAWN = {
@@ -285,7 +338,7 @@ function SPAWN:New( SpawnTemplatePrefix )
self.AIOnOff = true -- The AI is on by default when spawning a group.
self.SpawnUnControlled = false
self.SpawnInitKeepUnitNames = false -- Overwrite unit names by default with group name.
- self.DelayOnOff = true -- An intial delay when spawning the first group.
+ self.DelayOnOff = false -- No intial delay when spawning the first group.
self.SpawnGroups = {} -- Array containing the descriptions of each Group to be Spawned.
else
@@ -329,7 +382,7 @@ function SPAWN:NewWithAlias( SpawnTemplatePrefix, SpawnAliasPrefix )
self.AIOnOff = true -- The AI is on by default when spawning a group.
self.SpawnUnControlled = false
self.SpawnInitKeepUnitNames = false -- Overwrite unit names by default with group name.
- self.DelayOnOff = true -- An intial delay when spawning the first group.
+ self.DelayOnOff = false -- No intial delay when spawning the first group.
self.SpawnGroups = {} -- Array containing the descriptions of each Group to be Spawned.
else
diff --git a/docs/Documentation/AI_Balancer.html b/docs/Documentation/AI_Balancer.html
index 3c6b3b617..15193880f 100644
--- a/docs/Documentation/AI_Balancer.html
+++ b/docs/Documentation/AI_Balancer.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/AI_Cap.html b/docs/Documentation/AI_Cap.html
index 4cd6c823c..e1b610a96 100644
--- a/docs/Documentation/AI_Cap.html
+++ b/docs/Documentation/AI_Cap.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/AI_Cas.html b/docs/Documentation/AI_Cas.html
index c5c606a8e..dfe838961 100644
--- a/docs/Documentation/AI_Cas.html
+++ b/docs/Documentation/AI_Cas.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html
index ac871d530..a3492fd79 100644
--- a/docs/Documentation/AI_Patrol.html
+++ b/docs/Documentation/AI_Patrol.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Account.html b/docs/Documentation/Account.html
index c9fd86895..3cf4ae169 100644
--- a/docs/Documentation/Account.html
+++ b/docs/Documentation/Account.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Airbase.html b/docs/Documentation/Airbase.html
index ce20dd22e..e95ffe8a7 100644
--- a/docs/Documentation/Airbase.html
+++ b/docs/Documentation/Airbase.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/AirbasePolice.html b/docs/Documentation/AirbasePolice.html
index 6e4b86893..a9a309bc9 100644
--- a/docs/Documentation/AirbasePolice.html
+++ b/docs/Documentation/AirbasePolice.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Assign.html b/docs/Documentation/Assign.html
index d11d2d43f..8d26350da 100644
--- a/docs/Documentation/Assign.html
+++ b/docs/Documentation/Assign.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Base.html b/docs/Documentation/Base.html
index cd81ced60..487f77662 100644
--- a/docs/Documentation/Base.html
+++ b/docs/Documentation/Base.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Cargo.html b/docs/Documentation/Cargo.html
index 6ec4d6173..ba3e1c4ad 100644
--- a/docs/Documentation/Cargo.html
+++ b/docs/Documentation/Cargo.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/CleanUp.html b/docs/Documentation/CleanUp.html
index 842a832d7..2b3bbdf2a 100644
--- a/docs/Documentation/CleanUp.html
+++ b/docs/Documentation/CleanUp.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Client.html b/docs/Documentation/Client.html
index f01a6e752..c3d1262c5 100644
--- a/docs/Documentation/Client.html
+++ b/docs/Documentation/Client.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/CommandCenter.html b/docs/Documentation/CommandCenter.html
index c008099e9..ea2d7f464 100644
--- a/docs/Documentation/CommandCenter.html
+++ b/docs/Documentation/CommandCenter.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Controllable.html b/docs/Documentation/Controllable.html
index c48168362..901518513 100644
--- a/docs/Documentation/Controllable.html
+++ b/docs/Documentation/Controllable.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSAirbase.html b/docs/Documentation/DCSAirbase.html
index 3a636bd34..860fab349 100644
--- a/docs/Documentation/DCSAirbase.html
+++ b/docs/Documentation/DCSAirbase.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSCoalitionObject.html b/docs/Documentation/DCSCoalitionObject.html
index 8ffcdb2f0..003f27213 100644
--- a/docs/Documentation/DCSCoalitionObject.html
+++ b/docs/Documentation/DCSCoalitionObject.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSCommand.html b/docs/Documentation/DCSCommand.html
index 6e0e838f4..72b05130d 100644
--- a/docs/Documentation/DCSCommand.html
+++ b/docs/Documentation/DCSCommand.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSController.html b/docs/Documentation/DCSController.html
index 08d0ee3d4..f1229fcb4 100644
--- a/docs/Documentation/DCSController.html
+++ b/docs/Documentation/DCSController.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSGroup.html b/docs/Documentation/DCSGroup.html
index 146fd7552..45543df9b 100644
--- a/docs/Documentation/DCSGroup.html
+++ b/docs/Documentation/DCSGroup.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSObject.html b/docs/Documentation/DCSObject.html
index ddd1a1d39..0ba8eec6b 100644
--- a/docs/Documentation/DCSObject.html
+++ b/docs/Documentation/DCSObject.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSTask.html b/docs/Documentation/DCSTask.html
index 7cfa7703b..3300796fe 100644
--- a/docs/Documentation/DCSTask.html
+++ b/docs/Documentation/DCSTask.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSTypes.html b/docs/Documentation/DCSTypes.html
index 27861a693..771115adc 100644
--- a/docs/Documentation/DCSTypes.html
+++ b/docs/Documentation/DCSTypes.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSUnit.html b/docs/Documentation/DCSUnit.html
index 9df171024..2966a3c3f 100644
--- a/docs/Documentation/DCSUnit.html
+++ b/docs/Documentation/DCSUnit.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSVec3.html b/docs/Documentation/DCSVec3.html
index a720ad73b..932c2b123 100644
--- a/docs/Documentation/DCSVec3.html
+++ b/docs/Documentation/DCSVec3.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSWorld.html b/docs/Documentation/DCSWorld.html
index edbd527a8..0cc029800 100644
--- a/docs/Documentation/DCSWorld.html
+++ b/docs/Documentation/DCSWorld.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCSZone.html b/docs/Documentation/DCSZone.html
index 53c2b2c01..6f730e275 100644
--- a/docs/Documentation/DCSZone.html
+++ b/docs/Documentation/DCSZone.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCScountry.html b/docs/Documentation/DCScountry.html
index d32ddba19..2540119a7 100644
--- a/docs/Documentation/DCScountry.html
+++ b/docs/Documentation/DCScountry.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCStimer.html b/docs/Documentation/DCStimer.html
index 460bfdd4b..6d02f30d2 100644
--- a/docs/Documentation/DCStimer.html
+++ b/docs/Documentation/DCStimer.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DCStrigger.html b/docs/Documentation/DCStrigger.html
index 6e5578efe..2b9776637 100644
--- a/docs/Documentation/DCStrigger.html
+++ b/docs/Documentation/DCStrigger.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Database.html b/docs/Documentation/Database.html
index 66fbf696e..01259863a 100644
--- a/docs/Documentation/Database.html
+++ b/docs/Documentation/Database.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
@@ -350,6 +351,12 @@ The following iterator methods are currently available within the DATABASE:
DATABASE:GetGroupTemplateFromUnitName(UnitName) |
+ |
+
+
+ | DATABASE:GetStaticUnitTemplate(StaticName) |
+
+
|
@@ -362,6 +369,12 @@ The following iterator methods are currently available within the DATABASE:
| DATABASE.NavPoints |
+ |
+
+
+ | DATABASE.Navpoints |
+
+
|
@@ -446,6 +459,12 @@ The following iterator methods are currently available within the DATABASE:
| DATABASE:_RegisterClients() |
Private method that registers all Units of skill Client or Player within in the mission.
+ |
+
+
+ | DATABASE:_RegisterGroupTemplate(GroupTemplate, CoalitionID, CategoryID, CountryID) |
+
+ Private method that registers new Group Templates within the DATABASE Object.
|
@@ -461,15 +480,15 @@ The following iterator methods are currently available within the DATABASE:
- | DATABASE:_RegisterStatics() |
+ DATABASE:_RegisterStaticTemplate(GroupTemplate, StaticTemplate, CoalitionID, CategoryID, CountryID) |
-
+ Private method that registers new Static Templates within the DATABASE Object.
|
- | DATABASE:_RegisterTemplate(GroupTemplate, CoalitionID, CategoryID, CountryID) |
+ DATABASE:_RegisterStatics() |
- Private method that registers new Group Templates within the DATABASE Object.
+
|
@@ -1309,6 +1328,27 @@ self
-
+
+DATABASE:GetStaticUnitTemplate(StaticName)
+
+
+-
+
+
+
+
Parameter
+
+
+
+
+-
+
DATABASE:GetStatusGroup(GroupName)
@@ -1339,6 +1379,20 @@ self
+
+
+
+-
+
+
+
+DATABASE.Navpoints
+
+
+-
+
+
+
@@ -1608,57 +1662,8 @@ self
-
-
-DATABASE:_RegisterGroupsAndUnits()
-
-
--
-
-
Private method that registers all Groups and Units within in the mission.
-
- Return value
-
-#DATABASE:
-self
-
-
-
-
--
-
-
-DATABASE:_RegisterPlayers()
-
-
--
-
-
Private method that registers all alive players in the mission.
-
- Return value
-
-#DATABASE:
-self
-
-
-
-
--
-
-
-DATABASE:_RegisterStatics()
-
-
--
-
-
-
-
-
-
--
-
-
-DATABASE:_RegisterTemplate(GroupTemplate, CoalitionID, CategoryID, CountryID)
+
+DATABASE:_RegisterGroupTemplate(GroupTemplate, CoalitionID, CategoryID, CountryID)
-
@@ -1693,6 +1698,101 @@ self
#DATABASE:
self
+
+
+
+-
+
+
+DATABASE:_RegisterGroupsAndUnits()
+
+
+-
+
+
Private method that registers all Groups and Units within in the mission.
+
+ Return value
+
+#DATABASE:
+self
+
+
+
+
+-
+
+
+DATABASE:_RegisterPlayers()
+
+
+-
+
+
Private method that registers all alive players in the mission.
+
+ Return value
+
+#DATABASE:
+self
+
+
+
+
+-
+
+
+DATABASE:_RegisterStaticTemplate(GroupTemplate, StaticTemplate, CoalitionID, CategoryID, CountryID)
+
+
+-
+
+
Private method that registers new Static Templates within the DATABASE Object.
+
+ Parameters
+
+ -
+
+
#table GroupTemplate :
+
+
+ -
+
+
StaticTemplate :
+
+
+ -
+
+
CoalitionID :
+
+
+ -
+
+
CategoryID :
+
+
+ -
+
+
CountryID :
+
+
+
+ Return value
+
+#DATABASE:
+self
+
+
+
+
+-
+
+
+DATABASE:_RegisterStatics()
+
+
+-
+
+
+
diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html
index e405ef044..ce5ce382d 100644
--- a/docs/Documentation/Detection.html
+++ b/docs/Documentation/Detection.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/DetectionManager.html b/docs/Documentation/DetectionManager.html
index ac9dbd961..feb3ef02d 100644
--- a/docs/Documentation/DetectionManager.html
+++ b/docs/Documentation/DetectionManager.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Escort.html b/docs/Documentation/Escort.html
index 1f0a069e8..b4744f616 100644
--- a/docs/Documentation/Escort.html
+++ b/docs/Documentation/Escort.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Event.html b/docs/Documentation/Event.html
index 8a94e12ab..0b437dd65 100644
--- a/docs/Documentation/Event.html
+++ b/docs/Documentation/Event.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html
index 1096eb06c..2844100c7 100644
--- a/docs/Documentation/Fsm.html
+++ b/docs/Documentation/Fsm.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Group.html b/docs/Documentation/Group.html
index edc5b0e62..b6a6e2528 100644
--- a/docs/Documentation/Group.html
+++ b/docs/Documentation/Group.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Identifiable.html b/docs/Documentation/Identifiable.html
index 517054986..910471fbf 100644
--- a/docs/Documentation/Identifiable.html
+++ b/docs/Documentation/Identifiable.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/MOVEMENT.html b/docs/Documentation/MOVEMENT.html
index ccaa648dc..02add9246 100644
--- a/docs/Documentation/MOVEMENT.html
+++ b/docs/Documentation/MOVEMENT.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
@@ -209,6 +210,7 @@ on defined intervals (currently every minute).
-
+ #number
MOVEMENT.AliveUnits
@@ -217,6 +219,9 @@ on defined intervals (currently every minute).
+
+
Contains the counter how many units are currently alive
+
diff --git a/docs/Documentation/Menu.html b/docs/Documentation/Menu.html
index eedc00986..a578185b3 100644
--- a/docs/Documentation/Menu.html
+++ b/docs/Documentation/Menu.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Message.html b/docs/Documentation/Message.html
index 1776bfb3e..504fcea66 100644
--- a/docs/Documentation/Message.html
+++ b/docs/Documentation/Message.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/MissileTrainer.html b/docs/Documentation/MissileTrainer.html
index 7876a3d73..4a1c318a1 100644
--- a/docs/Documentation/MissileTrainer.html
+++ b/docs/Documentation/MissileTrainer.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Mission.html b/docs/Documentation/Mission.html
index 9ca58b756..ac3b1191e 100644
--- a/docs/Documentation/Mission.html
+++ b/docs/Documentation/Mission.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Object.html b/docs/Documentation/Object.html
index 917e8c507..3579148b5 100644
--- a/docs/Documentation/Object.html
+++ b/docs/Documentation/Object.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Point.html b/docs/Documentation/Point.html
index 06c09a4b3..5818ceabf 100644
--- a/docs/Documentation/Point.html
+++ b/docs/Documentation/Point.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Positionable.html b/docs/Documentation/Positionable.html
index d01c213f7..c226bd787 100644
--- a/docs/Documentation/Positionable.html
+++ b/docs/Documentation/Positionable.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Process_JTAC.html b/docs/Documentation/Process_JTAC.html
index bdf36fb2d..fc4875aed 100644
--- a/docs/Documentation/Process_JTAC.html
+++ b/docs/Documentation/Process_JTAC.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Process_Pickup.html b/docs/Documentation/Process_Pickup.html
index db549cb39..304ed4fc4 100644
--- a/docs/Documentation/Process_Pickup.html
+++ b/docs/Documentation/Process_Pickup.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Radio.html b/docs/Documentation/Radio.html
index 0b93eff9d..f9b895436 100644
--- a/docs/Documentation/Radio.html
+++ b/docs/Documentation/Radio.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Route.html b/docs/Documentation/Route.html
index a666064c4..f1cd690ac 100644
--- a/docs/Documentation/Route.html
+++ b/docs/Documentation/Route.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Scenery.html b/docs/Documentation/Scenery.html
index 826738fc2..88029e853 100644
--- a/docs/Documentation/Scenery.html
+++ b/docs/Documentation/Scenery.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/ScheduleDispatcher.html b/docs/Documentation/ScheduleDispatcher.html
index 336e02a52..a50490b38 100644
--- a/docs/Documentation/ScheduleDispatcher.html
+++ b/docs/Documentation/ScheduleDispatcher.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Scheduler.html b/docs/Documentation/Scheduler.html
index 0cc29944b..3d8463caf 100644
--- a/docs/Documentation/Scheduler.html
+++ b/docs/Documentation/Scheduler.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Scoring.html b/docs/Documentation/Scoring.html
index 31f85f366..d60933fee 100644
--- a/docs/Documentation/Scoring.html
+++ b/docs/Documentation/Scoring.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Sead.html b/docs/Documentation/Sead.html
index 882f19124..732f5a220 100644
--- a/docs/Documentation/Sead.html
+++ b/docs/Documentation/Sead.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Set.html b/docs/Documentation/Set.html
index b7146af3d..29d8ccc88 100644
--- a/docs/Documentation/Set.html
+++ b/docs/Documentation/Set.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Smoke.html b/docs/Documentation/Smoke.html
index e277e59c6..9c43e8eb0 100644
--- a/docs/Documentation/Smoke.html
+++ b/docs/Documentation/Smoke.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html
index 4eb0349df..6193f9f69 100644
--- a/docs/Documentation/Spawn.html
+++ b/docs/Documentation/Spawn.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
@@ -99,6 +100,10 @@
+The documentation of the SPAWN class can be found further in this document.
+
+
+
Demo Missions
@@ -917,33 +922,83 @@ So in principle, the group list will contain all parameters and configurations a
A spawn object will behave differently based on the usage of initialization methods, which all start with the Init prefix:
+Unit Names
+
- SPAWN.InitKeepUnitNames(): Keeps the unit names as defined within the mission editor, but note that anything after a # mark is ignored, and any spaces before and after the resulting name are removed. IMPORTANT! This method MUST be the first used after :New !!!
- - SPAWN.InitLimit(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
+
+
+Route randomization
+
+
+
+Group composition randomization
+
+
- SPAWN.InitRandomizeTemplate(): Randomize the group templates so that when a new group is spawned, a random group template is selected from one of the templates defined.
+
+
+Uncontrolled
+
+
+
+Array formation
+
+
+
+Position randomization
+
+
- SPAWN.InitRandomizePosition(): Randomizes the position of Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.
- SPAWN.InitRandomizeUnits(): Randomizes the Units in the Group that is spawned within a radius band, given an Outer and Inner radius.
- SPAWN.InitRandomizeZones(): Randomizes the spawning between a predefined list of Zones that are declared using this function. Each zone can be given a probability factor.
+
+
+Enable / Disable AI when spawning a new Group
+
+
+Limit scheduled spawning
+
+
+ - SPAWN.InitLimit(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
+
+
+Delay initial scheduled spawn
+
+
+
+Repeat spawned Groups upon landing
+
+
+
+
SPAWN Spawn methods
Groups can be spawned at different times and methods:
+Single spawning methods
+
+
+ | SpawnStatic |
+
+ Functional -- Spawn dynamically new Statics in your missions.
|
diff --git a/docs/Documentation/land.html b/docs/Documentation/land.html
index 060915f8d..8d34bf296 100644
--- a/docs/Documentation/land.html
+++ b/docs/Documentation/land.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task
diff --git a/docs/Documentation/routines.html b/docs/Documentation/routines.html
index d72f63d77..ec770cd45 100644
--- a/docs/Documentation/routines.html
+++ b/docs/Documentation/routines.html
@@ -74,6 +74,7 @@
Set
Smoke
Spawn
+ SpawnStatic
Static
StaticObject
Task