diff --git a/Moose Development/Moose/Functional/Spawn.lua b/Moose Development/Moose/Functional/Spawn.lua index 9f5a87b1f..dfa15037d 100644 --- a/Moose Development/Moose/Functional/Spawn.lua +++ b/Moose Development/Moose/Functional/Spawn.lua @@ -200,6 +200,7 @@ -- * @{#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.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. -- -- 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. @@ -982,16 +983,49 @@ function SPAWN:OnSpawnGroup( SpawnCallBackFunction, ... ) return self end ---- Will spawn a group at an airbase. +--- Will spawn a group at an @{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. +-- 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. +-- +-- Use the method @{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! +-- -- @param #SPAWN self -- @param Wrapper.Airbase#AIRBASE SpawnAirbase The @{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. -- @return #nil Nothing was spawned. +-- @usage +-- Spawn_Plane = SPAWN:New( "Plane" ) +-- Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold ) +-- Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Hot ) +-- Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Runway ) +-- +-- Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold ) +-- +-- Spawn_Heli = SPAWN:New( "Heli") +-- +-- Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Cold" ), SPAWN.Takeoff.Cold ) +-- Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Hot" ), SPAWN.Takeoff.Hot ) +-- Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Runway" ), SPAWN.Takeoff.Runway ) +-- Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Air" ), SPAWN.Takeoff.Air ) +-- +-- Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold ) +-- function SPAWN:SpawnAtAirbase( SpawnAirbase, Takeoff, TakeoffAltitude ) -- R2.2 self:E( { self.SpawnTemplatePrefix, SpawnAirbase, Takeoff, TakeoffAltitude } ) diff --git a/docs/Documentation/AI_Patrol.html b/docs/Documentation/AI_Patrol.html index 5e8474fed..5b64ef359 100644 --- a/docs/Documentation/AI_Patrol.html +++ b/docs/Documentation/AI_Patrol.html @@ -927,6 +927,9 @@ Use the method AIPATROLZONE.M + +

This table contains the targets detected during patrol.

+
diff --git a/docs/Documentation/Designate.html b/docs/Documentation/Designate.html index e613b9310..ff349e1b5 100644 --- a/docs/Documentation/Designate.html +++ b/docs/Documentation/Designate.html @@ -1097,7 +1097,7 @@ function below will use the range 1-7 just in case

- + #number DESIGNATE.LaseDuration diff --git a/docs/Documentation/Detection.html b/docs/Documentation/Detection.html index e05e22c9f..db832f4d5 100644 --- a/docs/Documentation/Detection.html +++ b/docs/Documentation/Detection.html @@ -2460,6 +2460,7 @@ The index of the DetectedItem.

+ #number DETECTION_BASE.DetectedItemCount @@ -4051,7 +4052,7 @@ Return false to cancel Transition.

- + #number DETECTION_BASE.RefreshTimeInterval diff --git a/docs/Documentation/Fsm.html b/docs/Documentation/Fsm.html index b58946d17..dc67c7520 100644 --- a/docs/Documentation/Fsm.html +++ b/docs/Documentation/Fsm.html @@ -1599,7 +1599,7 @@ A string defining the start state.

- #string + FSM._StartState @@ -1898,6 +1898,7 @@ A string defining the start state.

+ FSM.current diff --git a/docs/Documentation/Movement.html b/docs/Documentation/Movement.html index dfb86750e..3123488df 100644 --- a/docs/Documentation/Movement.html +++ b/docs/Documentation/Movement.html @@ -228,6 +228,7 @@ on defined intervals (currently every minute).

+ #number MOVEMENT.AliveUnits @@ -236,6 +237,9 @@ on defined intervals (currently every minute).

+ +

Contains the counter how many units are currently alive

+
diff --git a/docs/Documentation/Settings.html b/docs/Documentation/Settings.html index 0ff600a3c..274a10019 100644 --- a/docs/Documentation/Settings.html +++ b/docs/Documentation/Settings.html @@ -1241,7 +1241,7 @@ true if metric.

- + #boolean SETTINGS.Metric diff --git a/docs/Documentation/Spawn.html b/docs/Documentation/Spawn.html index e842b54c0..2a77723ca 100644 --- a/docs/Documentation/Spawn.html +++ b/docs/Documentation/Spawn.html @@ -424,9 +424,9 @@ and any spaces before and after the resulting name are removed.

- SPAWN:SpawnAtAirbase(Airbase, Takeoff, TakeoffAltitude) + SPAWN:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude) -

Will spawn a group at an airbase.

+

Will spawn a group at an Airbase.

@@ -829,16 +829,6 @@ and any spaces before and after the resulting name are removed.

SPAWN.uncontrolled - - - - -

Type SPAWN.Takeoff

- - - -
SPAWN.Takeoff.type -
@@ -1034,6 +1024,7 @@ So in principle, the group list will contain all parameters and configurations a
  • 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.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.

    • Note that SPAWN.Spawn and SPAWN.ReSpawn return a GROUP#GROUP.New object, that contains a reference to the DCSGroup object. @@ -2201,9 +2192,6 @@ The group that was spawned. You can use this group for further actions.

    - -

    Don't repeat the group from Take-Off till Landing and back Take-Off by ReSpawning.

    -
    @@ -2273,23 +2261,41 @@ The group that was spawned. You can use this group for further actions.

    -SPAWN:SpawnAtAirbase(Airbase, Takeoff, TakeoffAltitude) +SPAWN:SpawnAtAirbase(SpawnAirbase, Takeoff, TakeoffAltitude)
    -

    Will spawn a group at an airbase.

    +

    Will spawn a group at an 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. +You can use the following enumerations to search for the pre-defined airbases on the current known maps of DCS:

    + + + +

    Use the method 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!

    + +

    Parameters

    • -

      Wrapper.Airbase#AIRBASE Airbase : +

      Wrapper.Airbase#AIRBASE SpawnAirbase : The Airbase where to spawn the group.

      • @@ -2321,6 +2327,24 @@ Nothing was spawned.

      +

      Usage:

      + 
        Spawn_Plane = SPAWN:New( "Plane" )
+  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold )
+  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Hot )
+  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Runway )
+  
+  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
+  
+  Spawn_Heli = SPAWN:New( "Heli")
+  
+  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Cold" ), SPAWN.Takeoff.Cold )
+  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Hot" ), SPAWN.Takeoff.Hot )
+  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Runway" ), SPAWN.Takeoff.Runway )
+  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "FARP Air" ), SPAWN.Takeoff.Air )
+  
+  Spawn_Heli:SpawnAtAirbase( AIRBASE:FindByName( "Carrier" ), SPAWN.Takeoff.Cold )
+
      +
    @@ -2756,9 +2780,6 @@ when nothing was spawned.

    - -

    By default, no InitLimit

    -
    @@ -2794,7 +2815,7 @@ when nothing was spawned.

    - #number + SPAWN.SpawnMaxGroups @@ -2811,7 +2832,7 @@ when nothing was spawned.

    - #number + SPAWN.SpawnMaxUnitsAlive @@ -3139,7 +3160,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )
    - #boolean + SPAWN.SpawnUnControlled @@ -3163,7 +3184,7 @@ Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 ) -

    Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

    +

    When the first Spawn executes, all the Groups need to be made visible before start.

    @@ -3766,20 +3787,6 @@ True = Continue Scheduler

    Enumerator for spawns at airbases

    -

    Field(s)

    -
    -
    - - -SPAWN.Takeoff.type - -
    -
    - - - -
    -
    diff --git a/docs/Documentation/SpawnStatic.html b/docs/Documentation/SpawnStatic.html index 251693d35..487563b09 100644 --- a/docs/Documentation/SpawnStatic.html +++ b/docs/Documentation/SpawnStatic.html @@ -437,7 +437,6 @@ ptional) The name of the new static.

    - #number SPAWNSTATIC.SpawnIndex diff --git a/docs/Documentation/Task_Cargo.html b/docs/Documentation/Task_Cargo.html index d83d8b1f6..2f9cb7b3a 100644 --- a/docs/Documentation/Task_Cargo.html +++ b/docs/Documentation/Task_Cargo.html @@ -567,6 +567,7 @@ based on the tasking capabilities defined in Task#TA
    + FSM_PROCESS.DeployZone @@ -631,7 +632,7 @@ based on the tasking capabilities defined in Task#TA
    - + #number TASK_CARGO.CargoLimit