Optimized comments and documentation set

Moose Development/Moose/Core/Spawn.lua

@@ -37,7 +37,7 @@
 -- @extends Core.Base#BASE
 
 
---- # SPAWN class, extends @{Base#BASE}
+--- # SPAWN class, extends @{Core.Base#BASE}
 -- 
 -- -- ![Banner Image](..\Presentations\SPAWN\SPAWN.JPG)
 -- 
@@ -67,8 +67,8 @@
 -- **Limits** can be set on how many groups can be spawn in each SPAWN object, 
 -- using the method @{#SPAWN.InitLimit}. SPAWN has 2 kind of limits:
 -- 
---   * The maximum amount of @{Unit}s that can be **alive** at the same time... 
---   * The maximum amount of @{Group}s that can be **spawned**... This is more of a **resource**-type of limit.
+--   * The maximum amount of @{Wrapper.Unit}s that can be **alive** at the same time... 
+--   * The maximum amount of @{Wrapper.Group}s that can be **spawned**... This is more of a **resource**-type of limit.
 --   
 -- When new groups get spawned using the **Spawn** methods, 
 -- it will be evaluated whether any limits have been reached.
@@ -82,7 +82,7 @@
 -- with unlimited resources = :InitLimit( 100, 0 ) and 10 groups are alive, but two groups have only one unit alive in the group,
 -- then a sequent Spawn(Scheduled) will allow a new group to be spawned!!!
 -- 
--- ### IMPORTANT!! If a limit has been reached, it is possible that a **Spawn** method returns **nil**, meaning, no @{Group} had been spawned!!!  
+-- ### IMPORTANT!! If a limit has been reached, it is possible that a **Spawn** method returns **nil**, meaning, no @{Wrapper.Group} had been spawned!!!  
 -- 
 -- Spawned groups get **the same name** as the name of the template group.  
 -- Spawned units in those groups keep _by default_ **the same name** as the name of the template group.  
@@ -117,7 +117,7 @@
 -- Create a new SPAWN object with the @{#SPAWN.New}() or the @{#SPAWN.NewWithAlias}() methods:
 -- 
 --   * @{#SPAWN.New}(): Creates a new SPAWN object taking the name of the group that represents the GROUP template (definition).
---   * @{#SPAWN.NewWithAlias}(): Creates a new SPAWN object taking the name of the group that represents the GROUP template (definition), and gives each spawned @{Group} an different name.
+--   * @{#SPAWN.NewWithAlias}(): Creates a new SPAWN object taking the name of the group that represents the GROUP template (definition), and gives each spawned @{Wrapper.Group} an different name.
 --
 -- It is important to understand how the SPAWN class works internally. The SPAWN object created will contain internally a list of groups that will be spawned and that are already spawned.
 -- The initialization methods will modify this list of groups so that when a group gets spawned, ALL information is already prepared when spawning. This is done for performance reasons.
@@ -149,15 +149,15 @@
 -- 
 -- ### 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.InitRandomizePosition}(): Randomizes the position of @{Wrapper.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 @{Wrapper.Unit}s in the @{Wrapper.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}
+-- ### Enable / Disable AI when spawning a new @{Wrapper.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.InitAIOn}(): Turns the AI On when spawning the new @{Wrapper.Group} object.
+--   * @{#SPAWN.InitAIOff}(): Turns the AI Off when spawning the new @{Wrapper.Group} object.
+--   * @{#SPAWN.InitAIOnOff}(): Turns the AI On or Off when spawning the new @{Wrapper.Group} object.
 -- 
 -- ### Limit scheduled spawning  
 --   
@@ -165,11 +165,11 @@
 --   
 -- ### 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.
+--   * @{#SPAWN.InitDelayOnOff}(): Turns the inital delay On/Off when scheduled spawning the first @{Wrapper.Group} object.
+--   * @{#SPAWN.InitDelayOn}(): Turns the inital delay On when scheduled spawning the first @{Wrapper.Group} object.
+--   * @{#SPAWN.InitDelayOff}(): Turns the inital delay Off when scheduled spawning the first @{Wrapper.Group} object.
 -- 
--- ### Repeat spawned @{Group}s upon landing
+-- ### Repeat spawned @{Wrapper.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.
@@ -186,9 +186,9 @@
 --   * @{#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}.
---   * @{#SPAWN.SpawnFromUnit}(): Spawn a new group taking the position of a @{Unit}.
+--   * @{#SPAWN.SpawnFromUnit}(): Spawn a new group taking the position of a @{Wrapper.Unit}.
 --   * @{#SPAWN.SpawnInZone}(): Spawn a new group in a @{Zone}.
---   * @{#SPAWN.SpawnAtAirbase}(): Spawn a new group at an @{Airbase}, which can be an airdrome, ship or helipad.
+--   * @{#SPAWN.SpawnAtAirbase}(): Spawn a new group at an @{Wrapper.Airbase}, which can be an airdrome, ship or helipad.
 -- 
 -- 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.
@@ -226,21 +226,21 @@
 -- This models AI that has succesfully returned to their airbase, to restart their combat activities.
 -- Check the @{#SPAWN.InitCleanUp}() for further info.
 -- 
--- ## Catch the @{Group} Spawn Event in a callback function!
+-- ## Catch the @{Wrapper.Group} Spawn Event in a callback function!
 -- 
--- When using the @{#SPAWN.SpawnScheduled)() method, new @{Group}s are created following the spawn time interval parameters.
--- When a new @{Group} is spawned, you maybe want to execute actions with that group spawned at the spawn event.
+-- When using the @{#SPAWN.SpawnScheduled)() method, new @{Wrapper.Group}s are created following the spawn time interval parameters.
+-- When a new @{Wrapper.Group} is spawned, you maybe want to execute actions with that group spawned at the spawn event.
 -- The SPAWN class supports this functionality through the method @{#SPAWN.OnSpawnGroup}( **function( SpawnedGroup ) end ** ), 
 -- which takes a function as a parameter that you can define locally. 
--- Whenever a new @{Group} is spawned, the given function is called, and the @{Group} that was just spawned, is given as a parameter.
--- As a result, your spawn event handling function requires one parameter to be declared, which will contain the spawned @{Group} object. 
+-- Whenever a new @{Wrapper.Group} is spawned, the given function is called, and the @{Wrapper.Group} that was just spawned, is given as a parameter.
+-- As a result, your spawn event handling function requires one parameter to be declared, which will contain the spawned @{Wrapper.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}
+-- When using the @{#SPAWN.SpawnScheduled)() method, the default behaviour of this method will be that it will spawn the initial (first) @{Wrapper.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
+-- activate a delay before the first @{Wrapper.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.
 -- 
@@ -270,7 +270,7 @@ SPAWN.Takeoff = {
 -- @list <Core.Zone#ZONE_BASE> SpawnZone
 
 
---- Creates the main object to spawn a @{Group} defined in the DCS ME.
+--- Creates the main object to spawn a @{Wrapper.Group} defined in the DCS ME.
 -- @param #SPAWN self
 -- @param #string SpawnTemplatePrefix is the name of the Group in the ME that defines the Template.  Each new group will have the name starting with SpawnTemplatePrefix.
 -- @return #SPAWN
@@ -551,9 +551,9 @@ function SPAWN:InitRandomizeRoute( SpawnStartPoint, SpawnEndPoint, SpawnRadius,
 	return self
 end
 
---- 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.
+--- Randomizes the position of @{Wrapper.Group}s that are spawned within a **radius band**, given an Outer and Inner radius, from the point that the spawn happens.
 -- @param #SPAWN self
--- @param #boolean RandomizePosition If true, SPAWN will perform the randomization of the @{Group}s position between a given outer and inner radius. 
+-- @param #boolean RandomizePosition If true, SPAWN will perform the randomization of the @{Wrapper.Group}s position between a given outer and inner radius. 
 -- @param Dcs.DCSTypes#Distance OuterRadius (optional) The outer radius in meters where the new group will be spawned.
 -- @param Dcs.DCSTypes#Distance InnerRadius (optional) The inner radius in meters where the new group will NOT be spawned.
 -- @return #SPAWN
@@ -904,7 +904,7 @@ function SPAWN:InitArray( SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY )
 end
 
 do -- AI methods
-  --- Turns the AI On or Off for the @{Group} when spawning.
+  --- Turns the AI On or Off for the @{Wrapper.Group} when spawning.
   -- @param #SPAWN self
   -- @param #boolean AIOnOff A value of true sets the AI On, a value of false sets the AI Off.
   -- @return #SPAWN The SPAWN object
@@ -914,7 +914,7 @@ do -- AI methods
     return self
   end
   
-  --- Turns the AI On for the @{Group} when spawning.
+  --- Turns the AI On for the @{Wrapper.Group} when spawning.
   -- @param #SPAWN self
   -- @return #SPAWN The SPAWN object
   function SPAWN:InitAIOn()
@@ -922,7 +922,7 @@ do -- AI methods
     return self:InitAIOnOff( true )
   end
   
-  --- Turns the AI Off for the @{Group} when spawning.
+  --- Turns the AI Off for the @{Wrapper.Group} when spawning.
   -- @param #SPAWN self
   -- @return #SPAWN The SPAWN object
   function SPAWN:InitAIOff()
@@ -933,8 +933,8 @@ do -- AI methods
 end -- AI methods
 
 do -- Delay methods
-  --- Turns the Delay On or Off for the first @{Group} scheduled spawning.
-  -- The default value is that for scheduled spawning, there is an initial delay when spawning the first @{Group}.
+  --- Turns the Delay On or Off for the first @{Wrapper.Group} scheduled spawning.
+  -- The default value is that for scheduled spawning, there is an initial delay when spawning the first @{Wrapper.Group}.
   -- @param #SPAWN self
   -- @param #boolean DelayOnOff A value of true sets the Delay On, a value of false sets the Delay Off.
   -- @return #SPAWN The SPAWN object
@@ -944,7 +944,7 @@ do -- Delay methods
     return self
   end
   
-  --- Turns the Delay On for the @{Group} when spawning.
+  --- Turns the Delay On for the @{Wrapper.Group} when spawning.
   -- @param #SPAWN self
   -- @return #SPAWN The SPAWN object
   function SPAWN:InitDelayOn()
@@ -952,7 +952,7 @@ do -- Delay methods
     return self:InitDelayOnOff( true )
   end
   
-  --- Turns the Delay Off for the @{Group} when spawning.
+  --- Turns the Delay Off for the @{Wrapper.Group} when spawning.
   -- @param #SPAWN self
   -- @return #SPAWN The SPAWN object
   function SPAWN:InitDelayOff()
@@ -1172,7 +1172,7 @@ end
 
 --- Allows to place a CallFunction hook when a new group spawns.
 -- The provided method will be called when a new group is spawned, including its given parameters.
--- The first parameter of the SpawnFunction is the @{Group#GROUP} that was spawned.
+-- The first parameter of the SpawnFunction is the @{Wrapper.Group#GROUP} that was spawned.
 -- @param #SPAWN self
 -- @param #function SpawnCallBackFunction The function to be called when a group spawns.
 -- @param SpawnFunctionArguments A random amount of arguments to be provided to the function when the group spawns.
@@ -1200,28 +1200,28 @@ function SPAWN:OnSpawnGroup( SpawnCallBackFunction, ... )
   return self
 end
 
---- Will spawn a group at an @{Airbase}. 
+--- Will spawn a group at an @{Wrapper.Airbase}. 
 -- This method is mostly advisable to be used if you want to simulate spawning units at an airbase.
 -- Note that each point in the route assigned to the spawning group is reset to the point of the spawn.
 -- You can use the returned group to further define the route to be followed.
 -- 
--- The @{Airbase#AIRBASE} object must refer to a valid airbase known in the sim.
+-- The @{Wrapper.Airbase#AIRBASE} object must refer to a valid airbase known in the sim.
 -- You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:
 -- 
---   * @{Airbase#AIRBASE.Caucasus}: The airbases on the Caucasus map. 
---   * @{Airbase#AIRBASE.Nevada}: The airbases on the Nevada (NTTR) map. 
---   * @{Airbase#AIRBASE.Normandy}: The airbases on the Normandy map. 
+--   * @{Wrapper.Airbase#AIRBASE.Caucasus}: The airbases on the Caucasus map. 
+--   * @{Wrapper.Airbase#AIRBASE.Nevada}: The airbases on the Nevada (NTTR) map. 
+--   * @{Wrapper.Airbase#AIRBASE.Normandy}: The airbases on the Normandy map. 
 -- 
--- Use the method @{Airbase#AIRBASE.FindByName}() to retrieve the airbase object. 
+-- Use the method @{Wrapper.Airbase#AIRBASE.FindByName}() to retrieve the airbase object. 
 -- The known AIRBASE objects are automatically imported at mission start by MOOSE.
 -- Therefore, there isn't any New() constructor defined for AIRBASE objects.
 -- 
 -- Ships and Farps are added within the mission, and are therefore not known.
--- For these AIRBASE objects, there isn't an @{Airbase#AIRBASE} enumeration defined.
--- You need to provide the **exact name** of the airbase as the parameter to the @{Airbase#AIRBASE.FindByName}() method!
+-- For these AIRBASE objects, there isn't an @{Wrapper.Airbase#AIRBASE} enumeration defined.
+-- You need to provide the **exact name** of the airbase as the parameter to the @{Wrapper.Airbase#AIRBASE.FindByName}() method!
 -- 
 -- @param #SPAWN self
--- @param Wrapper.Airbase#AIRBASE SpawnAirbase The @{Airbase} where to spawn the group.
+-- @param Wrapper.Airbase#AIRBASE SpawnAirbase The @{Wrapper.Airbase} where to spawn the group.
 -- @param #SPAWN.Takeoff Takeoff (optional) The location and takeoff method. Default is Hot.
 -- @param #number TakeoffAltitude (optional) The altitude above the ground.
 -- @return Wrapper.Group#GROUP that was spawned.
@@ -1579,12 +1579,12 @@ function SPAWN:SpawnFromStatic( HostStatic, MinHeight, MaxHeight, SpawnIndex )
 end
 
 --- Will spawn a Group within a given @{Zone}.
--- The @{Zone} can be of any type derived from @{Zone#ZONE_BASE}.
--- Once the @{Group} is spawned within the zone, the @{Group} will continue on its route.
+-- The @{Zone} can be of any type derived from @{Core.Zone#ZONE_BASE}.
+-- Once the @{Wrapper.Group} is spawned within the zone, the @{Wrapper.Group} will continue on its route.
 -- The **first waypoint** (where the group is spawned) is replaced with the zone location coordinates.
 -- @param #SPAWN self
 -- @param Core.Zone#ZONE Zone The zone where the group is to be spawned.
--- @param #boolean RandomizeGroup (optional) Randomization of the @{Group} position in the zone.
+-- @param #boolean RandomizeGroup (optional) Randomization of the @{Wrapper.Group} position in the zone.
 -- @param #number MinHeight (optional) The minimum height to spawn an airborne group into the zone.
 -- @param #number MaxHeight (optional) The maximum height to spawn an airborne group into the zone.
 -- @param #number SpawnIndex (optional) The index which group to spawn within the given zone.
@@ -1680,12 +1680,12 @@ function SPAWN:SpawnGroupName( SpawnIndex )
 	
 end
 
---- Will find the first alive @{Group} it has spawned, and return the alive @{Group} object and the first Index where the first alive @{Group} object has been found.
+--- Will find the first alive @{Wrapper.Group} it has spawned, and return the alive @{Wrapper.Group} object and the first Index where the first alive @{Wrapper.Group} object has been found.
 -- @param #SPAWN self
--- @return Wrapper.Group#GROUP, #number The @{Group} object found, the new Index where the group was found.
+-- @return Wrapper.Group#GROUP, #number The @{Wrapper.Group} object found, the new Index where the group was found.
 -- @return #nil, #nil When no group is found, #nil is returned.
 -- @usage
--- -- Find the first alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
+-- -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
 -- local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
 -- while GroupPlane ~= nil do
 --   -- Do actions with the GroupPlane object.
@@ -1705,13 +1705,13 @@ function SPAWN:GetFirstAliveGroup()
 end
 
 
---- Will find the next alive @{Group} object from a given Index, and return a reference to the alive @{Group} object and the next Index where the alive @{Group} has been found.
+--- Will find the next alive @{Wrapper.Group} object from a given Index, and return a reference to the alive @{Wrapper.Group} object and the next Index where the alive @{Wrapper.Group} has been found.
 -- @param #SPAWN self
--- @param #number SpawnIndexStart A Index holding the start position to search from. This method can also be used to find the first alive @{Group} object from the given Index.
--- @return Wrapper.Group#GROUP, #number The next alive @{Group} object found, the next Index where the next alive @{Group} object was found.
--- @return #nil, #nil When no alive @{Group} object is found from the start Index position, #nil is returned.
+-- @param #number SpawnIndexStart A Index holding the start position to search from. This method can also be used to find the first alive @{Wrapper.Group} object from the given Index.
+-- @return Wrapper.Group#GROUP, #number The next alive @{Wrapper.Group} object found, the next Index where the next alive @{Wrapper.Group} object was found.
+-- @return #nil, #nil When no alive @{Wrapper.Group} object is found from the start Index position, #nil is returned.
 -- @usage
--- -- Find the first alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
+-- -- Find the first alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
 -- local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
 -- while GroupPlane ~= nil do
 --   -- Do actions with the GroupPlane object.
@@ -1731,12 +1731,12 @@ function SPAWN:GetNextAliveGroup( SpawnIndexStart )
   return nil, nil
 end
 
---- Will find the last alive @{Group} object, and will return a reference to the last live @{Group} object and the last Index where the last alive @{Group} object has been found.
+--- Will find the last alive @{Wrapper.Group} object, and will return a reference to the last live @{Wrapper.Group} object and the last Index where the last alive @{Wrapper.Group} object has been found.
 -- @param #SPAWN self
--- @return Wrapper.Group#GROUP, #number The last alive @{Group} object found, the last Index where the last alive @{Group} object was found.
--- @return #nil, #nil When no alive @{Group} object is found, #nil is returned.
+-- @return Wrapper.Group#GROUP, #number The last alive @{Wrapper.Group} object found, the last Index where the last alive @{Wrapper.Group} object was found.
+-- @return #nil, #nil When no alive @{Wrapper.Group} object is found, #nil is returned.
 -- @usage
--- -- Find the last alive @{Group} object of the SpawnPlanes SPAWN object @{Group} collection that it has spawned during the mission.
+-- -- Find the last alive @{Wrapper.Group} object of the SpawnPlanes SPAWN object @{Wrapper.Group} collection that it has spawned during the mission.
 -- local GroupPlane, Index = SpawnPlanes:GetLastAliveGroup()
 -- if GroupPlane then -- GroupPlane can be nil!!!
 --   -- Do actions with the GroupPlane object.