Module `Spawn`

This module contains the SPAWN class.

1) Functional.Spawn#SPAWN class, extends Core.Base#BASE

The #SPAWN class allows to spawn dynamically new groups, based on pre-defined initialization settings, modifying the behaviour when groups are spawned. For each group to be spawned, within the mission editor, a group has to be created with the "late activation flag" set. We call this group the "Spawn Template" of the SPAWN object. A reference to this Spawn Template needs to be provided when constructing the SPAWN object, by indicating the name of the group within the mission editor in the constructor methods.

Within the SPAWN object, there is an internal index that keeps track of which group from the internal group list was spawned. When new groups get spawned by using the SPAWN methods (see below), it will be validated whether the Limits (SPAWN.Limit) of the SPAWN object are not reached. When all is valid, a new group will be created by the spawning methods, and the internal index will be increased with 1.

Regarding the name of new spawned groups, a SpawnPrefix will be assigned for each new group created. If you want to have the Spawn Template name to be used as the SpawnPrefix name, use the SPAWN.New constructor. However, when the SPAWN.NewWithAlias constructor was used, the Alias name will define the SpawnPrefix name. Groups will follow the following naming structure when spawned at run-time:

Spawned groups will have the name SpawnPrefix#ggg, where ggg is a counter from 0 to 999.
Spawned units will have the name SpawnPrefix#ggg-uu, where uu is a counter from 0 to 99 for each new spawned unit belonging to the group.

Some additional notes that need to be remembered:

Templates are actually groups defined within the mission editor, with the flag "Late Activation" set. As such, these groups are never used within the mission, but are used by the #SPAWN module.
It is important to defined BEFORE you spawn new groups, a proper initialization of the SPAWN instance is done with the options you want to use.
When designing a mission, NEVER name groups using a "#" within the name of the group Spawn Template(s), or the SPAWN module logic won't work anymore.

1.1) SPAWN construction methods

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.

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. So in principle, the group list will contain all parameters and configurations after initialization, and when groups get actually spawned, this spawning can be done quickly and efficient.

1.2) SPAWN initialization methods

A spawn object will behave differently based on the usage of initialization methods, which all start with the Init prefix:

SPAWN.InitLimit(): Limits the amount of groups that can be alive at the same time and that can be dynamically spawned.
SPAWN.InitRandomizeRoute(): Randomize the routes of spawned groups, and for air groups also optionally the height.
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.
SPAWN.InitUncontrolled(): Spawn plane groups uncontrolled.
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.
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.

1.3) SPAWN spawning methods

Groups can be spawned at different times and 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.
SPAWN.SpawnFromUnit(): Spawn a new group taking the position of a Unit.
SPAWN.SpawnInZone(): Spawn a new group in a Zone.

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.

1.4) Retrieve alive GROUPs spawned by the SPAWN object

The SPAWN class administers which GROUPS it has reserved (in stock) or has created during mission execution. Every time a SPAWN object spawns a new GROUP object, a reference to the GROUP object is added to an internal table of GROUPS. SPAWN provides methods to iterate through that internal GROUP object reference table:

SPAWN.GetFirstAliveGroup(): 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.
SPAWN.GetNextAliveGroup(): 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.
SPAWN.GetLastAliveGroup(): 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.

You can use the methods SPAWN.GetFirstAliveGroup() and sequently SPAWN.GetNextAliveGroup() to iterate through the alive GROUPS within the SPAWN object, and to actions... See the respective methods for an example. The method SPAWN.GetGroupFromIndex() will return the GROUP object reference from the given Index, dead or alive...

1.5) SPAWN object cleaning

Sometimes, it will occur during a mission run-time, that ground or especially air objects get damaged, and will while being damged stop their activities, while remaining alive. In such cases, the SPAWN object will just sit there and wait until that group gets destroyed, but most of the time it won't, and it may occur that no new groups are or can be spawned as limits are reached. To prevent this, a SPAWN.InitCleanUp() initialization method has been defined that will silently monitor the status of each spawned group. Once a group has a velocity = 0, and has been waiting for a defined interval, that group will be cleaned or removed from run-time. There is a catch however :-) If a damaged group has returned to an airbase within the coalition, that group will not be considered as "lost"... In such a case, when the inactive group is cleaned, a new group will Re-spawned automatically. This models AI that has succesfully returned to their airbase, to restart their combat activities. Check the SPAWN.InitCleanUp() for further info.

1.6) Catch the Group spawn event in a callback function!

When using the SpawnScheduled method, new Groups are created following the schedule timing parameters. When a new Group is spawned, you maybe want to execute actions with that group spawned at the spawn event. To SPAWN class supports this functionality through the SPAWN.OnSpawnGroup( *function( SpawnedGroup ) end * ) method, 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. A coding example is provided at the description of the SPAWN.OnSpawnGroup( *function( SpawnedGroup ) end * ) method.

API CHANGE HISTORY

The underlying change log documents the API changes. Please read this carefully. The following notation is used:

Added parts are expressed in bold type face.
Removed parts are expressed in italic type face.

Hereby the change log:

2016-08-15: SPAWN:InitCleanUp( SpawnCleanUpInterval ) replaces SPAWN:CleanUp( SpawnCleanUpInterval )

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

2016-08-15: SPAWN:InitRandomizeZones( SpawnZones ) added.

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

2016-08-14: SPAWN:OnSpawnGroup( SpawnCallBackFunction, ... ) replaces SPAWN:SpawnFunction( SpawnCallBackFunction, ... ).

2016-08-14: SPAWN.SpawnInZone( Zone, RandomizeGroup, SpawnIndex ) replaces SpawnInZone( Zone, RandomizeUnits, OuterRadius, InnerRadius, SpawnIndex ).

The RandomizeUnits, OuterRadius and InnerRadius have been replaced with a new method SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ).
A new parameter RandomizeGroup to reflect the randomization of the starting position of the Spawned Group.

2016-08-14: SPAWN.SpawnFromVec3( Vec3, SpawnIndex ) replaces SpawnFromVec3( Vec3, RandomizeUnits, OuterRadius, InnerRadius, SpawnIndex ):

The RandomizeUnits, OuterRadius and InnerRadius have been replaced with a new method SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ).
A new parameter RandomizeGroup to reflect the randomization of the starting position of the Spawned Group.

2016-08-14: SPAWN.SpawnFromVec2( Vec2, SpawnIndex ) replaces SpawnFromVec2( Vec2, RandomizeUnits, OuterRadius, InnerRadius, SpawnIndex ):

The RandomizeUnits, OuterRadius and InnerRadius have been replaced with a new method SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ).
A new parameter RandomizeGroup to reflect the randomization of the starting position of the Spawned Group.

2016-08-14: SPAWN.SpawnFromUnit( SpawnUnit, SpawnIndex ) replaces SpawnFromUnit( SpawnUnit, RandomizeUnits, OuterRadius, InnerRadius, SpawnIndex ):

The RandomizeUnits, OuterRadius and InnerRadius have been replaced with a new method SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ).
A new parameter RandomizeGroup to reflect the randomization of the starting position of the Spawned Group.

2016-08-14: SPAWN.SpawnFromUnit( SpawnUnit, SpawnIndex ) replaces SpawnFromStatic( SpawnStatic, RandomizeUnits, OuterRadius, InnerRadius, SpawnIndex ):

The RandomizeUnits, OuterRadius and InnerRadius have been replaced with a new method SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ).
A new parameter RandomizeGroup to reflect the randomization of the starting position of the Spawned Group.

2016-08-14: SPAWN.InitRandomizeUnits( RandomizeUnits, OuterRadius, InnerRadius ) added:

This method enables the randomization of units at the first route point in a radius band at a spawn event.

2016-08-14: SPAWN.InitLimit( SpawnMaxUnitsAlive, SpawnMaxGroups ) replaces SPAWN.Limit( SpawnMaxUnitsAlive, SpawnMaxGroups ):

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

2016-08-14: SPAWN.InitArray( SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY ) replaces SPAWN.Array( SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY ).

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

2016-08-14: SPAWN.InitRandomizeRoute( SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight ) replaces SPAWN.RandomizeRoute( SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight ).

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

2016-08-14: SPAWN.InitRandomizeTemplate( SpawnTemplatePrefixTable ) replaces SPAWN.RandomizeTemplate( SpawnTemplatePrefixTable ).

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

2016-08-14: SPAWN.InitUnControlled() replaces SPAWN.UnControlled().

Want to ensure that the methods starting with Init are the first called methods before any Spawn method is called!
This notation makes it now more clear which methods are initialization methods and which methods are Spawn enablement methods.

AUTHORS and CONTRIBUTIONS

Contributions:

Aaron: Posed the idea for Group position randomization at SpawnInZone and make the Unit randomization separate from the Group randomization.

Authors:

FlightControl: Design & Programming

Global(s)

SPAWN

Type `SPAWN`

SPAWN.AliveUnits
SPAWN.ClassName
SPAWN.CleanUpScheduler
SPAWN:GetFirstAliveGroup()	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.
SPAWN:GetGroupFromIndex(SpawnIndex)	Get the group from an index.
SPAWN:GetLastAliveGroup()	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.
SPAWN:GetNextAliveGroup(SpawnIndexStart)	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.
SPAWN:GetSpawnIndexFromGroup(SpawnGroup)	Get the index from a given group.
SPAWN:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)	Makes the groups visible before start (like a batallion).
SPAWN:InitCleanUp(SpawnCleanUpInterval)	CleanUp groups when they are still alive, but inactive.
SPAWN:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)	Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.
SPAWN:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)	Randomizes the defined route of the SpawnTemplatePrefix group in the ME.
SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)	This method is rather complicated to understand.
SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)	Randomizes the UNITs that are spawned within a radius band given an Outer and Inner radius.
SPAWN:InitRandomizeZones(SpawnZoneTable)
SPAWN:InitRepeat()	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.
SPAWN:InitRepeatOnEngineShutDown()	Respawn after landing when its engines have shut down.
SPAWN:InitRepeatOnLanding()	Respawn group after landing.
SPAWN:InitUnControlled()	(AIR) Will spawn a plane group in uncontrolled mode...
SPAWN.MaxAliveGroups
SPAWN.MaxAliveUnits
SPAWN:New(SpawnTemplatePrefix)	Creates the main object to spawn a Group defined in the DCS ME.
SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)	Creates a new SPAWN instance to create new groups based on the defined template and using a new alias for each new group.
SPAWN:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)	Allows to place a CallFunction hook when a new group spawns.
SPAWN:ReSpawn(SpawnIndex)	Will re-spawn a group based on a given index.
SPAWN.Repeat
SPAWN.RepeatOnEngineShutDown
SPAWN.RepeatOnLanding
SPAWN:Spawn()	Will spawn a group based on the internal index.
SPAWN.SpawnAliasPrefix
SPAWN.SpawnCleanUpInterval
SPAWN.SpawnCleanUpTimeStamps
SPAWN.SpawnCount
SPAWN:SpawnFromStatic(HostStatic, SpawnIndex)	Will spawn a group from a hosting static.
SPAWN:SpawnFromUnit(HostUnit, SpawnIndex)	Will spawn a group from a hosting unit.
SPAWN:SpawnFromVec2(Vec2, SpawnIndex)	Will spawn a group from a Vec2 in 3D space.
SPAWN:SpawnFromVec3(Vec3, SpawnIndex)	Will spawn a group from a Vec3 in 3D space.
SPAWN.SpawnFunctionArguments
SPAWN.SpawnFunctionHook
SPAWN:SpawnGroupName(SpawnIndex)	Will return the SpawnGroupName either with with a specific count number or without any count.
SPAWN.SpawnGroups
SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex)	Will spawn a Group within a given Zone.
SPAWN.SpawnIndex
SPAWN.SpawnInnerRadius
SPAWN.SpawnIsScheduled
SPAWN.SpawnMaxGroups
SPAWN.SpawnMaxUnitsAlive
SPAWN.SpawnOuterRadius
SPAWN.SpawnRandomize
SPAWN.SpawnRandomizeRoute
SPAWN.SpawnRandomizeRouteEndPoint
SPAWN.SpawnRandomizeRouteHeight
SPAWN.SpawnRandomizeRouteRadius
SPAWN.SpawnRandomizeRouteStartPoint
SPAWN.SpawnRandomizeTemplate
SPAWN.SpawnRandomizeUnits
SPAWN:SpawnScheduleStart()	Will re-start the spawning scheduler.
SPAWN:SpawnScheduleStop()	Will stop the scheduled spawning scheduler.
SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation)	Spawns new groups at varying time intervals.
SPAWN.SpawnScheduler
SPAWN.SpawnTemplate
SPAWN.SpawnTemplatePrefix
SPAWN.SpawnTemplatePrefixTable
SPAWN.SpawnUnControlled
SPAWN.SpawnVisible
SPAWN:SpawnWithIndex(SpawnIndex)	Will spawn a group with a specified index number.
SPAWN.SpawnZoneTable
SPAWN.UnControlled
SPAWN:_GetGroupCategoryID(SpawnPrefix)	Gets the CategoryID of the Group with the given SpawnPrefix
SPAWN:_GetGroupCoalitionID(SpawnPrefix)	Gets the CoalitionID of the Group with the given SpawnPrefix
SPAWN:_GetGroupCountryID(SpawnPrefix)	Gets the CountryID of the Group with the given SpawnPrefix
SPAWN:_GetGroupFromDCSUnit(DCSUnit)	Return the group within the SpawnGroups collection with input a DCSUnit.
SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit)	Get the group index from a DCSUnit.
SPAWN:_GetLastIndex()	Return the last maximum index that can be used.
SPAWN:_GetPrefixFromDCSUnit(DCSUnit)	Return the prefix of a SpawnUnit.
SPAWN:_GetSpawnIndex(SpawnIndex)	Get the next index of the groups to be spawned.
SPAWN:_GetTemplate(SpawnTemplatePrefix)	Gets the Group Template from the ME environment definition.
SPAWN:_InitializeSpawnGroups(SpawnIndex)	Initalize the SpawnGroups collection.
SPAWN:_OnBirth(Event)
SPAWN:_OnDeadOrCrash(Event)
SPAWN:_OnEngineShutDown(event)	Will detect AIR Units shutting down their engines ...
SPAWN:_OnLand(event)	Will detect AIR Units landing...
SPAWN:_OnTakeOff(event)	Will detect AIR Units taking off...
SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex)	Prepares the new Group Template.
SPAWN:_RandomizeRoute(SpawnIndex)	Private method randomizing the routes.
SPAWN:_RandomizeTemplate(SpawnIndex)	Private method that randomizes the template of the group.
SPAWN:_RandomizeZones(SpawnIndex)	Private method that randomizes the Zones where the Group will be spawned.
SPAWN:_Scheduler()	This function is called automatically by the Spawning scheduler.
SPAWN:_SpawnCleanUpScheduler()	Schedules the CleanUp of Groups
SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

Global(s)

#SPAWN SPAWN

Type `Spawn`

Type `SPAWN`

SPAWN Class

Field(s)

#number SPAWN.AliveUnits

SPAWN.ClassName

SPAWN.CleanUpScheduler: self.CleanUpFunction = routines.scheduleFunction( self._SpawnCleanUpScheduler, { self }, timer.getTime() + 1, SpawnCleanUpInterval )

SPAWN:GetFirstAliveGroup()

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.

Return values

Wrapper.Group#GROUP, #number: The Group object found, the new Index where the group was found.
#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.
local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
while GroupPlane ~= nil do
  -- Do actions with the GroupPlane object.
  GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
end

SPAWN:GetGroupFromIndex(SpawnIndex)

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.

Parameter

#number SpawnIndex : The index of the group to return.

Return value

Wrapper.Group#GROUP: self

SPAWN:GetLastAliveGroup()

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.

Return values

Wrapper.Group#GROUP, #number: The last alive Group object found, the last Index where the last alive Group object was found.
#nil, #nil: When no alive 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.
local GroupPlane, Index = SpawnPlanes:GetLastAliveGroup()
if GroupPlane then -- GroupPlane can be nil!!!
  -- Do actions with the GroupPlane object.
end

SPAWN:GetNextAliveGroup(SpawnIndexStart)

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.

Parameter

#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 values

Wrapper.Group#GROUP, #number: The next alive Group object found, the next Index where the next alive Group object was found.
#nil, #nil: When no alive 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.
local GroupPlane, Index = SpawnPlanes:GetFirstAliveGroup()
while GroupPlane ~= nil do
  -- Do actions with the GroupPlane object.
  GroupPlane, Index = SpawnPlanes:GetNextAliveGroup( Index )
end

SPAWN:GetSpawnIndexFromGroup(SpawnGroup)

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.

Parameter

SpawnGroup :

SPAWN:InitArray(SpawnAngle, SpawnWidth, SpawnDeltaX, SpawnDeltaY)

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

The method will take the position of the group as the first position in the array.

Parameters

#number SpawnAngle :

    The angle in degrees how the groups and each unit of the group will be positioned.

#number SpawnWidth :

     The amount of Groups that will be positioned on the X axis.

#number SpawnDeltaX :

   The space between each Group on the X-axis.

#number SpawnDeltaY :

     The space between each Group on the Y-axis.

Return value

#SPAWN: self

Usage:

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

SPAWN:InitCleanUp(SpawnCleanUpInterval)

CleanUp groups when they are still alive, but inactive.

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.

Parameter

#string SpawnCleanUpInterval : The interval to check for inactive groups within seconds.

Return value

#SPAWN: self

Usage:

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

SPAWN:InitLimit(SpawnMaxUnitsAlive, SpawnMaxGroups)

Limits the Maximum amount of Units that can be alive at the same time, and the maximum amount of groups that can be spawned.

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.

Parameters

#number SpawnMaxUnitsAlive : The maximum amount of units that can be alive at runtime.
#number SpawnMaxGroups : The maximum amount of groups that can be spawned. When the limit is reached, then no more actual spawns will happen of the group. This parameter is useful to define a maximum amount of airplanes, ground troops, helicopters, ships etc within a supply area. This parameter accepts the value 0, which defines that there are no maximum group limits, but there are limits on the maximum of units that can be alive at the same time.

Return value

#SPAWN: self

Usage:

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

SPAWN:InitRandomizeRoute(SpawnStartPoint, SpawnEndPoint, SpawnRadius, SpawnHeight)

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

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

Parameters

#number SpawnStartPoint : is the waypoint where the randomization begins. Note that the StartPoint = 0 equaling the point where the group is spawned.
#number SpawnEndPoint : is the waypoint where the randomization ends counting backwards. This parameter is useful to avoid randomization to end at a waypoint earlier than the last waypoint on the route.
#number SpawnRadius : is the radius in meters in which the randomization of the new waypoints, with the original waypoint of the original template located in the middle ...
#number SpawnHeight : (optional) Specifies the additional height in meters that can be added to the base height specified at each waypoint in the ME.

Return value

#SPAWN:

Usage:

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

SPAWN:InitRandomizeTemplate(SpawnTemplatePrefixTable)

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.

Parameter

#string SpawnTemplatePrefixTable : A table with the names of the groups defined within the mission editor, from which one will be choosen when a new group will be spawned.

Return value

#SPAWN:

Usage:

-- 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 simulteneously  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 ):Schedule( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
Spawn_US_Platoon_Middle = SPAWN:New( 'US Tank Platoon Middle' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )
Spawn_US_Platoon_Right = SPAWN:New( 'US Tank Platoon Right' ):InitLimit( 12, 150 ):Schedule( 200, 0.4 ):InitRandomizeTemplate( Spawn_US_Platoon ):InitRandomizeRoute( 3, 3, 2000 )

SPAWN:InitRandomizeUnits(RandomizeUnits, OuterRadius, InnerRadius)

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

Parameters

#boolean RandomizeUnits : If true, SPAWN will perform the randomization of the UNITs position within the group between a given outer and inner radius.
Dcs.DCSTypes#Distance OuterRadius : (optional) The outer radius in meters where the new group will be spawned.
Dcs.DCSTypes#Distance InnerRadius : (optional) The inner radius in meters where the new group will NOT be spawned.

Return value

#SPAWN:

Usage:

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

SPAWN:InitRandomizeZones(SpawnZoneTable)

TODO: Add example. - This method provides the functionality to randomize the spawning of the Groups at a given list of zones of different types. @param #SPAWN self @param #table SpawnZoneTable A table with Zone objects. If this table is given, then each spawn will be executed within the given list of Zones objects. @return #SPAWN @usage -- NATO Tank Platoons invading Gori. -- Choose between 3 different zones for each new SPAWN the Group to be executed, regardless of the zone type.

Parameter

SpawnZoneTable :

SPAWN:InitRepeat()

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

Return value

#SPAWN: self

Usage:

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

SPAWN:InitRepeatOnEngineShutDown()

Respawn after landing when its engines have shut down.

Return value

#SPAWN: self

SPAWN:InitRepeatOnLanding()

Respawn group after landing.

Return value

#SPAWN: self

SPAWN:InitUnControlled()

(AIR) Will spawn a plane group in uncontrolled mode...

This will be similar to the uncontrolled flag setting in the ME.

Return value

#SPAWN: self

#number SPAWN.MaxAliveGroups

#number SPAWN.MaxAliveUnits

SPAWN:New(SpawnTemplatePrefix)

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

Parameter

#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 value

#SPAWN:

Usages:

-- NATO helicopters engaging in the battle field.
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' )

local Plane = SPAWN:New( "Plane" ) -- Creates a new local variable that can initiate new planes with the name "Plane#ddd" using the template "Plane" as defined within the ME.

SPAWN:NewWithAlias(SpawnTemplatePrefix, SpawnAliasPrefix)

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

Parameters

#string SpawnTemplatePrefix : is the name of the Group in the ME that defines the Template.
#string SpawnAliasPrefix : is the name that will be given to the Group at runtime.

Return value

#SPAWN:

Usages:

-- NATO helicopters engaging in the battle field.
Spawn_BE_KA50 = SPAWN:NewWithAlias( 'BE KA-50@RAMP-Ground Defense', 'Helicopter Attacking a City' )

local PlaneWithAlias = SPAWN:NewWithAlias( "Plane", "Bomber" ) -- Creates a new local variable that can instantiate new planes with the name "Bomber#ddd" using the template "Plane" as defined within the ME.

SPAWN:OnSpawnGroup(SpawnCallBackFunction, SpawnFunctionArguments, ...)

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.

Parameters

#function SpawnCallBackFunction : The function to be called when a group spawns.
SpawnFunctionArguments : A random amount of arguments to be provided to the function when the group spawns.
... :

Return value

#SPAWN:

Usage:

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

SPAWN:ReSpawn(SpawnIndex)

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

Note: Uses DATABASE module defined in MOOSE.

Parameter

#string SpawnIndex : The index of the group to be spawned.

Return value

Wrapper.Group#GROUP: The group that was spawned. You can use this group for further actions.

#boolean SPAWN.Repeat

#boolean SPAWN.RepeatOnEngineShutDown

#boolean SPAWN.RepeatOnLanding

SPAWN:Spawn()

Will spawn a group based on the internal index.

Note: Uses DATABASE module defined in MOOSE.

Return value

Wrapper.Group#GROUP: The group that was spawned. You can use this group for further actions.

#string SPAWN.SpawnAliasPrefix

SPAWN.SpawnCleanUpInterval

SPAWN.SpawnCleanUpTimeStamps

#number SPAWN.SpawnCount: The internal counter of the amount of spawning the has happened since SpawnStart.

SPAWN:SpawnFromStatic(HostStatic, SpawnIndex)

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.

Parameters

Wrapper.Static#STATIC HostStatic : The static dropping or unloading the group.
#number SpawnIndex : (optional) The index which group to spawn within the given zone.

Return values

Wrapper.Group#GROUP: that was spawned.
#nil: Nothing was spawned.

SPAWN:SpawnFromUnit(HostUnit, SpawnIndex)

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.

Parameters

Wrapper.Unit#UNIT HostUnit : The air or ground unit dropping or unloading the group.
#number SpawnIndex : (optional) The index which group to spawn within the given zone.

Return values

Wrapper.Group#GROUP: that was spawned.
#nil: Nothing was spawned.

SPAWN:SpawnFromVec2(Vec2, SpawnIndex)

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.

Parameters

Dcs.DCSTypes#Vec2 Vec2 : The Vec2 coordinates where to spawn the group.
#number SpawnIndex : (optional) The index which group to spawn within the given zone.

Return values

Wrapper.Group#GROUP: that was spawned.
#nil: Nothing was spawned.

SPAWN:SpawnFromVec3(Vec3, SpawnIndex)

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.

Parameters

Dcs.DCSTypes#Vec3 Vec3 : The Vec3 coordinates where to spawn the group.
#number SpawnIndex : (optional) The index which group to spawn within the given zone.

Return values

Wrapper.Group#GROUP: that was spawned.
#nil: Nothing was spawned.

SPAWN.SpawnFunctionArguments

SPAWN.SpawnFunctionHook

SPAWN:SpawnGroupName(SpawnIndex)

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

Parameter

#number SpawnIndex : Is the number of the Group that is to be spawned.

Return value

#string: SpawnGroupName

SPAWN.SpawnGroups: Array containing the descriptions of each Group to be Spawned.

SPAWN:SpawnInZone(Zone, RandomizeGroup, SpawnIndex)

Will spawn a Group within a given Zone.

The Zone can be of any type derived from Core.Zone#ZONE_BASE. Once the Group is spawned within the zone, the Group will continue on its route. The first waypoint (where the group is spawned) is replaced with the zone location coordinates.

Parameters

Core.Zone#ZONE Zone : The zone where the group is to be spawned.
#boolean RandomizeGroup : (optional) Randomization of the Group position in the zone.
#number SpawnIndex : (optional) The index which group to spawn within the given zone.

Return values

Wrapper.Group#GROUP: that was spawned.
#nil: when nothing was spawned.

#number SPAWN.SpawnIndex

SPAWN.SpawnInnerRadius

#boolean SPAWN.SpawnIsScheduled: Reflects if the spawning for this SpawnTemplatePrefix is going to be scheduled or not.

SPAWN.SpawnMaxGroups: The maximum amount of groups that can be spawned.

SPAWN.SpawnMaxUnitsAlive: The maximum amount of groups that can be alive of SpawnTemplatePrefix at the same time.

SPAWN.SpawnOuterRadius

#boolean SPAWN.SpawnRandomize: Sets the randomization flag of new Spawned units to false.

#boolean SPAWN.SpawnRandomizeRoute

SPAWN.SpawnRandomizeRouteEndPoint

SPAWN.SpawnRandomizeRouteHeight

SPAWN.SpawnRandomizeRouteRadius

SPAWN.SpawnRandomizeRouteStartPoint

#boolean SPAWN.SpawnRandomizeTemplate

SPAWN.SpawnRandomizeUnits

SPAWN:SpawnScheduleStart()

Will re-start the spawning scheduler.

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

SPAWN:SpawnScheduleStop(): Will stop the scheduled spawning scheduler.

SPAWN:SpawnScheduled(SpawnTime, SpawnTimeVariation)

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.

Parameters

#number SpawnTime : The time interval defined in seconds between each new spawn of new groups.
#number SpawnTimeVariation : The variation to be applied on the defined time interval between each new spawn. The variation is a number between 0 and 1, representing the %-tage of variation to be applied on the time interval.

Return value

#SPAWN: self

Usage:

-- 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 choosen for each new spawn of the helicopters.
Spawn_BE_KA50 = SPAWN:New( 'BE KA-50@RAMP-Ground Defense' ):Schedule( 600, 0.5 )

SPAWN.SpawnScheduler

SPAWN.SpawnTemplate: Contains the template structure for a Group Spawn from the Mission Editor. Note that this group must have lateActivation always on!!!

#string SPAWN.SpawnTemplatePrefix

SPAWN.SpawnTemplatePrefixTable

#boolean SPAWN.SpawnUnControlled

#boolean SPAWN.SpawnVisible: Flag that indicates if all the Groups of the SpawnGroup need to be visible when Spawned.

SPAWN:SpawnWithIndex(SpawnIndex)

Will spawn a group with a specified index number.

Uses DATABASE global object defined in MOOSE.

Parameter

#string SpawnIndex : The index of the group to be spawned.

Return value

Wrapper.Group#GROUP: The group that was spawned. You can use this group for further actions.

#SPAWN.SpawnZoneTable SPAWN.SpawnZoneTable

#boolean SPAWN.UnControlled: When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

SPAWN:_GetGroupCategoryID(SpawnPrefix)

Gets the CategoryID of the Group with the given SpawnPrefix

Parameter

SpawnPrefix :

SPAWN:_GetGroupCoalitionID(SpawnPrefix)

Gets the CoalitionID of the Group with the given SpawnPrefix

Parameter

SpawnPrefix :

SPAWN:_GetGroupCountryID(SpawnPrefix)

Gets the CountryID of the Group with the given SpawnPrefix

Parameter

SpawnPrefix :

SPAWN:_GetGroupFromDCSUnit(DCSUnit)

Return the group within the SpawnGroups collection with input a DCSUnit.

Parameter

Dcs.DCSWrapper.Unit#Unit DCSUnit : The DCSUnit to be searched.

Return values

Wrapper.Group#GROUP: The Group
#nil: Nothing found

SPAWN:_GetGroupIndexFromDCSUnit(DCSUnit)

Get the group index from a DCSUnit.

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

Parameter

Dcs.DCSWrapper.Unit#Unit DCSUnit : The DCSUnit to be searched.

Return values

#string: The prefix
#nil: Nothing found

SPAWN:_GetLastIndex(): Return the last maximum index that can be used.

SPAWN:_GetPrefixFromDCSUnit(DCSUnit)

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.

Parameter

Dcs.DCSWrapper.Unit#UNIT DCSUnit : The DCSUnit to be searched.

Return values

#string: The prefix
#nil: Nothing found

SPAWN:_GetSpawnIndex(SpawnIndex)

Get the next index of the groups to be spawned.

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

Parameter

SpawnIndex :

SPAWN:_GetTemplate(SpawnTemplatePrefix)

Gets the Group Template from the ME environment definition.

This method used the DATABASE object, which contains ALL initial and new spawned object in MOOSE.

Parameter

#string SpawnTemplatePrefix :

Return value

@SPAWN self

SPAWN:_InitializeSpawnGroups(SpawnIndex)

Initalize the SpawnGroups collection.

Parameter

SpawnIndex :

SPAWN:_OnBirth(Event)

Parameter

Core.Event#EVENTDATA Event :

SPAWN:_OnDeadOrCrash(Event)

Parameter

Core.Event#EVENTDATA Event :

SPAWN:_OnEngineShutDown(event)

Will detect AIR Units shutting down their engines ...

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

Parameter

event :

SPAWN:_OnLand(event)

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.

Parameter

event :

SPAWN:_OnTakeOff(event)

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.

Parameter

event :

SPAWN:_Prepare(SpawnTemplatePrefix, SpawnIndex)

Prepares the new Group Template.

Parameters

#string SpawnTemplatePrefix :
#number SpawnIndex :

Return value

#SPAWN: self

SPAWN:_RandomizeRoute(SpawnIndex)

Private method randomizing the routes.

Parameter

#number SpawnIndex : The index of the group to be spawned.

Return value

#SPAWN:

SPAWN:_RandomizeTemplate(SpawnIndex)

Private method that randomizes the template of the group.

Parameter

#number SpawnIndex :

Return value

#SPAWN: self

SPAWN:_RandomizeZones(SpawnIndex)

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

Parameter

#number SpawnIndex :

Return value

#SPAWN: self

SPAWN:_Scheduler()

This function is called automatically by the Spawning scheduler.

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

SPAWN:_SpawnCleanUpScheduler()

Schedules the CleanUp of Groups

Return value

#boolean: True = Continue Scheduler

SPAWN:_TranslateRotate(SpawnIndex, SpawnRootX, SpawnRootY, SpawnX, SpawnY, SpawnAngle)

Parameters

SpawnIndex :
SpawnRootX :
SpawnRootY :
SpawnX :
SpawnY :
SpawnAngle :

Modules

Module Spawn

1) Functional.Spawn#SPAWN class, extends Core.Base#BASE

1.1) SPAWN construction methods

1.2) SPAWN initialization methods

1.3) SPAWN spawning methods

1.4) Retrieve alive GROUPs spawned by the SPAWN object

1.5) SPAWN object cleaning

1.6) Catch the Group spawn event in a callback function!

API CHANGE HISTORY

AUTHORS and CONTRIBUTIONS

Contributions:

Authors:

Global(s)

Type SPAWN

Global(s)

Type Spawn

Type SPAWN

Field(s)

Return values

Usage:

Parameter

Return value

Return values

Usage:

Parameter

Return values

Usage:

Parameter

Parameters

Return value

Usage:

Parameter

Return value

Usage:

Parameters

Return value

Usage:

Parameters

Return value

Usage:

Parameter

Return value

Usage:

Parameters

Return value

Usage:

Parameter

Return value

Usage:

Return value

Return value

Return value

Parameter

Return value

Usages:

Parameters

Return value

Usages:

Parameters

Return value

Usage:

Parameter

Return value

Return value

Parameters

Return values

Parameters

Return values

Parameters

Return values

Parameters

Return values

Parameter

Return value

Parameters

Return values

Parameters

Return value

Usage:

Module `Spawn`

Type `SPAWN`

Type `Spawn`

Type `SPAWN`

Type `SPAWN.SpawnZoneTable`