Get the Coordinate of the Group that is Late Activated as the template for the SPAWN object.

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.

  -- 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.
    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
  end

Get the group from an index.

Returns the group from the SpawnGroups list. If no index is given, it will return the first group in the list.

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.

  -- 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.
  end

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.

  -- 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.
    GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
  end

Get the index from a given group.

The function will search the name of the group for a #, and will return the number behind the #-mark.

Turns the AI Off for the Wrapper.Group when spawning.

Turns the AI On for the Wrapper.Group when spawning.

Turns the AI On or Off for the Wrapper.Group when spawning.

Set spawns to happen at a particular airbase.

Only for aircraft, of course.

Makes the groups visible before start (like a battalion).

The method will take the position of the group as the first position in the array. CAUTION: this directive will NOT work with OnSpawnGroup function.

  -- Define an array of Groups.
  Spawn_BE_Ground = SPAWN:New( 'BE Ground' )
                         :InitLimit( 2, 24 )
                         :InitArray( 90, 10, 100, 50 )

[BLUE AIR only!] This method sets a specific callsign for a spawned group.

Use for a group with one unit only!

Sets category ID of the group.

Delete groups that have not moved for X seconds - AIR ONLY!!! DO NOT USE ON GROUPS THAT DO NOT MOVE OR YOUR SERVER WILL BURN IN HELL (Pikes - April 2020) When groups are still alive and have become inactive due to damage and are unable to contribute anything, then this group will be removed at defined intervals in seconds.

  Spawn_Helicopter:InitCleanUp( 20 )  -- CleanUp the spawning of the helicopters every 20 seconds when they become inactive.

Sets the coalition of the spawned group.

Note that it might be necessary to also set the country explicitly!

Sets the country of the spawn group.

Note that the country determines the coalition of the group depending on which country is defined to be on which side for each specific mission!

Turns the Delay Off for the Wrapper.Group when spawning.

Turns the Delay On for the Wrapper.Group when spawning with #SpawnScheduled().

In effect then the 1st group will only be spawned after the number of seconds given in SpawnScheduled as arguments, and not immediately.

Defines the heading of the overall formation of the new spawned group.

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees. The Group's formation as laid out in its template will be rotated around the first unit in the group Group individual units facings will rotate to match. If InitHeading is also applied to this SPAWN then that will take precedence for individual unit facings. Note that InitGroupHeading does not rotate the groups route; only its initial facing!

mySpawner = SPAWN:New( ... )

  -- Spawn the Group with the formation rotated +100 degrees around unit #1, compared to the mission template.
  mySpawner:InitGroupHeading( 100 )

  -- Spawn the Group with the formation rotated units between +100 and +150 degrees around unit #1, compared to the mission template, and with individual units varying by +/- 10 degrees from their templated facing.
  mySpawner:InitGroupHeading( 100, 150, 10 )

  -- Spawn the Group with the formation rotated -60 degrees around unit #1, compared to the mission template, but with all units facing due north regardless of how they were laid out in the template.
  mySpawner:InitGroupHeading(-60):InitHeading(0)
  -- or
  mySpawner:InitHeading(0):InitGroupHeading(-60)

When spawning a new group, make the grouping of the units according the InitGrouping setting.

Defines the Heading for the new spawned units.

The heading can be given as one fixed degree, or can be randomized between minimum and maximum degrees.

  Spawn = SPAWN:New( ... )

  -- Spawn the units pointing to 100 degrees.
  Spawn:InitHeading( 100 )

  -- Spawn the units pointing between 100 and 150 degrees.
  Spawn:InitHeading( 100, 150 )

Hide the group on MFDs (visible to game master slots!).

Hide the group on the map view (visible to game master slots!).

Hide the group on planner (visible to game master slots!).

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 !!!

Flags that the spawned groups must be spawned late activated.

Stops any more repeat spawns from happening once the UNIT count of Alive units, spawned by the same SPAWN object, exceeds the first parameter.

Also can stop spawns from happening once a total GROUP still alive is met. Exceptionally powerful when combined with SpawnSchedule for Respawning. Note that this method is exceptionally important to balance the performance of the mission. Depending on the machine etc, a mission can only process a maximum amount of units. If the time interval must be short, but there should not be more Units or Groups alive than a maximum amount of units, then this method should be used... When a SPAWN.New is executed and the limit of the amount of units alive is reached, then no new spawn will happen of the group, until some of these units of the spawn object will be destroyed.

  -- NATO helicopters engaging in the battle field.
  -- This helicopter group consists of one Unit. So, this group will SPAWN maximum 2 groups simultaneously within the DCSRTE.
  -- There will be maximum 24 groups spawned during the whole mission lifetime. 
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitLimit( 2, 24 )

Sets livery of the group.

Sets the modex of the first unit of the group.

If more units are in the group, the number is increased by one with every unit.

This method sets a spawn position for the group that is different from the location of the template.

This method sets a spawn position for the group that is different from the location of the template.

Sets the radio communication on or off.

Same as checking/unchecking the COMM box in the mission editor.

Sets the radio frequency of the group.

Set radio modulation.

Default is AM.

[AIR/Fighter only!] This method randomizes the callsign for a new group.

Randomizes the position of Wrapper.Groups that are spawned within a radius band, given an Outer and Inner radius, from the point that the spawn happens.

Randomizes the defined route of the SpawnTemplatePrefix group in the ME.

This is very useful to define extra variation of the behavior of groups.

  -- NATO helicopters engaging in the battle field.
  -- The KA-50 has waypoints Start point ( =0 or SP ), 1, 2, 3, 4, End point (= 5 or DP).
  -- Waypoints 2 and 3 will only be randomized. The others will remain on their original position with each new spawn of the helicopter.
  -- The randomization of waypoint 2 and 3 will take place within a radius of 2000 meters.
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeRoute( 2, 2, 2000 )

This method is rather complicated to understand.

But I'll try to explain. 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.

  -- NATO Tank Platoons invading Gori.
  -- Choose between 13 different 'US Tank Platoon' configurations for each new SPAWN the Group to be spawned for the
  -- 'US Tank Platoon Left', 'US Tank Platoon Middle' and 'US Tank Platoon Right' SpawnTemplatePrefixes.
  -- 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 simultaneously  and 150 Groups to be spawned during the whole mission.
  Spawn_US_Platoon = { 'US Tank Platoon 1', 'US Tank Platoon 2', 'US Tank Platoon 3', 'US Tank Platoon 4', 'US Tank Platoon 5',
                       'US Tank Platoon 6', 'US Tank Platoon 7', 'US Tank Platoon 8', 'US Tank Platoon 9', 'US Tank Platoon 10',
                       'US Tank Platoon 11', 'US Tank Platoon 12', 'US Tank Platoon 13' }
  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )

Randomize templates to be used as the unit representatives for the Spawned group, defined by specifying the prefix names.

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.

 -- 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 simultaneously  and 150 Groups to be spawned during the whole mission.

  Spawn_US_Platoon_Left = SPAWN:New( 'US Tank Platoon Left' ):InitLimit( 12, 150 ):SpawnScheduled( 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 ):SpawnScheduled( 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 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplatePrefixes( "US Tank Platoon Templates" ):InitRandomizeRoute( 3, 3, 2000 )

Randomize templates to be used as the unit representatives for the Spawned group, defined using a SET_GROUP object.

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.

  -- 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 simultaneously  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 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )
  Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):SpawnScheduled( 200, 0.4 ):InitRandomizeTemplateSet( Spawn_US_PlatoonSet ):InitRandomizeRoute( 3, 3, 2000 )

Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.

  -- NATO helicopters engaging in the battle field.
  -- UNIT positions of this group will be randomized around the base unit #1 in a circle of 50 to 500 meters.
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitRandomizeUnits( true, 500, 50 )

This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types.

   -- Create a zone table of the 2 zones.
   ZoneTable = { ZONE:New( "Zone1" ), ZONE:New( "Zone2" ) }

   Spawn_Vehicle_1 = SPAWN:New( "Spawn Vehicle 1" )
                          :InitLimit( 10, 10 )
                          :InitRandomizeRoute( 1, 1, 200 )
                          :InitRandomizeZones( ZoneTable )
                          :SpawnScheduled( 5, .5 )

For planes and helicopters, when these groups go home and land on their home airbases and FARPs, they normally would taxi to the parking spot, shut-down their engines and wait forever until the Group is removed by the runtime environment.

This method is used to re-spawn automatically (so no extra call is needed anymore) the same group after it has landed. This will enable a spawned group to be re-spawned after it lands, until it is destroyed... Note: When the group is respawned, it will re-spawn from the original airbase where it took off. So ensure that the routes for groups that respawn, always return to the original airbase, or players may get confused ...

  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :Schedule( 2, 3, 1800, 0.4 )
                      :SpawnUncontrolled()
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnEngineShutDown()

Respawn after landing when its engines have shut down.

  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :SpawnUncontrolled()
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnEngineShutDown()
                      :Spawn()

Respawn group after landing.

  -- RU Su-34 - AI Ship Attack
  -- Re-SPAWN the Group(s) after each landing and Engine Shut-Down automatically.
  SpawnRU_SU34 = SPAWN:New( 'Su-34' )
                      :InitRandomizeRoute( 1, 1, 3000 )
                      :InitRepeatOnLanding()
                      :Spawn()

[Airplane - A10-C II only] Set the SADL TN starting number of the Group; each unit of the spawned group will have a consecutive SADL set.

[Airplane - F15/16/18/AWACS/B1B/Tanker only] Set the STN Link16 starting number of the Group; each unit of the spawned group will have a consecutive STN set.

Spawn the UNITs of this group with individual absolute positions and individual headings.

  -- NATO helicopter group of three units engaging in the battle field.
  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitAbsolutePositions(Positions)

Spawn the UNITs of this group with individual relative positions to unit #1 and individual headings.

  -- NATO helicopter group of three units engaging in the battle field.
  local Positions = { [1] = {x = 0, y = 0, heading = 0}, [2] = {x = 50, y = 50, heading = 90}, [3] = {x = -50, y = 50, heading = 180} }
  Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):InitSetUnitRelativePositions(Positions)

Sets skill of the group.

[Airplane] Set the initial speed on spawning in knots.

Useful when spawning in-air only.

[Airplane] Set the initial speed on spawning in kilometers per hour.

Useful when spawning in-air only.

[Airplane] Set the initial speed on spawning in meters per second.

Useful when spawning in-air only.

(AIR) Will spawn a plane group in UnControlled or Controlled mode...

This will be similar to the uncontrolled flag setting in the ME. You can use UnControlled mode to simulate planes startup and ready for take-off but aren't moving (yet). ReSpawn the plane in Controlled mode, and the plane will move...

Creates the main object to spawn a Wrapper.Group defined in the DCS ME.

Creates a new SPAWN instance to create new groups based on the provided template.

This will also register the template for future use.

-- Spawn a P51 Mustang from scratch
local ttemp =  
  {
      ["modulation"] = 0,
      ["tasks"] = 
      {
      }, -- end of ["tasks"]
      ["task"] = "Reconnaissance",
      ["uncontrolled"] = false,
      ["route"] = 
      {
          ["points"] = 
          {
              [1] = 
              {
                  ["alt"] = 2000,
                  ["action"] = "Turning Point",
                  ["alt_type"] = "BARO",
                  ["speed"] = 125,
                  ["task"] = 
                  {
                      ["id"] = "ComboTask",
                      ["params"] = 
                      {
                          ["tasks"] = 
                          {
                          }, -- end of ["tasks"]
                      }, -- end of ["params"]
                  }, -- end of ["task"]
                  ["type"] = "Turning Point",
                  ["ETA"] = 0,
                  ["ETA_locked"] = true,
                  ["y"] = 666285.71428571,
                  ["x"] = -312000,
                  ["formation_template"] = "",
                  ["speed_locked"] = true,
              }, -- end of [1]
          }, -- end of ["points"]
      }, -- end of ["route"]
      ["groupId"] = 1,
      ["hidden"] = false,
      ["units"] = 
      {
          [1] = 
          {
              ["alt"] = 2000,
              ["alt_type"] = "BARO",
              ["livery_id"] = "USAF 364th FS",
              ["skill"] = "High",
              ["speed"] = 125,
              ["type"] = "TF-51D",
              ["unitId"] = 1,
              ["psi"] = 0,
              ["y"] = 666285.71428571,
              ["x"] = -312000,
              ["name"] = "P51-1-1",
              ["payload"] = 
              {
                  ["pylons"] = 
                  {
                  }, -- end of ["pylons"]
                  ["fuel"] = 340.68,
                  ["flare"] = 0,
                  ["chaff"] = 0,
                  ["gun"] = 100,
              }, -- end of ["payload"]
              ["heading"] = 0,
              ["callsign"] = 
              {
                  [1] = 1,
                  [2] = 1,
                  ["name"] = "Enfield11",
                  [3] = 1,
              }, -- end of ["callsign"]
              ["onboard_num"] = "010",
          }, -- end of [1]
      }, -- end of ["units"]
      ["y"] = 666285.71428571,
      ["x"] = -312000,
      ["name"] = "P51",
      ["communication"] = true,
      ["start_time"] = 0,
      ["frequency"] = 124,
  } 


local mustang = SPAWN:NewFromTemplate(ttemp,"P51D")
-- you MUST set the next three:
mustang:InitCountry(country.id.FRANCE)
mustang:InitCategory(Group.Category.AIRPLANE)
mustang:InitCoalition(coalition.side.BLUE)
mustang:OnSpawnGroup(
  function(grp)
    MESSAGE:New("Group Spawned: "..grp:GetName(),15,"SPAWN"):ToAll()
  end
)
mustang:Spawn()

Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.

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 Wrapper.Group#GROUP that was spawned.

   -- Declare SpawnObject and call a function when a new Group is spawned.
   local SpawnObject = SPAWN:New( "SpawnObject" )
                            :InitLimit( 2, 10 )
                            :OnSpawnGroup( function( SpawnGroup )
                                SpawnGroup:E( "I am spawned" )
                                end
                              )
                            :SpawnScheduled( 300, 0.3 )

Will park a group at an Wrapper.Airbase.

Will park a group at an Wrapper.Airbase.

This method is mostly advisable to be used if you want to simulate parking units at an airbase and be visible. Note that each point in the route assigned to the spawning group is reset to the point of the spawn.

All groups that are in the spawn collection and that are alive, and not in the air, are parked.

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:

• 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 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 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!

  Spawn_Plane = SPAWN:New( "Plane" )
  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ) )

  Spawn_Heli = SPAWN:New( "Heli")

  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "FARP Cold" ) )

  Spawn_Heli:ParkAtAirbase( AIRBASE:FindByName( "Carrier" ) )

  Spawn_Plane:ParkAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), AIRBASE.TerminalType.OpenBig )

Will re-spawn a group based on a given index.

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

Set the spawn index to a specified index number.

This method can be used to "reset" the spawn counter to a specific index number. This will actually enable a respawn of groups from the specific index.

Will spawn a group based on the internal index.

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

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 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:

• 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 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 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!

  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 )

  Spawn_Plane:SpawnAtAirbase( AIRBASE:FindByName( AIRBASE.Caucasus.Krymsk ), SPAWN.Takeoff.Cold, nil, AIRBASE.TerminalType.OpenBig )

Spawn a group on an Wrapper.Airbase at a specific parking spot.

Will spawn a group from a Coordinate in 3D space.

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. 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.

Will spawn a group from a POINT_VEC2 in 3D space.

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. 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.

  local SpawnPointVec2 = ZONE:New( ZoneName ):GetPointVec2() 

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2 )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromPointVec2( SpawnPointVec2, 2000, 4000 )

Will spawn a group from a PointVec3 in 3D space.

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. 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.

  local SpawnPointVec3 = ZONE:New( ZoneName ):GetPointVec3( 2000 ) -- Get the center of the ZONE object at 2000 meters from the ground.

  -- Spawn at the zone center position at 2000 meters from the ground!
  SpawnAirplanes:SpawnFromPointVec3( SpawnPointVec3 )

Will spawn a group from a hosting static.

This method is mostly advisable to be used if you want to simulate spawning from buldings and structures (static buildings). You can use the returned group to further define the route to be followed.

  local SpawnStatic = STATIC:FindByName( StaticName )

  -- Spawn from the static position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromStatic( SpawnStatic )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromStatic( SpawnStatic, 2000, 4000 )

Will spawn a group from a hosting unit.

This method is mostly advisable to be used if you want to simulate spawning from air units, like helicopters, which are dropping infantry into a defined Landing Zone. 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.

  local SpawnStatic = STATIC:FindByName( StaticName )

  -- Spawn from the static position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromUnit( SpawnStatic )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromUnit( SpawnStatic, 2000, 4000 )

Will spawn a group from a Vec2 in 3D space.

This method is mostly advisable to be used if you want to simulate spawning groups on the ground from air units, like vehicles. 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.

  local SpawnVec2 = ZONE:New( ZoneName ):GetVec2()

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnFromVec2( SpawnVec2 )

  -- Spawn from the static position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnFromVec2( SpawnVec2, 2000, 4000 )

Will spawn a group from a Vec3 in 3D space.

This method is mostly advisable to be used if you want to simulate spawning units in the air, like helicopters or airplanes. 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.

Will return the SpawnGroupName either with with a specific count number or without any count.

Will spawn a Group within a given Core.Zone.

The Core.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.

  local SpawnZone = ZONE:New( ZoneName )

  -- Spawn at the zone center position at the height specified in the ME of the group template!
  SpawnAirplanes:SpawnInZone( SpawnZone )

  -- Spawn in the zone at a random position at the height specified in the Me of the group template.
  SpawnAirplanes:SpawnInZone( SpawnZone, true )

  -- Spawn in the zone at a random position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, true, 2000, 4000 )

  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, false, 2000, 4000 )

  -- Spawn at the zone center position at the height randomized between 2000 and 4000 meters.
  SpawnAirplanes:SpawnInZone( SpawnZone, nil, 2000, 4000 )

Will re-start the spawning scheduler.

Note: This method is only required to be called when the schedule was stopped.

Will stop the scheduled spawning scheduler.

Spawns new groups at varying time intervals.

This is useful if you want to have continuity within your missions of certain (AI) groups to be present (alive) within your missions. WARNING - Setting a very low SpawnTime heavily impacts your mission performance and CPU time, it is NOT useful to check the alive state of an object every split second! Be reasonable and stay at 15 seconds and above!

-- NATO helicopters engaging in the battle field.
-- The time interval is set to SPAWN new helicopters between each 600 seconds, with a time variation of 50%.
-- The time variation in this case will be between 450 seconds and 750 seconds.
-- This is calculated as follows:
--      Low limit:   600 * ( 1 - 0.5 / 2 ) = 450
--      High limit:  600 * ( 1 + 0.5 / 2 ) = 750
-- Between these two values, a random amount of seconds will be chosen for each new spawn of the helicopters.
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):SpawnScheduled( 600, 0.5 )

Will spawn a group with a specified index number.

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

Stop the SPAWN InitRepeat function (EVENT handler for takeoff, land and engine shutdown)

         local spawn = SPAWN:New("Template Group")
           :InitRepeatOnEngineShutDown()
         local plane = spawn:Spawn() -- it is important that we keep the SPAWN object and do not overwrite it with the resulting GROUP object by just calling :Spawn()
         
         -- later on
         spawn:StopRepeat()

Gets the CategoryID of the Group with the given SpawnPrefix

Gets the CoalitionID of the Group with the given SpawnPrefix

Gets the CountryID of the Group with the given SpawnPrefix

Return the last maximum index that can be used.

Return the prefix of a SpawnUnit.

The method will search for a #-mark, and will return the text before the #-mark. It will return nil of no prefix was found.

Return the prefix of a spawned group.

The method will search for a #-mark, and will return the text before the #-mark. It will return nil of no prefix was found.

Get the next index of the groups to be spawned.

This method is complicated, as it is used at several spaces.

Gets the Group Template from the ME environment definition.

Note: This method uses the global _DATABASE object (an instance of Core.Database#DATABASE), which contains ALL initial and new spawned objects in MOOSE.

Initalize the SpawnGroups collection.

@param #SPAWN self @param Core.Event#EVENTDATA EventData

Will detect AIR Units shutting down their engines ...

When the event takes place, and the method #InitRepeatOnEngineShutDown was called, the spawned Group will Re-SPAWN. But only when the Unit was registered to have landed.

Will detect AIR Units landing...

When the event takes place, the spawned Group is registered as landed. This is needed to ensure that Re-SPAWNing is only done for landed AIR Groups.

Will detect AIR Units taking off...

When the event takes place, the spawned Group is registered as airborne... This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Prepares the new Group Template.

Private method randomizing the routes.

Private method that randomizes the template of the group.

Private method that randomizes the Core.Zones where the Group will be spawned.

This function is called automatically by the Spawning scheduler.

It is the internal worker method SPAWNing new Groups on the defined time intervals.

Private method that sets the DCS#Vec2 where the Group will be spawned.

Schedules the CleanUp of Groups

Clear the state of an object.

Creation of a Birth Event.

Creation of a Crash Event.

Creation of a Dead Event.

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

Creation of a Remove Unit Event.

Creation of a Takeoff Event.

Creation of a Crash Event.

Log an exception which will be traced always.

Can be anywhere within the function logic.

Returns the event dispatcher

Remove all subscribed events

Trace a function call.

Must be at the beginning of the function logic.

Trace a function call level 2.

Must be at the beginning of the function logic.

Trace a function call level 3.

Must be at the beginning of the function logic.

Get the ClassID of the class instance.

Get the ClassName of the class instance.

Get the ClassName + ClassID of the class instance.

The ClassName + ClassID is formatted as '%s#%09d'.

Get the Class Core.Event processing Priority.

The Event processing Priority is a number from 1 to 10, reflecting the order of the classes subscribed to the Event to be processed.

This is the worker method to retrieve the Parent class.

Note that the Parent class must be passed to call the parent class method.

self:GetParent(self):ParentMethod()

Get a Value given a Key from the Object.

Note that if the Object is destroyed, set to nil, or garbage collected, then the Values and Keys will also be gone.

Subscribe to a DCS Event.

Log an information which will be traced always.

Can be anywhere within the function logic.

This is the worker method to inherit from a parent class.

This is the worker method to check if an object is an (sub)instance of a class.

Examples:

• ZONE:New( 'some zone' ):IsInstanceOf( ZONE ) will return true

• ZONE:New( 'some zone' ):IsInstanceOf( 'ZONE' ) will return true

• ZONE:New( 'some zone' ):IsInstanceOf( 'zone' ) will return true

• ZONE:New( 'some zone' ):IsInstanceOf( 'BASE' ) will return true

• ZONE:New( 'some zone' ):IsInstanceOf( 'GROUP' ) will return false

Enquires if tracing is on (for the class).

BASE constructor.

This is an example how to use the BASE:New() constructor in a new class definition when inheriting from BASE.

function EVENT:New()
  local self = BASE:Inherit( self, BASE:New() ) -- #EVENT
  return self
end

Occurs when an Event for an object is triggered.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that triggered the event.

BDA.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when a ground unit captures either an airbase or a farp.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that captured the base place: The airbase that was captured, can be a FARP or Airbase. When calling place:getCoalition() the faction will already be the new owning faction.

Occurs when any object is spawned into the mission.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was spawned

Occurs when any aircraft crashes into the ground and is completely destroyed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that has crashed

Occurs when an object is dead.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is dead.

Unknown precisely what creates this event, likely tied into newer damage model.

Will update this page when new information become available.

• initiator: The unit that had the failure.

Discard chair after ejection.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when a player loads a dynamic cargo object with the F8 ground crew menu into a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Occurs when a dynamic cargo crate is removed.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Occurs when a player unloads a dynamic cargo object with the F8 ground crew menu from a helo.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Occurs when a pilot ejects from an aircraft Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has ejected

Occurs when any aircraft shuts down its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is stopping its engines.

Occurs when any aircraft starts its engines.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is starting its engines.

Occurs whenever an object is hit by a weapon.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit object the fired the weapon weapon: Weapon object that hit the target target: The Object that was hit.

Occurs when any system fails on a human controlled aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that had the failure

Occurs on the death of a unit.

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. Have a look at the class Core.Event#EVENT as these are just the prototypes.

• initiator: The unit that killed the target
• target: Target Object
• weapon: Weapon Object

Occurs when an aircraft lands at an airbase, farp or ship Have a look at the class Core.Event#EVENT as these are just the prototypes.

initiator : The unit that has landed place: Object that the unit landed on. Can be an Airbase Object, FARP, or Ships

Occurs shortly after the landing animation of an ejected pilot touching the ground and standing up.

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. Have a look at the class Core.Event#EVENT as these are just the prototypes.

• initiator: Static object representing the ejected pilot. Place : Aircraft that the pilot ejected from.
• place: may not return as a valid object if the aircraft has crashed into the ground and no longer exists.
• subplace: is always 0 for unknown reasons.

Landing quality mark.

Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when a new mark was added.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Occurs when a mark text was changed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Occurs when a mark was removed.

Have a look at the class Core.Event#EVENT as these are just the prototypes. MarkID: ID of the mark.

Occurs when a mission ends Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when a mission starts Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when a player creates a dynamic cargo object from the F8 ground crew menu.

* NOTE * this is a workarounf for DCS not creating these events as of Aug 2024.

Weapon add.

Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when the pilot of an aircraft is killed.

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the pilot has died in.

Occurs when a player enters a slot and takes control of an aircraft.

Have a look at the class Core.Event#EVENT as these are just the prototypes. NOTE: This is a workaround of a long standing DCS bug with the PLAYER_ENTER_UNIT event. initiator : The unit that is being taken control of.

Occurs when any player assumes direct control of a unit.

Note - not Mulitplayer safe. Use PlayerEnterAircraft. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is being taken control of.

Occurs when any player relieves control of a unit to the AI.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that the player left.

Occurs when an aircraft connects with a tanker and begins taking on fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is receiving fuel.

Occurs when an aircraft is finished taking fuel.

Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was receiving fuel.

Occurs when any modification to the "Score" as seen on the debrief menu would occur.

There is no information on what values the score was changed to. Event is likely similar to player_comment in this regard. Have a look at the class Core.Event#EVENT as these are just the prototypes.

Occurs when any unit stops firing its weapon.

Event will always correspond with a shooting start event. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that was doing the shooting.

Occurs when any unit begins firing a weapon that has a high rate of fire.

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. Have a look at the class Core.Event#EVENT as these are just the prototypes. initiator : The unit that is doing the shooting. target: The unit that is being targeted.

Occurs whenever any unit in a mission fires a weapon.

But not any machine gun or autocannon based weapon, those are handled by EVENT.ShootingStart. Have a look at the class Core.Event#EVENT as these are just the prototypes.