From 73be61e71ff976cf91b99b760c7cfc4c27101229 Mon Sep 17 00:00:00 2001 From: Applevangelist Date: Sat, 11 Dec 2021 13:27:06 +0000 Subject: [PATCH] MOOSE generated documentation [skip ci] --- Documentation/AI.AI_A2G_Dispatcher.html | 44 - Documentation/AI.AI_AIR_Dispatcher.html | 44 - Documentation/AI.AI_Air_Squadron.html | 22 - Documentation/AI.AI_Cargo.html | 12 - Documentation/AI.AI_Cargo_Airplane.html | 12 + Documentation/Cargo.CargoGroup.html | 62 + Documentation/Cargo.CargoUnit.html | 44 +- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 33 - Documentation/Core.Set.html | 8592 ++++++++++++++++- Documentation/Core.Spawn.html | 110 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Functional.Designate.html | 55 - Documentation/Functional.Detection.html | 66 - Documentation/Functional.Rat.html | 6 - Documentation/Ops.Airboss.html | 89 +- Documentation/Ops.CSAR.html | 207 +- Documentation/Ops.CTLD.html | 246 +- Documentation/Tasking.Task.html | 22 - .../Tasking.Task_A2A_Dispatcher.html | 8 +- .../Tasking.Task_A2G_Dispatcher.html | 20 +- .../Tasking.Task_Cargo_Dispatcher.html | 8 +- Documentation/Wrapper.Client.html | 14 +- Documentation/Wrapper.Positionable.html | 44 - 24 files changed, 9048 insertions(+), 800 deletions(-) diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 6405458f6..69be64507 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4648,17 +4648,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -13001,17 +12990,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -14329,17 +14307,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -15963,17 +15930,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_AIR_Dispatcher.html b/Documentation/AI.AI_AIR_Dispatcher.html index 6385f8b6b..d33a529cc 100644 --- a/Documentation/AI.AI_AIR_Dispatcher.html +++ b/Documentation/AI.AI_AIR_Dispatcher.html @@ -4441,17 +4441,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -9749,17 +9738,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -11077,17 +11055,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
@@ -12711,17 +12678,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index 1650130c2..0ee22607a 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2438,17 +2438,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3520,17 +3509,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index d687ee691..692f19461 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2672,9 +2672,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

- @@ -4705,9 +4702,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

- @@ -5320,9 +5314,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

- @@ -6827,9 +6818,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

No loading happened, so we need to pickup something else.

- diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 014cabe6c..57e66dac3 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2665,6 +2665,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -4452,6 +4455,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -5081,6 +5087,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ @@ -6602,6 +6611,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Aircraft is on a depoly mission.

+ diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 29dd77ef8..ed75b0774 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1820,10 +1820,27 @@ Controls a network of short range air/missile defense groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup + +

Then we register the new group in the database

+
@@ -1835,6 +1852,20 @@ Controls a network of short range air/missile defense groups.

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
@@ -3124,10 +3155,27 @@ This works for ground only groups.

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ + +
+
+ + CARGO_GROUP.CargoGroup + +

Then we register the new group in the database

+
@@ -3139,6 +3187,20 @@ This works for ground only groups.

+ + + +
+
+ + +CARGO_GROUP.CargoObject + + + + +

Now we spawn the new group based on the template created.

+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 92565b046..945e48c7b 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1698,17 +1698,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -1727,6 +1716,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
@@ -2413,17 +2413,6 @@ Note that ground forces behave in a group, and thus, act in formation, regardles
-CARGO_UNIT.CargoCarrier - - - -
- - -
-
- - CARGO_UNIT.CargoInAir @@ -2442,6 +2431,17 @@ Note that ground forces behave in a group, and thus, act in formation, regardles

Set cargo object.

+
+ +
+
+
+ + #number +CARGO_UNIT.RunCount + + +
diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index 252bb98ff..6a2ec2e6e 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5656,7 +5656,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState @@ -7259,7 +7259,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 2abea4578..81d419195 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -16149,17 +16149,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -16958,17 +16947,6 @@ BASE:TraceOnOff( false )

the y coordinate in meters.

-
- -
-
-
- - -POINT_VEC2.z - - -
@@ -24692,17 +24670,6 @@ Creates a line on the F10 map from one point to another.

the y coordinate in meters.

- - - -
-
- - -POINT_VEC2.z - - -
diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index 98bb5a317..af8c0cda5 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -1520,9 +1520,9 @@ Controls a network of short range air/missile defense groups.

Once the filter criteria have been set for the SET_CLIENT, you can start filtering using:

@@ -1818,12 +1819,6 @@ Filter criteria are defined by:

  • SET_CLIENT.FilterOnce: Filters the clients once.
    • -

    Planned filter criteria within development are (so these are not yet available):

    - - -

    4) SET_CLIENT iterators

    Once the filters have been defined and the SET_CLIENT has been built, you can iterate the SET_CLIENT with the available iterator methods. @@ -1907,9 +1902,9 @@ Filter criteria are defined by:

  • SET_GROUP.FilterCategoryGround: Builds the SET_GROUP from ground vehicles or infantry.
  • SET_GROUP.FilterCategoryShip: Builds the SET_GROUP from ships.
  • SET_GROUP.FilterCategoryStructure: Builds the SET_GROUP from structures.
    • +
  • SET_GROUP.FilterZones: Builds the SET_GROUP with the groups within a Core.Zone#ZONE.
    • -

    Once the filter criteria have been set for the SET_GROUP, you can start filtering using:

    -

    Planned filter criteria within development are (so these are not yet available):

    - - -

    SET_GROUP iterators

    Once the filters have been defined and the SET_GROUP has been built, you can iterate the SET_GROUP with the available iterator methods. @@ -1944,7 +1933,7 @@ The following iterator methods are currently available within the SET_GROUP:

    When a GROUP object crashes or is dead, the SET_GROUP will trigger a Dead event.

    You can handle the event using the OnBefore and OnAfter event handlers. -The event handlers need to have the parameters From, Event, To, GroupObject. +The event handlers need to have the paramters From, Event, To, GroupObject. The GroupObject is the GROUP object that is dead and within the SET_GROUP, and is passed as a parameter to the event handler. See the following example:

    @@ -1960,7 +1949,7 @@ See the following example:

    While this is a good example, there is a catch. -Imagine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method. +Imageine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method. So, the self would need to contain another object. Fortunately, this can be done, but you must use then the . notation for the method. See the modified example:

    @@ -1986,6 +1975,131 @@ See the modified example:

    + + + +
    + + + + + +

    Global SET_OPSGROUP

    		 +

    Mission designers can use the Core.Set#SET_OPSGROUP class to build sets of OPS groups belonging to certain:

    + +
      +
    • Coalitions
      • +
    • Categories
      • +
    • Countries
      • +
    • Contain a certain string pattern
      • +
    + +

    SET_OPSGROUP constructor

    + +

    Create a new SET_OPSGROUP object with the SET_OPSGROUP.New method:

    + + +
    +
    +
    +
    + + #SET_OPSGROUP +SET_OPSGROUP + +

    Mission designers can use the Core.Set#SET_OPSGROUP class to build sets of OPS groups belonging to certain:

    + +
      +
    • Coalitions
      • +
    • Categories
      • +
    • Countries
      • +
    • Contain a certain string pattern
      • +
    + +

    SET_OPSGROUP constructor

    + +

    Create a new SET_OPSGROUP object with the SET_OPSGROUP.New method:

    + + + + + +

    Add or Remove GROUP(s) from SET_OPSGROUP

    + +

    GROUPS can be added and removed using the Core.Set#SET_OPSGROUP.AddGroupsByName and Core.Set#SET_OPSGROUP.RemoveGroupsByName respectively. +These methods take a single GROUP name or an array of GROUP names to be added or removed from SET_OPSGROUP.

    + +

    SET_OPSGROUP filter criteria

    + +

    You can set filter criteria to define the set of groups within the SET_OPSGROUP. +Filter criteria are defined by:

    + + + +

    For the Category Filter, extra methods have been added:

    + + + + +

    Once the filter criteria have been set for the SET_OPSGROUP, you can start filtering using:

    + + + + +

    SET_OPSGROUP iterators

    + +

    Once the filters have been defined and the SET_OPSGROUP has been built, you can iterate the SET_OPSGROUP with the available iterator methods. +The iterator methods will walk the SET_OPSGROUP set, and call for each element within the set a function that you provide. +The following iterator methods are currently available within the SET_OPSGROUP:

    + + + +

    SET_OPSGROUP trigger events on the GROUP objects.

    + +

    The SET is derived from the FSM class, which provides extra capabilities to track the contents of the GROUP objects in the SET_OPSGROUP.

    + +

    When a GROUP object crashes or is dead, the SET_OPSGROUP will trigger a Dead event.

    + +

    You can handle the event using the OnBefore and OnAfter event handlers. +The event handlers need to have the paramters From, Event, To, GroupObject. +The GroupObject is the GROUP object that is dead and within the SET_OPSGROUP, and is passed as a parameter to the event handler. +See the following example:

    + +
       -- Create the SetCarrier SET_OPSGROUP collection.
+
+   local SetHelicopter = SET_OPSGROUP:New():FilterPrefixes( "Helicopter" ):FilterStart()
+
+   -- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
+
+   function SetHelicopter:OnAfterDead( From, Event, To, GroupObject )
+     self:F( { GroupObject = GroupObject:GetName() } )
+   end
+
    + + +
    + +
    @@ -2125,6 +2239,7 @@ Filter criteria are defined by:

  • SET_STATIC.FilterTypes: Builds the SET_STATIC with the units belonging to the unit type(s).
  • SET_STATIC.FilterCountries: Builds the SET_STATIC with the units belonging to the country(ies).
  • SET_STATIC.FilterPrefixes: Builds the SET_STATIC with the units containing the same string(s) in their name. ATTENTION bad naming convention as this does not* only filter prefixes.
    • +
  • SET_STATIC.FilterZones: Builds the SET_STATIC with the units within a Core.Zone#ZONE.

    • Once the filter criteria have been set for the SET_STATIC, you can start filtering using:

    @@ -2133,12 +2248,6 @@ Filter criteria are defined by:

  • SET_STATIC.FilterStart: Starts the filtering of the units within the SET_STATIC.
    • -

    Planned filter criteria within development are (so these are not yet available):

    - - -

    SET_STATIC iterators

    Once the filters have been defined and the SET_STATIC has been built, you can iterate the SET_STATIC with the available iterator methods. @@ -2147,16 +2256,9 @@ The following iterator methods are currently available within the SET_STATIC:

  • SET_STATIC.ForEachStatic: Calls a function for each alive unit it finds within the SET_STATIC.
    • -
  • SET_GROUP.ForEachGroupCompletelyInZone: Iterate the SET_GROUP and call an iterator function for each alive GROUP presence completely in a Zone, providing the GROUP and optional parameters to the called function.
    • -
  • SET_GROUP.ForEachGroupNotInZone: Iterate the SET_GROUP and call an iterator function for each alive GROUP presence not in a Zone, providing the GROUP and optional parameters to the called function.
    • - - -

    Planned iterators methods in development are (so these are not yet available):

    - -

    SET_STATIC atomic methods

    @@ -2233,6 +2335,7 @@ Filter criteria are defined by:

  • SET_UNIT.FilterCountries: Builds the SET_UNIT with the units belonging to the country(ies).
  • SET_UNIT.FilterPrefixes: Builds the SET_UNIT with the units sharing the same string(s) in their name. ATTENTION! Bad naming convention as this does not only filter prefixes.
  • SET_UNIT.FilterActive: Builds the SET_UNIT with the units that are only active. Units that are inactive (late activation) won't be included in the set!
    • +
  • SET_UNIT.FilterZones: Builds the SET_UNIT with the units within a Core.Zone#ZONE.

    • Once the filter criteria have been set for the SET_UNIT, you can start filtering using:

    @@ -2242,12 +2345,6 @@ Filter criteria are defined by:

  • SET_UNIT.FilterOnce: Filters of the units once.
    • -

    Planned filter criteria within development are (so these are not yet available):

    - - -

    4) SET_UNIT iterators

    Once the filters have been defined and the SET_UNIT has been built, you can iterate the SET_UNIT with the available iterator methods. @@ -2283,7 +2380,7 @@ The following iterator methods are currently available within the SET_UNIT:

    6.1) When a UNIT object crashes or is dead, the SET_UNIT will trigger a Dead event.

    You can handle the event using the OnBefore and OnAfter event handlers. -The event handlers need to have the parameters From, Event, To, GroupObject. +The event handlers need to have the paramters From, Event, To, GroupObject. The GroupObject is the UNIT object that is dead and within the SET_UNIT, and is passed as a parameter to the event handler. See the following example:

    @@ -2299,7 +2396,7 @@ See the following example:

    While this is a good example, there is a catch. -Imagine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method. +Imageine you want to execute the code above, the the self would need to be from the object declared outside (above) the OnAfterDead method. So, the self would need to contain another object. Fortunately, this can be done, but you must use then the . notation for the method. See the modified example:

    @@ -2528,7 +2625,7 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

    SET_AIRBASE:ForEachAirbase(IteratorFunction, ...)

    -

    Iterate the SET_AIRBASE and call an iterator function for each AIRBASE, providing the AIRBASE and optional parameters.

    +

    Iterate the SET_AIRBASE and call an interator function for each AIRBASE, providing the AIRBASE and optional parameters.

    @@ -2585,6 +2682,12 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

    SET_AIRBASE:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_AIRBASE:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -2746,7 +2849,7 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

    SET_AIRBASE.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -2819,6 +2922,12 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

    SET_AIRBASE.SomeIteratorLimit

    + + + +

    SET_AIRBASE:SortByName()

    + +

    Sort the set by name.

    @@ -3410,6 +3519,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_BASE:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_BASE:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -3571,7 +3686,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_BASE.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -3644,6 +3759,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_BASE.SomeIteratorLimit

    + + + +

    SET_BASE:SortByName()

    + +

    Sort the set by name.

    @@ -4337,7 +4458,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CARGO:ForEachCargo(IteratorFunction, ...)

    -

    (R2.1) Iterate the SET_CARGO and call an iterator function for each CARGO, providing the CARGO and optional parameters.

    +

    (R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.

    @@ -4388,6 +4509,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CARGO:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_CARGO:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -4549,7 +4676,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CARGO.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -4622,6 +4749,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CARGO.SomeIteratorLimit

    + + + +

    SET_CARGO:SortByName()

    + +

    Sort the set by name.

    @@ -5262,6 +5395,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CLIENT:FilterTypes(Types)

    Builds a set of clients of defined client types.

    + + + +

    SET_CLIENT:FilterZones(Zones)

    + +

    Builds a set of clients in zones.

    @@ -5279,7 +5418,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CLIENT:ForEachClient(IteratorFunction, ...)

    -

    Iterate the SET_CLIENT and call an iterator function for each alive CLIENT, providing the CLIENT and optional parameters.

    +

    Iterate the SET_CLIENT and call an interator function for each alive CLIENT, providing the CLIENT and optional parameters.

    @@ -5330,6 +5469,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CLIENT:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_CLIENT:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -5491,7 +5636,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CLIENT.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -5564,6 +5709,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_CLIENT.SomeIteratorLimit

    + + + +

    SET_CLIENT:SortByName()

    + +

    Sort the set by name.

    @@ -6146,6 +6297,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Fields and Methods inherited from SET_GROUP Description + +

    SET_GROUP:Activate(Delay)

    + +

    Activate late activated groups.

    + +

    SET_GROUP:AddGroup(group)

    @@ -6272,6 +6429,12 @@ provides an easy to use shortcut...

    SET_GROUP:FilterStart()

    Starts the filtering.

    + + + +

    SET_GROUP:FilterZones(Zones)

    + +

    Builds a set of groups in zones.

    @@ -6408,6 +6571,12 @@ mission designer to add a dedicated method

    SET_GROUP:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_GROUP:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -6569,7 +6738,7 @@ mission designer to add a dedicated method

    SET_GROUP.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -6642,6 +6811,12 @@ mission designer to add a dedicated method

    SET_GROUP.SomeIteratorLimit

    + + + +

    SET_GROUP:SortByName()

    + +

    Sort the set by name.

    @@ -7207,6 +7382,1014 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_GROUP:onEvent(event)

    + + + + + +

    Type SET_OPSGROUP

    +
    + SET_OPSGROUP +, extends Core.Set#SET_BASE +, extends Core.Base#BASE +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from SET_OPSGROUPDescription

    SET_OPSGROUP:Activate(Delay)

    		 +

    Activate late activated groups in the set.

    +

    SET_OPSGROUP:Add(ObjectName, Object)

    		 +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using a given ObjectName as the index.

    +

    SET_OPSGROUP:AddGroup(group)

    		 +

    Add a GROUP or OPSGROUP object to the set.

    +

    SET_OPSGROUP:AddGroupsByName(AddGroupNames)

    		 +

    Add GROUP(s) or OPSGROUP(s) to the set.

    +

    SET_OPSGROUP:AddInDatabase(Event)

    		 +

    Handles the Database to check on an event (birth) that the Object was added in the Database.

    +

    SET_OPSGROUP:FilterActive(Active)

    		 +

    Builds a set of groups that are only active.

    +

    SET_OPSGROUP:FilterCategories(Categories)

    		 +

    Builds a set of groups out of categories.

    +

    SET_OPSGROUP:FilterCategoryAircraft()

    		 +

    Builds a set of groups out of aicraft category (planes and helicopters).

    +

    SET_OPSGROUP:FilterCategoryAirplane()

    		 +

    Builds a set of groups out of airplane category.

    +

    SET_OPSGROUP:FilterCategoryGround()

    		 +

    Builds a set of groups out of ground category.

    +

    SET_OPSGROUP:FilterCategoryHelicopter()

    		 +

    Builds a set of groups out of helicopter category.

    +

    SET_OPSGROUP:FilterCategoryShip()

    		 +

    Builds a set of groups out of ship category.

    +

    SET_OPSGROUP:FilterCoalitions(Coalitions)

    		 +

    Builds a set of groups of coalitions.

    +

    SET_OPSGROUP:FilterCountries(Countries)

    		 +

    Builds a set of groups of defined countries.

    +

    SET_OPSGROUP:FilterPrefixes(Prefixes)

    		 +

    Builds a set of groups that contain the given string in their group name.

    +

    SET_OPSGROUP:FilterStart()

    		 +

    Starts the filtering.

    +

    SET_OPSGROUP:FindArmyGroup(GroupName)

    		 +

    Finds a ARMYGROUP based on the group name.

    +

    SET_OPSGROUP:FindFlightGroup(GroupName)

    		 +

    Finds a FLIGHTGROUP based on the group name.

    +

    SET_OPSGROUP:FindGroup(GroupName)

    		 +

    Finds an OPSGROUP based on the group name.

    +

    SET_OPSGROUP:FindInDatabase(Event)

    		 +

    Handles the Database to check on any event that Object exists in the Database.

    +

    SET_OPSGROUP:FindNavyGroup(GroupName)

    		 +

    Finds a NAVYGROUP based on the group name.

    +

    SET_OPSGROUP:ForEachGroup(IteratorFunction, ...)

    		 +

    Iterate the set and call an iterator function for each OPSGROUP object.

    +

    SET_OPSGROUP:GetAliveSet()

    		 +

    Gets the Set.

    +

    SET_OPSGROUP:IsIncludeObject(MGroup)

    		 +

    Check include object.

    +

    SET_OPSGROUP:New()

    		 +

    Creates a new SET_OPSGROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.

    +

    SET_OPSGROUP:RemoveGroupsByName(RemoveGroupNames)

    		 +

    Remove GROUP(s) or OPSGROUP(s) from the set.

    +

    SET_OPSGROUP:_EventOnDeadOrCrash(Event)

    		 +

    Handles the OnDead or OnCrash event for alive groups set.

    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from SET_BASEDescription

    SET_OPSGROUP:Add(ObjectName, Object)

    		 +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using a given ObjectName as the index.

    +

    SET_OPSGROUP:AddObject(Object)

    		 +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    +

    SET_OPSGROUP:AddSet(SetToAdd)

    		 +

    Add a SET to this set.

    +

    SET_OPSGROUP.CallScheduler

    		 + +

    SET_OPSGROUP:Clear()

    		 +

    Clear the Objects in the Set.

    +

    SET_OPSGROUP:CompareSets(SetA, SetB)

    		 +

    Compare two sets.

    +

    SET_OPSGROUP:Count()

    		 +

    Retrieves the amount of objects in the Core.Set#SET_BASE and derived classes.

    +

    SET_OPSGROUP.Database

    		 + +

    SET_OPSGROUP.Filter

    		 +

    Table of filters.

    +

    SET_OPSGROUP:FilterCrashes()

    		 +

    Starts the filtering of the Crash events for the collection.

    +

    SET_OPSGROUP:FilterDeads()

    		 +

    Starts the filtering of the Dead events for the collection.

    +

    SET_OPSGROUP:FilterOnce()

    		 +

    Filters for the defined collection.

    +

    SET_OPSGROUP:FilterStop()

    		 +

    Stops the filtering for the defined collection.

    +

    SET_OPSGROUP:FindNearestObjectFromPointVec2(PointVec2)

    		 +

    Iterate the SET_BASE while identifying the nearest object from a Core.Point#POINT_VEC2.

    +

    SET_OPSGROUP:Flush(MasterObject)

    		 +

    Flushes the current SET_BASE contents in the log ...

    +

    SET_OPSGROUP:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)

    		 +

    Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.

    +

    SET_OPSGROUP:ForSome(IteratorFunction, arg, Set, Function, FunctionArguments)

    		 +

    Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.

    +

    SET_OPSGROUP:Get(ObjectName)

    		 +

    Gets a Core.Base#BASE object from the Core.Set#SET_BASE and derived classes, based on the Object Name.

    +

    SET_OPSGROUP:GetFirst()

    		 +

    Gets the first object from the Core.Set#SET_BASE and derived classes.

    +

    SET_OPSGROUP:GetLast()

    		 +

    Gets the last object from the Core.Set#SET_BASE and derived classes.

    +

    SET_OPSGROUP:GetObjectNames()

    		 +

    Gets a string with all the object names.

    +

    SET_OPSGROUP:GetRandom()

    		 +

    Gets a random object from the Core.Set#SET_BASE and derived classes.

    +

    SET_OPSGROUP:GetSet()

    		 +

    Gets the Set.

    +

    SET_OPSGROUP:GetSetComplement(SetB)

    		 +

    Get the complement of two sets.

    +

    SET_OPSGROUP:GetSetIntersection(SetB)

    		 +

    Get the intersection of this set, called A , and another set.

    +

    SET_OPSGROUP:GetSetNames()

    		 +

    Gets a list of the Names of the Objects in the Set.

    +

    SET_OPSGROUP:GetSetObjects()

    		 +

    Gets a list of the Objects in the Set.

    +

    SET_OPSGROUP:GetSetUnion(SetB)

    		 +

    Get the union of two sets.

    +

    SET_OPSGROUP:GetSomeIteratorLimit()

    		 +

    Get the SET iterator "limit".

    +

    SET_OPSGROUP.Index

    		 +

    Table of indicies.

    +

    SET_OPSGROUP:IsInSet(Object, ObjectName)

    		 +

    Decides whether to include the Object.

    +

    SET_OPSGROUP:IsIncludeObject(Object)

    		 +

    Decides whether to include the Object.

    +

    SET_OPSGROUP.List

    		 +

    Unused table.

    +

    SET_OPSGROUP:New(Database)

    		 +

    Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

    +

    SET_OPSGROUP:OnAfterAdded(From, Event, To, ObjectName, Object)

    		 +

    Added Handler OnAfter for SET_BASE

    +

    SET_OPSGROUP:OnAfterRemoved(From, Event, To, ObjectName, Object)

    		 +

    Removed Handler OnAfter for SET_BASE

    +

    SET_OPSGROUP:Remove(ObjectName, NoTriggerEvent)

    		 +

    Removes a Core.Base#BASE object from the Core.Set#SET_BASE and derived classes, based on the Object Name.

    +

    SET_OPSGROUP.Set

    		 +

    Table of objects.

    +

    SET_OPSGROUP:SetDatabase(BaseSet)

    		 +

    Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).

    +

    SET_OPSGROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

    		 +

    Define the SET iterator "yield interval" and the "time interval".

    +

    SET_OPSGROUP:SetSomeIteratorLimit(Limit)

    		 +

    Define the SET iterator "limit".

    +

    SET_OPSGROUP.SomeIteratorLimit

    		 + +

    SET_OPSGROUP:SortByName()

    		 +

    Sort the set by name.

    +

    SET_OPSGROUP.TimeInterval

    		 + +

    SET_OPSGROUP.YieldInterval

    		 + +

    SET_OPSGROUP:_EventOnBirth(Event)

    		 +

    Handles the OnBirth event for the Set.

    +

    SET_OPSGROUP:_EventOnDeadOrCrash(Event)

    		 +

    Handles the OnDead or OnCrash event for alive units set.

    +

    SET_OPSGROUP:_FilterStart()

    		 +

    Starts the filtering for the defined collection.

    +

    SET_OPSGROUP:_Find(ObjectName)

    		 +

    Finds an Core.Base#BASE object based on the object Name.

    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Fields and Methods inherited from BASEDescription

    SET_OPSGROUP.ClassID

    		 +

    The ID number of the class.

    +

    SET_OPSGROUP.ClassName

    		 +

    The name of the class.

    +

    SET_OPSGROUP.ClassNameAndID

    		 +

    The name of the class concatenated with the ID number of the class.

    +

    SET_OPSGROUP:ClearState(Object, StateName)

    		 +

    Clear the state of an object.

    +

    SET_OPSGROUP:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

    		 +

    Creation of a Birth Event.

    +

    SET_OPSGROUP:CreateEventCrash(EventTime, Initiator)

    		 +

    Creation of a Crash Event.

    +

    SET_OPSGROUP:CreateEventDead(EventTime, Initiator)

    		 +

    Creation of a Dead Event.

    +

    SET_OPSGROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

    		 +

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    +

    SET_OPSGROUP:CreateEventRemoveUnit(EventTime, Initiator)

    		 +

    Creation of a Remove Unit Event.

    +

    SET_OPSGROUP:CreateEventTakeoff(EventTime, Initiator)

    		 +

    Creation of a Takeoff Event.

    +

    SET_OPSGROUP:E(Arguments)

    		 +

    Log an exception which will be traced always.

    +

    SET_OPSGROUP:EventDispatcher()

    		 +

    Returns the event dispatcher

    +

    SET_OPSGROUP:EventRemoveAll()

    		 +

    Remove all subscribed events

    +

    SET_OPSGROUP:F(Arguments)

    		 +

    Trace a function call.

    +

    SET_OPSGROUP:F2(Arguments)

    		 +

    Trace a function call level 2.

    +

    SET_OPSGROUP:F3(Arguments)

    		 +

    Trace a function call level 3.

    +

    SET_OPSGROUP:GetClassID()

    		 +

    Get the ClassID of the class instance.

    +

    SET_OPSGROUP:GetClassName()

    		 +

    Get the ClassName of the class instance.

    +

    SET_OPSGROUP:GetClassNameAndID()

    		 +

    Get the ClassName + ClassID of the class instance.

    +

    SET_OPSGROUP:GetEventPriority()

    		 +

    Get the Class Event processing Priority.

    +

    SET_OPSGROUP:GetParent(Child, FromClass)

    		 +

    This is the worker method to retrieve the Parent class.

    +

    SET_OPSGROUP:GetState(Object, Key)

    		 +

    Get a Value given a Key from the Object.

    +

    SET_OPSGROUP:HandleEvent(EventID, EventFunction)

    		 +

    Subscribe to a DCS Event.

    +

    SET_OPSGROUP:I(Arguments)

    		 +

    Log an information which will be traced always.

    +

    SET_OPSGROUP:Inherit(Child, Parent)

    		 +

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

    +

    SET_OPSGROUP:IsInstanceOf(ClassName)

    		 +

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

    +

    SET_OPSGROUP:IsTrace()

    		 +

    Enquires if tracing is on (for the class).

    +

    SET_OPSGROUP:New()

    		 +

    BASE constructor.

    +

    SET_OPSGROUP:OnEvent(EventData)

    		 +

    Occurs when an object is completely destroyed.

    +

    SET_OPSGROUP:OnEventBDA(EventData)

    		 +

    BDA.

    +

    SET_OPSGROUP:OnEventBaseCaptured(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventBirth(EventData)

    		 +

    Occurs when any object is spawned into the mission.

    +

    SET_OPSGROUP:OnEventCrash(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventDead(EventData)

    		 +

    Occurs when an object is dead.

    +

    SET_OPSGROUP:OnEventDetailedFailure(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventDiscardChairAfterEjection(EventData)

    		 +

    Discard chair after ejection.

    +

    SET_OPSGROUP:OnEventEjection(EventData)

    		 +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    +

    SET_OPSGROUP:OnEventEngineShutdown(EventData)

    		 +

    Occurs when any aircraft shuts down its engines.

    +

    SET_OPSGROUP:OnEventEngineStartup(EventData)

    		 +

    Occurs when any aircraft starts its engines.

    +

    SET_OPSGROUP:OnEventHit(EventData)

    		 +

    Occurs whenever an object is hit by a weapon.

    +

    SET_OPSGROUP:OnEventHumanFailure(EventData)

    		 +

    Occurs when any system fails on a human controlled aircraft.

    +

    SET_OPSGROUP:OnEventKill(EventData)

    		 +

    Occurs on the death of a unit.

    +

    SET_OPSGROUP:OnEventLand(EventData)

    		 +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    +

    SET_OPSGROUP:OnEventLandingAfterEjection(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventLandingQualityMark(EventData)

    		 +

    Landing quality mark.

    +

    SET_OPSGROUP:OnEventMarkAdded(EventData)

    		 +

    Occurs when a new mark was added.

    +

    SET_OPSGROUP:OnEventMarkChange(EventData)

    		 +

    Occurs when a mark text was changed.

    +

    SET_OPSGROUP:OnEventMarkRemoved(EventData)

    		 +

    Occurs when a mark was removed.

    +

    SET_OPSGROUP:OnEventMissionEnd(EventData)

    		 +

    Occurs when a mission ends

    +

    SET_OPSGROUP:OnEventMissionStart(EventData)

    		 +

    Occurs when a mission starts

    +

    SET_OPSGROUP:OnEventParatrooperLanding(EventData)

    		 +

    Weapon add.

    +

    SET_OPSGROUP:OnEventPilotDead(EventData)

    		 +

    Occurs when the pilot of an aircraft is killed.

    +

    SET_OPSGROUP:OnEventPlayerEnterAircraft(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventPlayerEnterUnit(EventData)

    		 +

    Occurs when any player assumes direct control of a unit.

    +

    SET_OPSGROUP:OnEventPlayerLeaveUnit(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventRefueling(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventRefuelingStop(EventData)

    		 +

    Occurs when an aircraft is finished taking fuel.

    +

    SET_OPSGROUP:OnEventScore(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventShootingEnd(EventData)

    		 +

    Occurs when any unit stops firing its weapon.

    +

    SET_OPSGROUP:OnEventShootingStart(EventData)

    		 +

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

    +

    SET_OPSGROUP:OnEventShot(EventData)

    		 +

    Occurs whenever any unit in a mission fires a weapon.

    +

    SET_OPSGROUP:OnEventTakeoff(EventData)

    		 +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    +

    SET_OPSGROUP:OnEventTriggerZone(EventData)

    		 +

    Trigger zone.

    +

    SET_OPSGROUP:OnEventUnitLost(EventData)

    		 +

    Occurs when the game thinks an object is destroyed.

    +

    SET_OPSGROUP:ScheduleOnce(Start, SchedulerFunction, ...)

    		 +

    Schedule a new time event.

    +

    SET_OPSGROUP:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

    		 +

    Schedule a new time event.

    +

    SET_OPSGROUP:ScheduleStop(SchedulerFunction)

    		 +

    Stops the Schedule.

    +

    SET_OPSGROUP.Scheduler

    		 + +

    SET_OPSGROUP:SetEventPriority(EventPriority)

    		 +

    Set the Class Event processing Priority.

    +

    SET_OPSGROUP:SetState(Object, Key, Value)

    		 +

    Set a state or property of the Object given a Key and a Value.

    +

    SET_OPSGROUP:T(Arguments)

    		 +

    Trace a function logic level 1.

    +

    SET_OPSGROUP:T2(Arguments)

    		 +

    Trace a function logic level 2.

    +

    SET_OPSGROUP:T3(Arguments)

    		 +

    Trace a function logic level 3.

    +

    SET_OPSGROUP:TraceAll(TraceAll)

    		 +

    Trace all methods in MOOSE

    +

    SET_OPSGROUP:TraceClass(Class)

    		 +

    Set tracing for a class

    +

    SET_OPSGROUP:TraceClassMethod(Class, Method)

    		 +

    Set tracing for a specific method of class

    +

    SET_OPSGROUP:TraceLevel(Level)

    		 +

    Set trace level

    +

    SET_OPSGROUP:TraceOff()

    		 +

    Set trace off.

    +

    SET_OPSGROUP:TraceOn()

    		 +

    Set trace on.

    +

    SET_OPSGROUP:TraceOnOff(TraceOnOff)

    		 +

    Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

    +

    SET_OPSGROUP:UnHandleEvent(EventID)

    		 +

    UnSubscribe to a DCS event.

    +

    SET_OPSGROUP._

    		 + +

    SET_OPSGROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 +

    Trace a function call.

    +

    SET_OPSGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    		 +

    Trace a function logic.

    +

    SET_OPSGROUP.__

    		 + +

    SET_OPSGROUP:onEvent(event)

    		 +
    @@ -7270,6 +8453,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_PLAYER:FilterTypes(Types)

    Builds a set of clients of defined client types joined by players.

    + + + +

    SET_PLAYER:FilterZones(Zones)

    + +

    Builds a set of players in zones.

    @@ -7287,7 +8476,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_PLAYER:ForEachPlayer(IteratorFunction, ...)

    -

    Iterate the SET_PLAYER and call an iterator function for each alive CLIENT, providing the CLIENT and optional parameters.

    +

    Iterate the SET_PLAYER and call an interator function for each alive CLIENT, providing the CLIENT and optional parameters.

    @@ -7338,6 +8527,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_PLAYER:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_PLAYER:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -7499,7 +8694,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_PLAYER.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -7572,6 +8767,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_PLAYER.SomeIteratorLimit

    + + + +

    SET_PLAYER:SortByName()

    + +

    Sort the set by name.

    @@ -8218,6 +9419,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_STATIC:FilterTypes(Types)

    Builds a set of units of defined unit types.

    + + + +

    SET_STATIC:FilterZones(Zones)

    + +

    Builds a set of statics in zones.

    @@ -8235,7 +9442,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_STATIC:ForEachStatic(IteratorFunction, ...)

    -

    Iterate the SET_STATIC and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.

    +

    Iterate the SET_STATIC and call an interator function for each alive STATIC, providing the STATIC and optional parameters.

    @@ -8346,6 +9553,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_STATIC:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_STATIC:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -8507,7 +9720,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_STATIC.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -8580,6 +9793,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_STATIC.SomeIteratorLimit

    + + + +

    SET_STATIC:SortByName()

    + +

    Sort the set by name.

    @@ -9183,7 +10402,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT:CalculateThreatLevelA2G()

    -

    Calculate the maximum A2G threat level of the SET_UNIT.

    +

    Calculate the maxium A2G threat level of the SET_UNIT.

    @@ -9244,6 +10463,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT:FilterTypes(Types)

    Builds a set of units of defined unit types.

    + + + +

    SET_UNIT:FilterZones(Zones)

    + +

    Builds a set of units in zones.

    @@ -9261,7 +10486,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT:ForEachUnit(IteratorFunction, ...)

    -

    Iterate the SET_UNIT and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

    +

    Iterate the SET_UNIT and call an interator function for each alive UNIT, providing the UNIT and optional parameters.

    @@ -9279,7 +10504,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT:ForEachUnitPerThreatLevel(FromThreatLevel, ToThreatLevel, IteratorFunction, ...)

    -

    Iterate the SET_UNIT sorted *per Threat Level and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

    +

    Iterate the SET_UNIT sorted *per Threat Level and call an interator function for each alive UNIT, providing the UNIT and optional parameters.

    @@ -9422,6 +10647,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_UNIT:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -9583,7 +10814,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -9656,6 +10887,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_UNIT.SomeIteratorLimit

    + + + +

    SET_UNIT:SortByName()

    + +

    Sort the set by name.

    @@ -10289,7 +11526,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE:ForEachZone(IteratorFunction, ...)

    -

    Iterate the SET_ZONE and call an iterator function for each ZONE, providing the ZONE and optional parameters.

    +

    Iterate the SET_ZONE and call an interator function for each ZONE, providing the ZONE and optional parameters.

    @@ -10358,6 +11595,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_ZONE:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -10519,7 +11762,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -10592,6 +11835,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE.SomeIteratorLimit

    + + + +

    SET_ZONE:SortByName()

    + +

    Sort the set by name.

    @@ -11219,7 +12468,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE_GOAL:ForEachZone(IteratorFunction, ...)

    -

    Iterate the SET_ZONE_GOAL and call an iterator function for each ZONE, providing the ZONE and optional parameters.

    +

    Iterate the SET_ZONE_GOAL and call an interator function for each ZONE, providing the ZONE and optional parameters.

    @@ -11288,6 +12537,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE_GOAL:AddObject(Object)

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + + + +

    SET_ZONE_GOAL:AddSet(SetToAdd)

    + +

    Add a SET to this set.

    @@ -11449,7 +12704,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE_GOAL.Index

    -

    Table of indices.

    +

    Table of indicies.

    @@ -11522,6 +12777,12 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_ZONE_GOAL.SomeIteratorLimit

    + + + +

    SET_ZONE_GOAL:SortByName()

    + +

    Sort the set by name.

    @@ -12572,7 +13833,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    SET_AIRBASE:ForEachAirbase(IteratorFunction, ...)

    -

    Iterate the SET_AIRBASE and call an iterator function for each AIRBASE, providing the AIRBASE and optional parameters.

    +

    Iterate the SET_AIRBASE and call an interator function for each AIRBASE, providing the AIRBASE and optional parameters.

    @@ -12933,6 +14194,50 @@ DatabaseSet = SET_AIRBASE:New()
    + + + +
    + +
    +

    SET_AIRBASE:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -13244,7 +14549,7 @@ DatabaseSet = SET_AIRBASE:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -14187,7 +15492,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -14336,6 +15641,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_AIRBASE:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -17760,7 +19095,7 @@ BASE:TraceOnOff( false ) #table SET_BASE.Index -

    Table of indices.

    +

    Table of indicies.

    @@ -17908,6 +19243,50 @@ BASE:TraceOnOff( false ) + + + +
    + +
    +

    SET_BASE:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -18219,7 +19598,7 @@ BASE:TraceOnOff( false )
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -19162,7 +20541,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -19311,6 +20690,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_BASE:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -19493,7 +20902,7 @@ DBObject = SET_BASE:New() #table SET_BASE.Index -

    Table of indices.

    +

    Table of indicies.

    @@ -23501,7 +24910,7 @@ BASE:TraceOnOff( false )

    SET_CARGO:ForEachCargo(IteratorFunction, ...)

    -

    (R2.1) Iterate the SET_CARGO and call an iterator function for each CARGO, providing the CARGO and optional parameters.

    +

    (R2.1) Iterate the SET_CARGO and call an interator function for each CARGO, providing the CARGO and optional parameters.

    @@ -23833,6 +25242,50 @@ DatabaseSet = SET_CARGO:New()
    + + + +
    + +
    +

    SET_CARGO:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -24144,7 +25597,7 @@ DatabaseSet = SET_CARGO:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -25087,7 +26540,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -25236,6 +26689,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_CARGO:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -28774,7 +30257,7 @@ BASE:TraceOnOff( false )
    -

    (Optional) Include only active clients to the set. +

    (optional) Include only active clients to the set. Include inactive clients if you provide false.

    @@ -29072,6 +30555,50 @@ ClientSet = SET_CLIENT:New():FilterActive( false ):FilterCoalition( "blue" ):Fil + + + +
    + +
    +

    SET_CLIENT:FilterZones(Zones)

    +
    + +

    Builds a set of clients in zones.

    + +
    +
    +

    Defined in:

    +
    +

    SET_CLIENT

    +
    +

    Parameter:

    +
    +
    +

    + #table + Zones +

    +
    +
    + +

    Table of Core.Zone#ZONE Zone objects, or a Core.Set#SET_ZONE

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_TABLE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -29176,7 +30703,7 @@ ClientSet = SET_CLIENT:New():FilterActive( false ):FilterCoalition( "blue" ):Fil

    SET_CLIENT:ForEachClient(IteratorFunction, ...)

    -

    Iterate the SET_CLIENT and call an iterator function for each alive CLIENT, providing the CLIENT and optional parameters.

    +

    Iterate the SET_CLIENT and call an interator function for each alive CLIENT, providing the CLIENT and optional parameters.

    @@ -29579,6 +31106,50 @@ DBObject = SET_CLIENT:New()
    + + + +
    + +
    +

    SET_CLIENT:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -29890,7 +31461,7 @@ DBObject = SET_CLIENT:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -30833,7 +32404,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -30982,6 +32553,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_CLIENT:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -34369,6 +35970,50 @@ BASE:TraceOnOff( false )
    +
    +

    SET_GROUP:Activate(Delay)

    +
    + +

    Activate late activated groups.

    + +
    +
    +

    Defined in:

    +
    +

    SET_GROUP

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    Delay in seconds.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_GROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    +

    SET_GROUP:AddGroup(group)

    @@ -34556,7 +36201,7 @@ BASE:TraceOnOff( false )
    -

    true if all the Wrapper.Group#GROUP are completely in the Core.Zone#ZONE, false otherwise

    +

    true if all the Wrapper.Group#GROUP are completly in the Core.Zone#ZONE, false otherwise

    @@ -34621,7 +36266,7 @@ end
    -

    true if at least one of the Wrapper.Group#GROUP is completely inside the Core.Zone#ZONE, false otherwise.

    +

    true if at least one of the Wrapper.Group#GROUP is completly inside the Core.Zone#ZONE, false otherwise.

    @@ -34686,7 +36331,7 @@ end
    -

    true if at least one of the Wrapper.Group#GROUP is partly or completely inside the Core.Zone#ZONE, false otherwise.

    +

    true if at least one of the Wrapper.Group#GROUP is partly or completly inside the Core.Zone#ZONE, false otherwise.

    @@ -34754,7 +36399,7 @@ end
    -

    true if at least one of the Wrapper.Group#GROUP is partly or completely inside the Core.Zone#ZONE, false otherwise.

    +

    true if at least one of the Wrapper.Group#GROUP is partly or completly inside the Core.Zone#ZONE, false otherwise.

    @@ -34963,7 +36608,7 @@ MESSAGE:New("There are " .. MySetGroup:CountUnitInZone(MyZone) .. " UNITs in the
    -

    (Optional) Include only active groups to the set. +

    (optional) Include only active groups to the set. Include inactive groups if you provide false.

    @@ -35364,6 +37009,50 @@ GroupSet = SET_GROUP:New():FilterActive( false ):FilterCoalition( "blue" ):Filte + + + +
    + +
    +

    SET_GROUP:FilterZones(Zones)

    +
    + +

    Builds a set of groups in zones.

    + +
    +
    +

    Defined in:

    +
    +

    SET_GROUP

    +
    +

    Parameter:

    +
    +
    +

    + #table + Zones +

    +
    +
    + +

    Table of Core.Zone#ZONE Zone objects, or a Core.Set#SET_ZONE

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_GROUP:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -36402,6 +38091,50 @@ MySetGroup:SetCargoBayWeightLimit() + + + +
    + +
    +

    SET_GROUP:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -36713,7 +38446,7 @@ MySetGroup:SetCargoBayWeightLimit()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -37656,7 +39389,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -37805,6 +39538,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_GROUP:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -41151,6 +42914,6121 @@ BASE:TraceOnOff( false ) +

    TODO: Complete DCS#Event structure.
    +- The main event handling function... This function captures all events generated for the class. + @param #BASE self + @param DCS#Event event

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + event +

    +
    +
    +

    +
    +
    +
    + +
    + + + + + +

    Type SET_OPSGROUP

    +
    +
    +
    +

    Field(s)

    +
    +
    +

    Function(s)

    +
    +
    + +
    +

    SET_OPSGROUP:Activate(Delay)

    +
    + +

    Activate late activated groups in the set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #number + Delay +

    +
    +
    + +

    Delay in seconds.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Add(ObjectName, Object)

    +
    + +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using a given ObjectName as the index.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameters:

    +
    +
    +

    + #string + ObjectName +

    +
    +
    + +

    The name of the object.

    + +
    +
    +
    +
    +

    + Core.Base#BASE + Object +

    +
    +
    + +

    The object itself.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:AddGroup(group)

    +
    + +

    Add a GROUP or OPSGROUP object to the set.

    + + +

    NOTE that an OPSGROUP is automatically created from the GROUP if it does not exist already.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Wrapper.Group#GROUP + group +

    +
    +
    + +

    The GROUP which should be added to the set. Can also be given as an #OPSGROUP object.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:AddGroupsByName(AddGroupNames)

    +
    + +

    Add GROUP(s) or OPSGROUP(s) to the set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + AddGroupNames +

    +
    +
    + +

    A single name or an array of GROUP names.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:AddInDatabase(Event)

    +
    + +

    Handles the Database to check on an event (birth) that the Object was added in the Database.

    + + +

    This is required, because sometimes the DATABASE birth event gets called later than the SETBASE birth event!

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + Event +

    +
    +
    +

    +
    +
    +

    Return values:

    +
    +
    +

    #string:

    +
    +
    + +

    The name of the GROUP

    + +
    +
    +

    #table:

    +
    +
    + +

    The GROUP

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterActive(Active)

    +
    + +

    Builds a set of groups that are only active.

    + + +

    Only the groups that are active will be included within the set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #boolean + Active +

    +
    +
    + +

    (optional) Include only active groups to the set. +Include inactive groups if you provide false.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +

    Usage:

    + 
    
+-- Include only active groups to the set.
+GroupSet = SET_OPSGROUP:New():FilterActive():FilterStart()
+
+-- Include only active groups to the set of the blue coalition, and filter one time.
+GroupSet = SET_OPSGROUP:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
+
+-- Include only active groups to the set of the blue coalition, and filter one time.
+-- Later, reset to include back inactive groups to the set.
+GroupSet = SET_OPSGROUP:New():FilterActive():FilterCoalition( "blue" ):FilterOnce()
+... logic ...
+GroupSet = SET_OPSGROUP:New():FilterActive( false ):FilterCoalition( "blue" ):FilterOnce()
+
    + +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategories(Categories)

    +
    + +

    Builds a set of groups out of categories.

    + + + +

    Possible current categories are:

    + +
      +
    • "plane" for fixed wing groups
      • +
    • "helicopter" for rotary wing groups
      • +
    • "ground" for ground groups
      • +
    • "ship" for naval groups
      • +
    + + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + Categories +

    +
    +
    + +

    Can take the following values: "plane", "helicopter", "ground", "ship" or combinations as a table, for example {"plane", "helicopter"}.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategoryAircraft()

    +
    + +

    Builds a set of groups out of aicraft category (planes and helicopters).

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategoryAirplane()

    +
    + +

    Builds a set of groups out of airplane category.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategoryGround()

    +
    + +

    Builds a set of groups out of ground category.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategoryHelicopter()

    +
    + +

    Builds a set of groups out of helicopter category.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCategoryShip()

    +
    + +

    Builds a set of groups out of ship category.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCoalitions(Coalitions)

    +
    + +

    Builds a set of groups of coalitions.

    + + +

    Possible current coalitions are red, blue and neutral.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + Coalitions +

    +
    +
    + +

    Can take the following values: "red", "blue", "neutral" or combinations as a table, for example {"red", "neutral"}.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCountries(Countries)

    +
    + +

    Builds a set of groups of defined countries.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + Countries +

    +
    +
    + +

    Can take those country strings known within DCS world.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterPrefixes(Prefixes)

    +
    + +

    Builds a set of groups that contain the given string in their group name.

    + + +

    Attention! Bad naming convention as this does not filter only prefixes but all groups that contain the string.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + Prefixes +

    +
    +
    + +

    The string pattern(s) that needs to be contained in the group name. Can also be passed as a #table of strings.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterStart()

    +
    + +

    Starts the filtering.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindArmyGroup(GroupName)

    +
    + +

    Finds a ARMYGROUP based on the group name.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + GroupName +

    +
    +
    + +

    Name of the group.

    + +
    +
    +

    Return value:

    +
    +
    +

    Ops.ArmyGroup#ARMYGROUP:

    +
    +
    + +

    The found ARMYGROUP or #nil if the group is not in the set.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindFlightGroup(GroupName)

    +
    + +

    Finds a FLIGHTGROUP based on the group name.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + GroupName +

    +
    +
    + +

    Name of the group.

    + +
    +
    +

    Return value:

    +
    +
    +

    Ops.FlightGroup#FLIGHTGROUP:

    +
    +
    + +

    The found FLIGHTGROUP or #nil if the group is not in the set.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindGroup(GroupName)

    +
    + +

    Finds an OPSGROUP based on the group name.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + GroupName +

    +
    +
    + +

    Name of the group.

    + +
    +
    +

    Return value:

    +
    +
    +

    Ops.OpsGroup#OPSGROUP:

    +
    +
    + +

    The found OPSGROUP (FLIGHTGROUP, ARMYGROUP or NAVYGROUP) or #nil if the group is not in the set.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindInDatabase(Event)

    +
    + +

    Handles the Database to check on any event that Object exists in the Database.

    + + +

    This is required, because sometimes the DATABASE event gets called later than the SETBASE event or vise versa!

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + Event +

    +
    +
    + +

    Event data table.

    + +
    +
    +

    Return values:

    +
    +
    +

    #string:

    +
    +
    + +

    The name of the GROUP

    + +
    +
    +

    #table:

    +
    +
    + +

    The GROUP

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindNavyGroup(GroupName)

    +
    + +

    Finds a NAVYGROUP based on the group name.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + #string + GroupName +

    +
    +
    + +

    Name of the group.

    + +
    +
    +

    Return value:

    +
    +
    +

    Ops.NavyGroup#NAVYGROUP:

    +
    +
    + +

    The found NAVYGROUP or #nil if the group is not in the set.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ForEachGroup(IteratorFunction, ...)

    +
    + +

    Iterate the set and call an iterator function for each OPSGROUP object.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameters:

    +
    +
    +

    + #function + IteratorFunction +

    +
    +
    + +

    The function that will be called for all OPSGROUPs in the set. NOTE that the function must have the OPSGROUP as first parameter!

    + +
    +
    +
    +
    +

    + ... +

    +
    +
    + +

    (Optional) arguments passed to the IteratorFunction.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetAliveSet()

    +
    + +

    Gets the Set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:IsIncludeObject(MGroup)

    +
    + +

    Check include object.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Wrapper.Group#GROUP + MGroup +

    +
    +
    + +

    The group that is checked for inclusion.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:New()

    +
    + +

    Creates a new SET_OPSGROUP object, building a set of groups belonging to a coalitions, categories, countries, types or with defined prefix names.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Return value:

    +
    +
    +

    #SET_OPSGROUP:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:RemoveGroupsByName(RemoveGroupNames)

    +
    + +

    Remove GROUP(s) or OPSGROUP(s) from the set.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Wrapper.Group#GROUP + RemoveGroupNames +

    +
    +
    + +

    A single name or an array of GROUP names.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_OPSGROUP:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_EventOnDeadOrCrash(Event)

    +
    + +

    Handles the OnDead or OnCrash event for alive groups set.

    + + +

    Note: The GROUP object in the SET_OPSGROUP collection will only be removed if the last unit is destroyed of the GROUP.

    + +
    +
    +

    Defined in:

    +
    +

    SET_OPSGROUP

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + Event +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    +

    Field(s)

    +
    +
    +

    Function(s)

    +
    +
    + +
    +

    SET_OPSGROUP:Add(ObjectName, Object)

    +
    + +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using a given ObjectName as the index.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #string + ObjectName +

    +
    +
    + +

    The name of the object.

    + +
    +
    +
    +
    +

    + Core.Base#BASE + Object +

    +
    +
    + +

    The object itself.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:AddObject(Object)

    +
    + +

    Adds a Core.Base#BASE object in the Core.Set#SET_BASE, using the Object Name as the index.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Wrapper.Object#OBJECT + Object +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Clear()

    +
    + +

    Clear the Objects in the Set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CompareSets(SetA, SetB)

    +
    + +

    Compare two sets.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + Core.Set#SET_BASE + SetA +

    +
    +
    + +

    First set.

    + +
    +
    +
    +
    +

    + Core.Set#SET_BASE + SetB +

    +
    +
    + +

    Set to be merged into first set.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_BASE:

    +
    +
    + +

    The set of objects that are included in SetA and SetB.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Count()

    +
    + +

    Retrieves the amount of objects in the Core.Set#SET_BASE and derived classes.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    Count

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterCrashes()

    +
    + +

    Starts the filtering of the Crash events for the collection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterDeads()

    +
    + +

    Starts the filtering of the Dead events for the collection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterOnce()

    +
    + +

    Filters for the defined collection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FilterStop()

    +
    + +

    Stops the filtering for the defined collection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:FindNearestObjectFromPointVec2(PointVec2)

    +
    + +

    Iterate the SET_BASE while identifying the nearest object from a Core.Point#POINT_VEC2.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Point#POINT_VEC2 + PointVec2 +

    +
    +
    + +

    A Core.Point#POINT_VEC2 object from where to evaluate the closest object in the set.

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The closest object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Flush(MasterObject)

    +
    + +

    Flushes the current SET_BASE contents in the log ...

    + + +

    (for debugging reasons).

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Base#BASE + MasterObject +

    +
    +
    + +

    (optional) The master object as a reference.

    + +
    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    A string with the names of the objects.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ForEach(IteratorFunction, arg, Set, Function, FunctionArguments)

    +
    + +

    Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #function + IteratorFunction +

    +
    +
    + +

    The function that will be called.

    + +
    +
    +
    +
    +

    + #table + arg +

    +
    +
    + +

    Arguments of the IteratorFunction.

    + +
    +
    +
    +
    +

    + #SET_BASE + Set +

    +
    +
    + +

    (Optional) The set to use. Default self:GetSet().

    + +
    +
    +
    +
    +

    + #function + Function +

    +
    +
    + +

    (Optional) A function returning a #boolean true/false. Only if true, the IteratorFunction is called.

    + +
    +
    +
    +
    +

    + #table + FunctionArguments +

    +
    +
    + +

    (Optional) Function arguments.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ForSome(IteratorFunction, arg, Set, Function, FunctionArguments)

    +
    + +

    Iterate the SET_BASE and derived classes and call an iterator function for the given SET_BASE, providing the Object for each element within the set and optional parameters.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #function + IteratorFunction +

    +
    +
    + +

    The function that will be called.

    + +
    +
    +
    +
    +

    + arg +

    +
    +
    +

    +
    +
    +
    +
    +

    + Set +

    +
    +
    +

    +
    +
    +
    +
    +

    + Function +

    +
    +
    +

    +
    +
    +
    +
    +

    + FunctionArguments +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Get(ObjectName)

    +
    + +

    Gets a Core.Base#BASE object from the Core.Set#SET_BASE and derived classes, based on the Object Name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + #string + ObjectName +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetFirst()

    +
    + +

    Gets the first object from the Core.Set#SET_BASE and derived classes.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetLast()

    +
    + +

    Gets the last object from the Core.Set#SET_BASE and derived classes.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetObjectNames()

    +
    + +

    Gets a string with all the object names.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    A string with the names of the objects.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetRandom()

    +
    + +

    Gets a random object from the Core.Set#SET_BASE and derived classes.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSet()

    +
    + +

    Gets the Set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSetComplement(SetB)

    +
    + +

    Get the complement of two sets.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetB +

    +
    +
    + +

    Set other set, called B .

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_BASE:

    +
    +
    + +

    The set of objects that are in set B but not in this set A .

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSetIntersection(SetB)

    +
    + +

    Get the intersection of this set, called A , and another set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetB +

    +
    +
    + +

    Set other set, called B .

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_BASE:

    +
    +
    + +

    A set of objects that is included in set A and in set B .

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSetNames()

    +
    + +

    Gets a list of the Names of the Objects in the Set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSetObjects()

    +
    + +

    Gets a list of the Objects in the Set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSetUnion(SetB)

    +
    + +

    Get the union of two sets.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetB +

    +
    +
    + +

    Set B .

    + +
    +
    +

    Return value:

    +
    +
    +

    Core.Set#SET_BASE:

    +
    +
    + +

    The union set, i.e. contains objects that are in set A or in set B .

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetSomeIteratorLimit()

    +
    + +

    Get the SET iterator "limit".

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    Defines how many objects are evaluated of the set as part of the Some iterators.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:IsInSet(Object, ObjectName)

    +
    + +

    Decides whether to include the Object.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #table + Object +

    +
    +
    +

    +
    +
    +
    +
    +

    + ObjectName +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:IsIncludeObject(Object)

    +
    + +

    Decides whether to include the Object.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + #table + Object +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:New(Database)

    +
    + +

    Creates a new SET_BASE object, building a set of units belonging to a coalitions, categories, countries, types or with defined prefix names.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Database +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + + + +
    +
    +

    Usage:

    + 
    -- Define a new SET_BASE Object. This DBObject will contain a reference to all Group and Unit Templates defined within the ME and the DCSRTE.
+DBObject = SET_BASE:New()
    + +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnAfterAdded(From, Event, To, ObjectName, Object)

    +
    + +

    Added Handler OnAfter for SET_BASE

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + To +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + ObjectName +

    +
    +
    + +

    The name of the object.

    + +
    +
    +
    +
    +

    + Object +

    +
    +
    + +

    The object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnAfterRemoved(From, Event, To, ObjectName, Object)

    +
    + +

    Removed Handler OnAfter for SET_BASE

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #string + From +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + Event +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + To +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + ObjectName +

    +
    +
    + +

    The name of the object.

    + +
    +
    +
    +
    +

    + Object +

    +
    +
    + +

    The object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Remove(ObjectName, NoTriggerEvent)

    +
    + +

    Removes a Core.Base#BASE object from the Core.Set#SET_BASE and derived classes, based on the Object Name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #string + ObjectName +

    +
    +
    +

    +
    +
    +
    +
    +

    + NoTriggerEvent +

    +
    +
    + +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SetDatabase(BaseSet)

    +
    + +

    Copies the Filter criteria from a given Set (for rebuilding a new Set based on an existing Set).

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + #SET_BASE + BaseSet +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

    +
    + +

    Define the SET iterator "yield interval" and the "time interval".

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameters:

    +
    +
    +

    + #number + YieldInterval +

    +
    +
    + +

    Sets the frequency when the iterator loop will yield after the number of objects processed. The default frequency is 10 objects processed.

    + +
    +
    +
    +
    +

    + #number + TimeInterval +

    +
    +
    + +

    Sets the time in seconds when the main logic will resume the iterator loop. The default time is 0.001 seconds.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SetSomeIteratorLimit(Limit)

    +
    + +

    Define the SET iterator "limit".

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + #number + Limit +

    +
    +
    + +

    Defines how many objects are evaluated of the set as part of the Some iterators. The default is 1.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_EventOnBirth(Event)

    +
    + +

    Handles the OnBirth event for the Set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + Event +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_EventOnDeadOrCrash(Event)

    +
    + +

    Handles the OnDead or OnCrash event for alive units set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + Event +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_FilterStart()

    +
    + +

    Starts the filtering for the defined collection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_Find(ObjectName)

    +
    + +

    Finds an Core.Base#BASE object based on the object Name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + #string + ObjectName +

    +
    +
    +

    +
    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The Object found.

    + +
    +
    +
    + +
    +
    + +
    +

    Field(s)

    +
    +
    +

    Function(s)

    +
    +
    + +
    +

    SET_OPSGROUP:ClearState(Object, StateName)

    +
    + +

    Clear the state of an object.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that holds the Value set by the Key.

    + +
    +
    +
    +
    +

    + StateName +

    +
    +
    + +

    The key that is should be cleared.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventBirth(EventTime, Initiator, IniUnitName, place, subplace)

    +
    + +

    Creation of a Birth Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    +
    +

    + #string + IniUnitName +

    +
    +
    + +

    The initiating unit name.

    + +
    +
    +
    +
    +

    + place +

    +
    +
    +

    +
    +
    +
    +
    +

    + subplace +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventCrash(EventTime, Initiator)

    +
    + +

    Creation of a Crash Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventDead(EventTime, Initiator)

    +
    + +

    Creation of a Dead Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

    +
    + +

    Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Wrapper.Unit#UNIT + PlayerUnit +

    +
    +
    + +

    The aircraft unit the player entered.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventRemoveUnit(EventTime, Initiator)

    +
    + +

    Creation of a Remove Unit Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:CreateEventTakeoff(EventTime, Initiator)

    +
    + +

    Creation of a Takeoff Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + DCS#Time + EventTime +

    +
    +
    + +

    The time stamp of the event.

    + +
    +
    +
    +
    +

    + DCS#Object + Initiator +

    +
    +
    + +

    The initiating object of the event.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:E(Arguments)

    +
    + +

    Log an exception which will be traced always.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:EventDispatcher()

    +
    + +

    Returns the event dispatcher

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Event#EVENT:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:EventRemoveAll()

    +
    + +

    Remove all subscribed events

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:F(Arguments)

    +
    + +

    Trace a function call.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:F2(Arguments)

    +
    + +

    Trace a function call level 2.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:F3(Arguments)

    +
    + +

    Trace a function call level 3.

    + + +

    Must be at the beginning of the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetClassID()

    +
    + +

    Get the ClassID of the class instance.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassID of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetClassName()

    +
    + +

    Get the ClassName of the class instance.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassName of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetClassNameAndID()

    +
    + +

    Get the ClassName + ClassID of the class instance.

    + + +

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

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #string:

    +
    +
    + +

    The ClassName + ClassID of the class instance.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetEventPriority()

    +
    + +

    Get the Class 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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The Event processing Priority.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetParent(Child, FromClass)

    +
    + +

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

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + #BASE + Child +

    +
    +
    + +

    This is the Child class from which the Parent class needs to be retrieved.

    + +
    +
    +
    +
    +

    + #BASE + FromClass +

    +
    +
    + +

    (Optional) The class from which to get the parent.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:GetState(Object, Key)

    +
    + +

    Get a Value given a Key from the Object.

    + + +

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

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that holds the Value set by the Key.

    + +
    +
    +
    +
    +

    + Key +

    +
    +
    + +

    The key that is used to retrieve the value. Note that the key can be a #string, but it can also be any other type!

    + +
    +
    +

    Return value:

    +
    +
    +
    +
    + +

    The Value retrieved or nil if the Key was not found and thus the Value could not be retrieved.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:HandleEvent(EventID, EventFunction)

    +
    + +

    Subscribe to a DCS Event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Core.Event#EVENTS + EventID +

    +
    +
    + +

    Event ID.

    + +
    +
    +
    +
    +

    + #function + EventFunction +

    +
    +
    + +

    (optional) The function to be called when the event occurs for the unit.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:I(Arguments)

    +
    + +

    Log an information which will be traced always.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:Inherit(Child, Parent)

    +
    + +

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

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Child +

    +
    +
    + +

    is the Child class that inherits.

    + +
    +
    +
    +
    +

    + #BASE + Parent +

    +
    +
    + +

    is the Parent class that the Child inherits from.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + +

    Child

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:IsInstanceOf(ClassName)

    +
    + +

    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

      • +
    + + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + ClassName +

    +
    +
    + +

    is the name of the class or the class itself to run the check against

    + +
    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:IsTrace()

    +
    + +

    Enquires if tracing is on (for the class).

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #boolean:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:New()

    +
    + +

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

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEvent(EventData)

    +
    + +

    Occurs when an object is completely destroyed.

    + + +

    initiator : The unit that is was destroyed.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventBDA(EventData)

    +
    + +

    BDA.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventBaseCaptured(EventData)

    +
    + +

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

    + + +

    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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventBirth(EventData)

    +
    + +

    Occurs when any object is spawned into the mission.

    + + +

    initiator : The unit that was spawned

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventCrash(EventData)

    +
    + +

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

    + + +

    initiator : The unit that has crashed

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventDead(EventData)

    +
    + +

    Occurs when an object is dead.

    + + +

    initiator : The unit that is dead.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventDetailedFailure(EventData)

    +
    + +

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

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventDiscardChairAfterEjection(EventData)

    +
    + +

    Discard chair after ejection.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventEjection(EventData)

    +
    + +

    Occurs when a pilot ejects from an aircraft +initiator : The unit that has ejected

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventEngineShutdown(EventData)

    +
    + +

    Occurs when any aircraft shuts down its engines.

    + + +

    initiator : The unit that is stopping its engines.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventEngineStartup(EventData)

    +
    + +

    Occurs when any aircraft starts its engines.

    + + +

    initiator : The unit that is starting its engines.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventHit(EventData)

    +
    + +

    Occurs whenever an object is hit by a weapon.

    + + +

    initiator : The unit object the fired the weapon +weapon: Weapon object that hit the target +target: The Object that was hit.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventHumanFailure(EventData)

    +
    + +

    Occurs when any system fails on a human controlled aircraft.

    + + +

    initiator : The unit that had the failure

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventKill(EventData)

    +
    + +

    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.

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

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventLand(EventData)

    +
    + +

    Occurs when an aircraft lands at an airbase, farp or ship +initiator : The unit that has landed +place: Object that the unit landed on.

    + + +

    Can be an Airbase Object, FARP, or Ships

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventLandingAfterEjection(EventData)

    +
    + +

    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.

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

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventLandingQualityMark(EventData)

    +
    + +

    Landing quality mark.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventMarkAdded(EventData)

    +
    + +

    Occurs when a new mark was added.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventMarkChange(EventData)

    +
    + +

    Occurs when a mark text was changed.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventMarkRemoved(EventData)

    +
    + +

    Occurs when a mark was removed.

    + + +

    MarkID: ID of the mark.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventMissionEnd(EventData)

    +
    + +

    Occurs when a mission ends

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventMissionStart(EventData)

    +
    + +

    Occurs when a mission starts

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventParatrooperLanding(EventData)

    +
    + +

    Weapon add.

    + + +

    Fires when entering a mission per pylon with the name of the weapon (double pylons not counted, infinite wep reload not counted.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventPilotDead(EventData)

    +
    + +

    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. +initiator : The unit that the pilot has died in.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventPlayerEnterAircraft(EventData)

    +
    + +

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

    + + +

    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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventPlayerEnterUnit(EventData)

    +
    + +

    Occurs when any player assumes direct control of a unit.

    + + +

    initiator : The unit that is being taken control of.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventPlayerLeaveUnit(EventData)

    +
    + +

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

    + + +

    initiator : The unit that the player left.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventRefueling(EventData)

    +
    + +

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

    + + +

    initiator : The unit that is receiving fuel.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventRefuelingStop(EventData)

    +
    + +

    Occurs when an aircraft is finished taking fuel.

    + + +

    initiator : The unit that was receiving fuel.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventScore(EventData)

    +
    + +

    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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventShootingEnd(EventData)

    +
    + +

    Occurs when any unit stops firing its weapon.

    + + +

    Event will always correspond with a shooting start event. +initiator : The unit that was doing the shooting.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventShootingStart(EventData)

    +
    + +

    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. +initiator : The unit that is doing the shooting. +target: The unit that is being targeted.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventShot(EventData)

    +
    + +

    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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventTakeoff(EventData)

    +
    + +

    Occurs when an aircraft takes off from an airbase, farp, or ship.

    + + +

    initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventTriggerZone(EventData)

    +
    + +

    Trigger zone.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:OnEventUnitLost(EventData)

    +
    + +

    Occurs when the game thinks an object is destroyed.

    + + + +
      +
    • initiator: The unit that is was destroyed.
      • +
    + + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTDATA + EventData +

    +
    +
    + +

    The EventData structure.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ScheduleOnce(Start, SchedulerFunction, ...)

    +
    + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + #number + Start +

    +
    +
    + +

    Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

    + +
    +
    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    +
    +

    + #table + ... +

    +
    +
    + +

    Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

    + +
    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The ScheduleID of the planned schedule.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ScheduleRepeat(Start, Repeat, RandomizeFactor, Stop, SchedulerFunction, ...)

    +
    + +

    Schedule a new time event.

    + + +

    Note that the schedule will only take place if the scheduler is started. Even for a single schedule event, the scheduler needs to be started also.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + #number + Start +

    +
    +
    + +

    Specifies the amount of seconds that will be waited before the scheduling is started, and the event function is called.

    + +
    +
    +
    +
    +

    + #number + Repeat +

    +
    +
    + +

    Specifies the interval in seconds when the scheduler will call the event function.

    + +
    +
    +
    +
    +

    + #number + RandomizeFactor +

    +
    +
    + +

    Specifies a randomization factor between 0 and 1 to randomize the Repeat.

    + +
    +
    +
    +
    +

    + #number + Stop +

    +
    +
    + +

    Specifies the amount of seconds when the scheduler will be stopped.

    + +
    +
    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    +
    +

    + #table + ... +

    +
    +
    + +

    Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.

    + +
    +
    +

    Return value:

    +
    +
    +

    #number:

    +
    +
    + +

    The ScheduleID of the planned schedule.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:ScheduleStop(SchedulerFunction)

    +
    + +

    Stops the Schedule.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #function + SchedulerFunction +

    +
    +
    + +

    The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in SchedulerArguments.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SetEventPriority(EventPriority)

    +
    + +

    Set the Class 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.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #number + EventPriority +

    +
    +
    + +

    The Event processing Priority.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + +

    self

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:SetState(Object, Key, Value)

    +
    + +

    Set a state or property of the Object given a Key and a Value.

    + + +

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

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Object +

    +
    +
    + +

    The object that will hold the Value set by the Key.

    + +
    +
    +
    +
    +

    + Key +

    +
    +
    + +

    The key that is used as a reference of the value. Note that the key can be a #string, but it can also be any other type!

    + +
    +
    +
    +
    +

    + Value +

    +
    +
    + +

    The value to is stored in the object.

    + +
    +
    +

    Return value:

    +
    +
    +
    +
    + +

    The Value set.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:T(Arguments)

    +
    + +

    Trace a function logic level 1.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:T2(Arguments)

    +
    + +

    Trace a function logic level 2.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:T3(Arguments)

    +
    + +

    Trace a function logic level 3.

    + + +

    Can be anywhere within the function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceAll(TraceAll)

    +
    + +

    Trace all methods in MOOSE

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #boolean + TraceAll +

    +
    +
    + +

    true = trace all methods in MOOSE.

    + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceClass(Class)

    +
    + +

    Set tracing for a class

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #string + Class +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceClassMethod(Class, Method)

    +
    + +

    Set tracing for a specific method of class

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + #string + Class +

    +
    +
    +

    +
    +
    +
    +
    +

    + #string + Method +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceLevel(Level)

    +
    + +

    Set trace level

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #number + Level +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceOff()

    +
    + +

    Set trace off.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Usage:

    + 
    -- Switch the tracing Off
+BASE:TraceOff()
    + +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceOn()

    +
    + +

    Set trace on.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Usage:

    + 
    -- Switch the tracing On
+BASE:TraceOn()
    + +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:TraceOnOff(TraceOnOff)

    +
    + +

    Set trace on or off +Note that when trace is off, no BASE.Debug statement is performed, increasing performance! +When Moose is loaded statically, (as one file), tracing is switched off by default.

    + + +

    So tracing must be switched on manually in your mission if you are using Moose statically. +When moose is loading dynamically (for moose class development), tracing is switched on by default.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + #boolean + TraceOnOff +

    +
    +
    + +

    Switch the tracing on or off.

    + +
    +
    +

    Usage:

    + 
    -- Switch the tracing On
+BASE:TraceOnOff( true )
+
+-- Switch the tracing Off
+BASE:TraceOnOff( false )
    + +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:UnHandleEvent(EventID)

    +
    + +

    UnSubscribe to a DCS event.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Event#EVENTS + EventID +

    +
    +
    + +

    Event ID.

    + +
    +
    +

    Return value:

    +
    +
    +

    #BASE:

    +
    +
    + + + +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    +
    + +

    Trace a function call.

    + + +

    This function is private.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    +
    +

    + DebugInfoCurrentParam +

    +
    +
    +

    +
    +
    +
    +
    +

    + DebugInfoFromParam +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

    +
    + +

    Trace a function logic.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Base#BASE

    +
    +

    Parameters:

    +
    +
    +

    + Arguments +

    +
    +
    + +

    A #table or any field.

    + +
    +
    +
    +
    +

    + DebugInfoCurrentParam +

    +
    +
    +

    +
    +
    +
    +
    +

    + DebugInfoFromParam +

    +
    +
    +

    +
    +
    +
    + +
    +
    + +
    + +
    +

    SET_OPSGROUP:onEvent(event)

    +
    + + + +

    TODO: Complete DCS#Event structure.
    - The main event handling function... This function captures all events generated for the class. @param #BASE self @@ -41548,6 +49426,50 @@ BASE:TraceOnOff( false )

    +
    + + +
    + +
    +

    SET_PLAYER:FilterZones(Zones)

    +
    + +

    Builds a set of players in zones.

    + +
    +
    +

    Defined in:

    +
    +

    SET_PLAYER

    +
    +

    Parameter:

    +
    +
    +

    + #table + Zones +

    +
    +
    + +

    Table of Core.Zone#ZONE Zone objects, or a Core.Set#SET_ZONE

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_PLAYER:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -41652,7 +49574,7 @@ BASE:TraceOnOff( false )

    SET_PLAYER:ForEachPlayer(IteratorFunction, ...)

    -

    Iterate the SET_PLAYER and call an iterator function for each alive CLIENT, providing the CLIENT and optional parameters.

    +

    Iterate the SET_PLAYER and call an interator function for each alive CLIENT, providing the CLIENT and optional parameters.

    @@ -42055,6 +49977,50 @@ DBObject = SET_PLAYER:New()
    + + + +
    + +
    +

    SET_PLAYER:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -42366,7 +50332,7 @@ DBObject = SET_PLAYER:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -43309,7 +51275,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -43458,6 +51424,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_PLAYER:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -47306,6 +55302,50 @@ BASE:TraceOnOff( false ) + + + +
    + +
    +

    SET_STATIC:FilterZones(Zones)

    +
    + +

    Builds a set of statics in zones.

    + +
    +
    +

    Defined in:

    +
    +

    SET_STATIC

    +
    +

    Parameter:

    +
    +
    +

    + #table + Zones +

    +
    +
    + +

    Table of Core.Zone#ZONE Zone objects, or a Core.Set#SET_ZONE

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_STATIC:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -47410,7 +55450,7 @@ BASE:TraceOnOff( false )

    SET_STATIC:ForEachStatic(IteratorFunction, ...)

    -

    Iterate the SET_STATIC and call an iterator function for each alive STATIC, providing the STATIC and optional parameters.

    +

    Iterate the SET_STATIC and call an interator function for each alive STATIC, providing the STATIC and optional parameters.

    @@ -47820,7 +55860,7 @@ BASE:TraceOnOff( false )
    -

    (Optional) The delimiter, which is default a comma.

    +

    (optional) The delimiter, which is default a comma.

    @@ -48189,6 +56229,50 @@ DBObject = SET_STATIC:New() + + + +
    + +
    +

    SET_STATIC:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -48500,7 +56584,7 @@ DBObject = SET_STATIC:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -49443,7 +57527,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -49592,6 +57676,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_STATIC:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -53124,7 +61238,7 @@ BASE:TraceOnOff( false )

    SET_UNIT:CalculateThreatLevelA2G()

    -

    Calculate the maximum A2G threat level of the SET_UNIT.

    +

    Calculate the maxium A2G threat level of the SET_UNIT.

    @@ -53205,7 +61319,7 @@ BASE:TraceOnOff( false )
    -

    (Optional) Include only active units to the set. +

    (optional) Include only active units to the set. Include inactive units if you provide false.

    @@ -53580,6 +61694,50 @@ UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterO
    + + + +
    + +
    +

    SET_UNIT:FilterZones(Zones)

    +
    + +

    Builds a set of units in zones.

    + +
    +
    +

    Defined in:

    +
    +

    SET_UNIT

    +
    +

    Parameter:

    +
    +
    +

    + #table + Zones +

    +
    +
    + +

    Table of Core.Zone#ZONE Zone objects, or a Core.Set#SET_ZONE

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_UNIT:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -53684,7 +61842,7 @@ UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterO

    SET_UNIT:ForEachUnit(IteratorFunction, ...)

    -

    Iterate the SET_UNIT and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

    +

    Iterate the SET_UNIT and call an interator function for each alive UNIT, providing the UNIT and optional parameters.

    @@ -53872,7 +62030,7 @@ UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterO

    SET_UNIT:ForEachUnitPerThreatLevel(FromThreatLevel, ToThreatLevel, IteratorFunction, ...)

    -

    Iterate the SET_UNIT sorted *per Threat Level and call an iterator function for each alive UNIT, providing the UNIT and optional parameters.

    +

    Iterate the SET_UNIT sorted *per Threat Level and call an interator function for each alive UNIT, providing the UNIT and optional parameters.

    @@ -54100,6 +62258,10 @@ UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterO
    +

    Usage:

    + 
    
+
    + @@ -54129,7 +62291,7 @@ UnitSet = SET_UNIT:New():FilterActive( false ):FilterCoalition( "blue" ):FilterO
    -

    (Optional) The delimiter, which is default a comma.

    +

    (optional) The delimiter, which is default a comma.

    @@ -54786,6 +62948,50 @@ MySetUnit:SetCargoBayWeightLimit() + + + +
    + +
    +

    SET_UNIT:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -55097,7 +63303,7 @@ MySetUnit:SetCargoBayWeightLimit()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -56040,7 +64246,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -56189,6 +64395,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_UNIT:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -59921,7 +68157,7 @@ BASE:TraceOnOff( false )

    SET_ZONE:ForEachZone(IteratorFunction, ...)

    -

    Iterate the SET_ZONE and call an iterator function for each ZONE, providing the ZONE and optional parameters.

    +

    Iterate the SET_ZONE and call an interator function for each ZONE, providing the ZONE and optional parameters.

    @@ -60403,6 +68639,50 @@ DatabaseSet = SET_ZONE:New()
    + + + +
    + +
    +

    SET_ZONE:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -60714,7 +68994,7 @@ DatabaseSet = SET_ZONE:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -61657,7 +69937,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -61806,6 +70086,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_ZONE:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    @@ -65495,7 +73805,7 @@ BASE:TraceOnOff( false )

    SET_ZONE_GOAL:ForEachZone(IteratorFunction, ...)

    -

    Iterate the SET_ZONE_GOAL and call an iterator function for each ZONE, providing the ZONE and optional parameters.

    +

    Iterate the SET_ZONE_GOAL and call an interator function for each ZONE, providing the ZONE and optional parameters.

    @@ -65963,6 +74273,50 @@ DatabaseSet = SET_ZONE_GOAL:New()
    + + + +
    + +
    +

    SET_ZONE_GOAL:AddSet(SetToAdd)

    +
    + +

    Add a SET to this set.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Parameter:

    +
    +
    +

    + Core.Set#SET_BASE + SetToAdd +

    +
    +
    + +

    Set to add.

    + +
    +
    +

    Return value:

    +
    +
    +

    #SET_BASE:

    +
    +
    + +

    self

    + +
    +
    +
    +
    @@ -66274,7 +74628,7 @@ DatabaseSet = SET_ZONE_GOAL:New()
    -

    (Optional) The master object as a reference.

    +

    (optional) The master object as a reference.

    @@ -67217,7 +75571,7 @@ DBObject = SET_BASE:New()
    -

    (Optional) When true, the :Remove() method will not trigger a Removed event.

    +

    (optional) When true, the :Remove() method will not trigger a Removed event.

    @@ -67366,6 +75720,36 @@ DBObject = SET_BASE:New() + + + +
    + +
    +

    SET_ZONE_GOAL:SortByName()

    +
    + +

    Sort the set by name.

    + +
    +
    +

    Defined in:

    +
    +

    Core.Set#SET_BASE

    +
    +

    Return value:

    +
    +
    +

    Core.Base#BASE:

    +
    +
    + +

    The added BASE Object.

    + +
    +
    +
    +
    diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 212afbd1b..afc2d0660 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2730,12 +2730,6 @@ and any spaces before and after the resulting name are removed.

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

    - - - -

    SPAWN.uncontrolled

    - - @@ -3368,9 +3362,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

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

    - @@ -3531,17 +3522,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - -SPAWN.SpawnInitFreq - - -
    @@ -3597,20 +3577,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

    Overwrite unit names by default with group name.

    -
    @@ -3838,17 +3804,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - #boolean -SPAWN.SpawnUnControlled - - -
    @@ -3861,7 +3816,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

    +

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

    @@ -3913,17 +3868,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

    - - - -
    -
    - - -SPAWN.uncontrolled - - -
    @@ -8743,9 +8687,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

    - @@ -8906,17 +8847,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - - -
    -
    - - -SPAWN.SpawnInitFreq - - -
    @@ -8972,20 +8902,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - - -
    -
    - - #boolean -SPAWN.SpawnInitKeepUnitNames - - - - -

    Overwrite unit names by default with group name.

    -
    @@ -9213,17 +9129,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    - - -
    -
    - - #boolean -SPAWN.SpawnUnControlled - - -
    @@ -9236,7 +9141,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

    +

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

    @@ -9288,17 +9193,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

    When working in UnControlled mode, all planes are Spawned in UnControlled mode before the scheduler starts.

    - - - -
    -
    - - -SPAWN.uncontrolled - - -
    diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index db52a7d8f..3b4bd5359 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1865,6 +1865,24 @@ such as position and heading.

    SPAWNSTATIC:_SpawnStatic(Template, CountryID)

    Spawns a new static using a given template.

    + + + +

    SPAWNSTATIC.heliport_callsign_id

    + + + + + +

    SPAWNSTATIC.heliport_frequency

    + + + + + +

    SPAWNSTATIC.heliport_modulation

    + + @@ -2772,6 +2790,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPAWNSTATIC.heliport_callsign_id + + + +
    + +
    +
    +
    + + +SPAWNSTATIC.heliport_frequency + + + +
    + +
    +
    +
    + + +SPAWNSTATIC.heliport_modulation + + +
    @@ -3993,6 +4044,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
    +
    + + +SPAWNSTATIC.heliport_callsign_id + + + +
    + +
    +
    +
    + + +SPAWNSTATIC.heliport_frequency + + + +
    + +
    +
    +
    + + +SPAWNSTATIC.heliport_modulation + + +
    diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 4c32169c9..7c6128ced 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -3434,17 +3434,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
    -
    - - #table -DESIGNATE.LaserCodes - - -
    @@ -6602,17 +6591,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - #table -DESIGNATE.LaserCodes - - -
    @@ -7412,17 +7390,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - #table -DESIGNATE.LaserCodes - - -
    @@ -8192,17 +8159,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - #table -DESIGNATE.LaserCodes - - -
    @@ -9864,17 +9820,6 @@ Designate:SetFlashStatusMenu( false ) - - - -
    -
    - - #table -DESIGNATE.LaserCodes - - -
    diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index 8bd66b46a..89db36d85 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -18775,17 +18775,6 @@ BASE:TraceOnOff( false ) - - - -
    -
    - - #number -DETECTION_BASE.DetectedItemMax - - -
    @@ -18935,18 +18924,7 @@ BASE:TraceOnOff( false )
    - #boolean -DETECTION_BASE.Locking - - -
    - -
    -
    -
    - - #number DETECTION_BASE.RefreshTimeInterval @@ -23488,17 +23466,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
    - -
    -
    -
    - - #number -DETECTION_BASE.DetectedItemMax - - -
    @@ -23648,18 +23615,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - #boolean -DETECTION_BASE.Locking - - -
    - -
    -
    -
    - - #number DETECTION_BASE.RefreshTimeInterval @@ -25256,17 +25212,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual -
    - -
    -
    -
    - - #number -DETECTION_BASE.DetectedItemMax - - -
    @@ -25416,18 +25361,7 @@ zones that reflect cloudy areas where detected units may not be so easily visual
    - #boolean -DETECTION_BASE.Locking - - -
    - -
    -
    -
    - - #number DETECTION_BASE.RefreshTimeInterval diff --git a/Documentation/Functional.Rat.html b/Documentation/Functional.Rat.html index eead7ce23..be556463f 100644 --- a/Documentation/Functional.Rat.html +++ b/Documentation/Functional.Rat.html @@ -4318,12 +4318,6 @@ and any spaces before and after the resulting name are removed.

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

    - - - -

    RAT.uncontrolled

    - - diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index a55b7d2aa..5d1b1512c 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9208,17 +9208,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Radio queue of LSO.

    -
    - -
    -
    -
    - - -AIRBOSS.RQLid - - -
    @@ -9230,17 +9219,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    Radio queue of marshal.

    - - - -
    -
    - - -AIRBOSS.RQMid - - -
    @@ -28424,17 +28402,6 @@ If removed flight is the section lead, we try to find a new leader.

    Radio queue of LSO.

    - - - -
    -
    - - -AIRBOSS.RQLid - - -
    @@ -28446,17 +28413,6 @@ If removed flight is the section lead, we try to find a new leader.

    Radio queue of marshal.

    - - - -
    -
    - - -AIRBOSS.RQMid - - -
    @@ -31427,17 +31383,6 @@ If removed flight is the section lead, we try to find a new leader.

    Radio queue of LSO.

    - - - -
    -
    - - -AIRBOSS.RQLid - - -
    @@ -31449,17 +31394,6 @@ If removed flight is the section lead, we try to find a new leader.

    Radio queue of marshal.

    - - - -
    -
    - - -AIRBOSS.RQMid - - -
    @@ -38779,6 +38713,9 @@ BASE:TraceOnOff( false ) + +

    Set case to that of lead.

    + @@ -38836,6 +38773,20 @@ BASE:TraceOnOff( false ) + +
    +
    + + +AIRBOSS.PlayerData.flag + + + + +

    Set stack flag.

    + +
    +
    @@ -39002,6 +38953,9 @@ BASE:TraceOnOff( false ) + +

    Set Stable Hover

    +
    @@ -39035,9 +38989,6 @@ BASE:TraceOnOff( false ) - -

    Set new time stamp.

    - diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 77b2e89f0..59f3849f9 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -2264,12 +2264,6 @@ Create a late-activated single infantry unit as template in the mission editor a

    CSAR.inTransitGroups

    - - - -

    CSAR.index

    - - @@ -3524,7 +3518,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.FreeVHFFrequencies @@ -3613,11 +3607,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -3809,11 +3806,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -3834,11 +3834,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -3937,17 +3951,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    contain a table for each SAR with all units he has with the original names

    -
    - -
    -
    -
    - - -CSAR.index - - -
    @@ -4145,6 +4148,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -4170,6 +4187,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    @@ -8241,7 +8272,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.FreeVHFFrequencies @@ -8330,11 +8361,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -8526,11 +8560,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -8551,11 +8588,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -8654,17 +8705,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    contain a table for each SAR with all units he has with the original names

    -
    - -
    -
    -
    - - -CSAR.index - - -
    @@ -8862,6 +8902,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -8887,6 +8941,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    @@ -10490,7 +10558,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.FreeVHFFrequencies @@ -10579,11 +10647,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.allheligroupset + +

    GROUP_SET of all helis

    +
    @@ -10775,11 +10846,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.csarUnits + +

    table of CSAR unit names

    +
    @@ -10800,11 +10874,25 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #table CSAR.downedPilots + +

    Replacement woundedGroups

    + +
    + +
    +
    +
    + + #number +CSAR.downedpilotcounter + + +
    @@ -10903,17 +10991,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    contain a table for each SAR with all units he has with the original names

    -
    - -
    -
    -
    - - -CSAR.index - - -
    @@ -11111,6 +11188,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescuedpilots + + + + +

    counter for saved pilots

    + +
    +
    @@ -11136,6 +11227,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + #number +CSAR.rescues + + + + +

    counter for successful rescue landings at FARP/AFB/MASH

    + +
    +
    diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index db5ef9cc2..fc9a01879 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -1669,7 +1669,9 @@ Create the late-activated troops, vehicles (no statics at this point!) that will my_ctld.cratecountry = country.id.GERMANY -- ID of crates. Will default to country.id.RUSSIA for RED coalition setups. my_ctld.allowcratepickupagain = true -- allow re-pickup crates that were dropped. my_ctld.enableslingload = false -- allow cargos to be slingloaded - might not work for all cargo types - my_ctld.pilotmustopendoors = false -- -- force opening of doors + my_ctld.pilotmustopendoors = false -- force opening of doors + my_ctld.SmokeColor = SMOKECOLOR.Red -- color to use when dropping smoke from heli + my_ctld.FlareColor = FLARECOLOR.Red -- color to use when flaring from heli

    2.1 User functions

    @@ -1825,7 +1827,7 @@ Create the late-activated troops, vehicles (no statics at this point!) that will

    4.1 Manage Crates

    -

    Use this entry to get, load, list nearby, drop, build and repair crates. Also @see options.

    +

    Use this entry to get, load, list nearby, drop, build and repair crates. Also see options.

    4.2 Manage Troops

    @@ -1836,7 +1838,7 @@ Currently limited CTLD_CARGO troops, which are build from one t

    Lists what you have loaded. Shows load capabilities for number of crates and number of seats for troops.

    -

    4.4 Smoke & Flare zones nearby

    +

    4.4 Smoke & Flare zones nearby or drop smoke or flare from Heli

    Does what it says.

    @@ -2165,6 +2167,12 @@ If you use units build by multiple templates, they will effectively double on lo

    CTLD.ExtractFactor

    + + + +

    CTLD.FlareColor

    + + @@ -2417,12 +2425,24 @@ If you use units build by multiple templates, they will effectively double on lo

    CTLD:RemoveStockTroops(Name, Number)

    User - function to remove stock of a certain troops type

    + + + +

    CTLD.SmokeColor

    + + + + + +

    CTLD:SmokePositionNow(Unit, Flare)

    + +

    User function - Drop a smoke or flare at current location.

    CTLD:SmokeZoneNearBy(Unit, Flare)

    -

    User function - Start smoke in a zone close to the Unit.

    +

    User function - Start smoke/flare in a zone close to the Unit.

    @@ -5612,7 +5632,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -5634,7 +5654,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.DroppedTroops @@ -5659,28 +5679,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #number -CTLD.Engineers - - - -

    use as counter

    - -
    - -
    -
    -
    - - #table CTLD.EngineersInField - -

    holds #CTLD_ENGINEERING objects

    -
    @@ -5695,6 +5698,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    factor for troops extraction, i.e. CrateDistance * Extractfactor

    +
    + +
    +
    +
    + + +CTLD.FlareColor + + +
    @@ -5853,14 +5867,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.PilotGroups - -

    tables

    -
    @@ -5888,6 +5899,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + +CTLD.SmokeColor + + + + +

    Smokes and Flares

    + +
    +
    @@ -6255,7 +6280,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    time to repair a unit/group

    +

    noob catch

    @@ -9049,6 +9074,52 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    + + +
    + +
    +

    CTLD:SmokePositionNow(Unit, Flare)

    +
    + +

    User function - Drop a smoke or flare at current location.

    + +
    +
    +

    Defined in:

    +
    +

    CTLD

    +
    +

    Parameters:

    +
    +
    +

    + Wrapper.Unit#UNIT + Unit +

    +
    +
    + +

    The Unit.

    + +
    +
    +
    +
    +

    + #boolean + Flare +

    +
    +
    + +

    If true, flare instead.

    + +
    +
    +
    +
    @@ -9058,7 +9129,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    CTLD:SmokeZoneNearBy(Unit, Flare)

    -

    User function - Start smoke in a zone close to the Unit.

    +

    User function - Start smoke/flare in a zone close to the Unit.

    @@ -12682,7 +12753,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -12704,7 +12775,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.DroppedTroops @@ -12729,28 +12800,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #number -CTLD.Engineers - - - -

    use as counter

    - -
    - -
    -
    -
    - - #table CTLD.EngineersInField - -

    holds #CTLD_ENGINEERING objects

    -
    @@ -12765,6 +12819,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    factor for troops extraction, i.e. CrateDistance * Extractfactor

    +
    + +
    +
    +
    + + +CTLD.FlareColor + + +
    @@ -12923,14 +12988,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.PilotGroups - -

    tables

    -
    @@ -12958,6 +13020,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + +CTLD.SmokeColor + + + + +

    Smokes and Flares

    + +
    +
    @@ -13325,7 +13401,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    time to repair a unit/group

    +

    noob catch

    @@ -14970,7 +15046,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.CtldUnits @@ -14992,7 +15068,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.DroppedTroops @@ -15017,28 +15093,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #number -CTLD.Engineers - - - -

    use as counter

    - -
    - -
    -
    -
    - - #table CTLD.EngineersInField - -

    holds #CTLD_ENGINEERING objects

    -
    @@ -15053,6 +15112,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

    factor for troops extraction, i.e. CrateDistance * Extractfactor

    +
    + +
    +
    +
    + + +CTLD.FlareColor + + +
    @@ -15211,14 +15281,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + CTLD.PilotGroups - -

    tables

    -
    @@ -15246,6 +15313,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    +
    +
    +
    + + +CTLD.SmokeColor + + + + +

    Smokes and Flares

    + +
    +
    @@ -15613,7 +15694,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    time to repair a unit/group

    +

    noob catch

    @@ -19407,6 +19488,17 @@ BASE:TraceOnOff( false )

    Can transport crate.

    +
    + +
    +
    +
    + + #number +CTLD.UnitCapabilities.length + + +
    diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index f60e7a0cf..56ee56fae 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2820,17 +2820,6 @@ but can separately be modified later in your mission using the -
    - -
    -
    -
    - - -TASK.TaskControlMenu - - -
    @@ -7467,17 +7456,6 @@ If the Unit is part of the Task, true is returned.

    - - - -
    -
    - - -TASK.TaskControlMenu - - -
    diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index 3ff556ca8..218ad2581 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -2814,7 +2814,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -3539,7 +3539,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -4715,7 +4715,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - #boolean + TASK_A2A_DISPATCHER.FlashNewTask @@ -6197,7 +6197,7 @@ If too large, any airborne cap may not be able to reach the detected target area
    - #boolean + TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index b7058dfdc..3d1959305 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3084,11 +3084,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -3661,11 +3664,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -4848,11 +4854,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    @@ -6341,11 +6350,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - + #boolean TASK_A2G_DISPATCHER.FlashNewTask + +

    set to false to suppress flash messages

    +
    diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index b836c6a1b..281abab81 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3146,7 +3146,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -4269,7 +4269,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -5171,7 +5171,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones @@ -6708,7 +6708,7 @@ This method can only be used once!

    - #table + TASK_CARGO_DISPATCHER.DefaultDeployZones diff --git a/Documentation/Wrapper.Client.html b/Documentation/Wrapper.Client.html index 61cfd68e8..d2798c870 100644 --- a/Documentation/Wrapper.Client.html +++ b/Documentation/Wrapper.Client.html @@ -4232,7 +4232,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    Alive.

    +

    Alive2.

    @@ -5346,7 +5346,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

    Alive.

    +

    Alive2.

    @@ -7610,7 +7610,7 @@ If the Unit is alive but not active, false is returned.

    -

    Alive.

    +

    Alive2.

    @@ -16171,7 +16171,7 @@ Note that when the WayPoint parameter is used, the new start mission waypoint of -

    Alive.

    +

    Alive2.

    @@ -19828,7 +19828,7 @@ Coordinates are dependent on the position of the maps origin.

    -

    Alive.

    +

    Alive2.

    @@ -20502,7 +20502,7 @@ If the Identifiable is alive, true is returned.

    -

    Alive.

    +

    Alive2.

    @@ -20782,7 +20782,7 @@ If the Identifiable is alive, true is returned.

    -

    Alive.

    +

    Alive2.

    diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 20b3cb3aa..4b2380f6c 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3517,17 +3517,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
    - -
    - @@ -7088,17 +7077,6 @@ Coordinates are dependent on the position of the maps origin.

    -
    - -
    - @@ -7676,17 +7654,6 @@ If the Identifiable is alive, true is returned.

    -
    - -
    -
    -
    - - Core.Spot#SPOT -POSITIONABLE.Spot - - -
    @@ -7870,17 +7837,6 @@ If the Identifiable is alive, true is returned.

    -
    - -
    -
    -
    - - Core.Spot#SPOT -POSITIONABLE.Spot - - -