Banner Image

Module Core.Set

Core - Define collections of objects to perform bulk actions and logically group objects.


Features:

  • Dynamically maintain collections of objects.
  • Manually modify the collection, by adding or removing objects.
  • Collections of different types.
  • Validate the presence of objects in the collection.
  • Perform bulk actions on collection.

Group objects or data of the same type into a collection, which is either:

  • Manually managed using the :Add...() or :Remove...() methods. The initial SET can be filtered with the **SET_BASE.FilterOnce()** method.
  • Dynamically updated when new objects are created or objects are destroyed using the **SET_BASE.FilterStart()** method.

Various types of SET_ classes are available:

These classes are derived from #SET_BASE, which contains the main methods to manage the collections.

A multitude of other methods are available in the individual set classes that allow to:

  • Validate the presence of objects in the SET.
  • Trigger events when objects in the SET change a zone presence.

Notes on FilterPrefixes():

This filter always looks for a partial match somewhere in the given field. LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through the following to understand the application of regular expressions: LUA regular expressions.
For example, setting a filter like so FilterPrefixes("Huey") is perfectly all right, whilst FilterPrefixes("UH-1H Al-Assad") might not be due to the minus signs. A quick fix here is to use a dot (.) in place of the special character, or escape it with a percentage sign (%), i.e. either FilterPrefixes("UH.1H Al.Assad") or FilterPrefixes("UH%-1H Al%-Assad") will give you the expected results.


Author: FlightControl

Contributions: funkyfranky, applevangelist


Global(s)

Global SET_AIRBASE

Mission designers can use the Core.Set#SET_AIRBASE class to build sets of airbases optionally belonging to certain:

  • Coalitions

SET_AIRBASE constructor

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

#SET_AIRBASE SET_AIRBASE

Mission designers can use the Core.Set#SET_AIRBASE class to build sets of airbases optionally belonging to certain:

  • Coalitions

SET_AIRBASE constructor

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

Add or Remove AIRBASEs from SET_AIRBASE

AIRBASEs can be added and removed using the Core.Set#SET_AIRBASE.AddAirbasesByName and Core.Set#SET_AIRBASE.RemoveAirbasesByName respectively. These methods take a single AIRBASE name or an array of AIRBASE names to be added or removed from SET_AIRBASE.

SET_AIRBASE filter criteria

You can set filter criteria to define the set of clients within the SET_AIRBASE. Filter criteria are defined by:

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

SET_AIRBASE iterators

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


Global SET_BASE

The Core.Set#SET_BASE class defines the core functions that define a collection of objects.

#SET_BASE SET_BASE

The Core.Set#SET_BASE class defines the core functions that define a collection of objects.

A SET provides iterators to iterate the SET, but will temporarily yield the ForEach iterator loop at defined "intervals" to the mail simulator loop. In this way, large loops can be done while not blocking the simulator main processing loop. The default "yield interval" is after 10 objects processed. The default "time interval" is after 0.001 seconds.

Add or remove objects from the SET

Some key core functions are Core.Set#SET_BASE.Add and Core.Set#SET_BASE.Remove to add or remove objects from the SET in your logic.

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

Modify the iterator intervals with the Core.Set#SET_BASE.SetIteratorIntervals method. You can set the "yield interval", and the "time interval". (See above).

Global SET_CARGO

Mission designers can use the Core.Set#SET_CARGO class to build sets of cargos optionally belonging to certain:

  • Coalitions
  • Types
  • Name or Prefix

SET_CARGO constructor

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

#SET_CARGO SET_CARGO

Mission designers can use the Core.Set#SET_CARGO class to build sets of cargos optionally belonging to certain:

  • Coalitions
  • Types
  • Name or Prefix

SET_CARGO constructor

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

Add or Remove CARGOs from SET_CARGO

CARGOs can be added and removed using the Core.Set#SET_CARGO.AddCargosByName and Core.Set#SET_CARGO.RemoveCargosByName respectively. These methods take a single CARGO name or an array of CARGO names to be added or removed from SET_CARGO.

SET_CARGO filter criteria

You can set filter criteria to automatically maintain the SET_CARGO contents. Filter criteria are defined by:

  • SET_CARGO.FilterCoalitions: Builds the SET_CARGO with the cargos belonging to the coalition(s).
  • SET_CARGO.FilterPrefixes: Builds the SET_CARGO with the cargos containing the same string(s). Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions
  • SET_CARGO.FilterTypes: Builds the SET_CARGO with the cargos belonging to the cargo type(s).
  • SET_CARGO.FilterCountries: Builds the SET_CARGO with the cargos belonging to the country(ies).

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

SET_CARGO iterators

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

Global SET_CLIENT

Mission designers can use the Core.Set#SET_CLIENT class to build sets of units belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Client types
  • Starting with certain prefix strings.
#SET_CLIENT SET_CLIENT

Mission designers can use the Core.Set#SET_CLIENT class to build sets of units belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Client types
  • Starting with certain prefix strings.

1) SET_CLIENT constructor

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

2) Add or Remove CLIENT(s) from SET_CLIENT

CLIENTs can be added and removed using the Core.Set#SET_CLIENT.AddClientsByName and Core.Set#SET_CLIENT.RemoveClientsByName respectively. These methods take a single CLIENT name or an array of CLIENT names to be added or removed from SET_CLIENT.

3) SET_CLIENT filter criteria

You can set filter criteria to define the set of clients within the SET_CLIENT. Filter criteria are defined by:

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

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. The iterator methods will walk the SET_CLIENT set, and call for each element within the set a function that you provide. The following iterator methods are currently available within the SET_CLIENT:


Global SET_DYNAMICCARGO

The Core.Set#SET_DYNAMICCARGO class defines the functions that define a collection of objects form Wrapper.DynamicCargo#DYNAMICCARGO.

#SET_DYNAMICCARGO SET_DYNAMICCARGO

The Core.Set#SET_DYNAMICCARGO class defines the functions that define a collection of objects form Wrapper.DynamicCargo#DYNAMICCARGO.

A SET provides iterators to iterate the SET. - Mission designers can use the SET_DYNAMICCARGO class to build sets of cargos belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Static types
  • Starting with certain prefix strings.
  • Etc.

SET_DYNAMICCARGO constructor

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

SET_DYNAMICCARGO filter criteria

You can set filter criteria to define the set of objects within the SET_DYNAMICCARGO. Filter criteria are defined by:

Once the filter criteria have been set for the SET_DYNAMICCARGO, you can start and stop filtering using:

SET_DYNAMICCARGO iterators

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

SET_DYNAMICCARGO atomic methods

Various methods exist for a SET_DYNAMICCARGO to perform actions or calculations and retrieve results from the SET_DYNAMICCARGO:


Global SET_GROUP

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

  • Coalitions
  • Categories
  • Countries
  • Starting with certain prefix strings.
#SET_GROUP SET_GROUP

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

  • Coalitions
  • Categories
  • Countries
  • Starting with certain prefix strings.

SET_GROUP constructor

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

Add or Remove GROUP(s) from SET_GROUP

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

SET_GROUP filter criteria

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

  • SET_GROUP.FilterCoalitions: Builds the SET_GROUP with the groups belonging to the coalition(s).
  • SET_GROUP.FilterCategories: Builds the SET_GROUP with the groups belonging to the category(ies).
  • SET_GROUP.FilterCountries: Builds the SET_GROUP with the groups belonging to the country(ies).
  • SET_GROUP.FilterPrefixes: Builds the SET_GROUP with the groups containing the given string in the group name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions
  • SET_GROUP.FilterActive: Builds the SET_GROUP with the groups that are only active. Groups that are inactive (late activation) won't be included in the set!

For the Category Filter, extra methods have been added:

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

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. The iterator methods will walk the SET_GROUP set, and call for each element within the set a function that you provide. The following iterator methods are currently available within the SET_GROUP:

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

   -- Create the SetCarrier SET_GROUP collection.

   local SetHelicopter = SET_GROUP: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

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

   -- Now we have a constructor of the class AI_CARGO_DISPATCHER, that receives the SetHelicopter as a parameter.
   -- Within that constructor, we want to set an enclosed event handler OnAfterDead for SetHelicopter.
   -- But within the OnAfterDead method, we want to refer to the self variable of the AI_CARGO_DISPATCHER.

   function AI_CARGO_DISPATCHER:New( SetCarrier, SetCargo, SetDeployZones )

     local self = BASE:Inherit( self, FSM:New() ) -- #AI_CARGO_DISPATCHER

     -- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
     -- Note the "." notation, and the explicit declaration of SetHelicopter, which would be using the ":" notation the implicit self variable declaration.

     function SetHelicopter.OnAfterDead( SetHelicopter, From, Event, To, GroupObject )
       SetHelicopter:F( { GroupObject = GroupObject:GetName() } )
       self.PickupCargo[GroupObject] = nil  -- So here I clear the PickupCargo table entry of the self object AI_CARGO_DISPATCHER.
       self.CarrierHome[GroupObject] = nil
     end

   end

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:

  • SET_OPSGROUP.FilterCoalitions: Builds the SET_OPSGROUP with the groups belonging to the coalition(s).
  • SET_OPSGROUP.FilterCategories: Builds the SET_OPSGROUP with the groups belonging to the category(ies).
  • SET_OPSGROUP.FilterCountries: Builds the SET_OPSGROUP with the groups belonging to the country(ies).
  • SET_OPSGROUP.FilterPrefixes: Builds the SET_OPSGROUP with the groups containing the given string in the group name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions
  • SET_OPSGROUP.FilterActive: Builds the SET_OPSGROUP with the groups that are only active. Groups that are inactive (late activation) won't be included in the set!

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

Global SET_OPSZONE

Mission designers can use the Core.Set#SET_OPSZONE class to build sets of zones of various types.

#SET_OPSZONE SET_OPSZONE

Mission designers can use the Core.Set#SET_OPSZONE class to build sets of zones of various types.

SET_OPSZONE constructor

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

Add or Remove ZONEs from SET_OPSZONE

ZONEs can be added and removed using the Core.Set#SET_OPSZONE.AddZonesByName and Core.Set#SET_OPSZONE.RemoveZonesByName respectively. These methods take a single ZONE name or an array of ZONE names to be added or removed from SET_OPSZONE.

SET_OPSZONE filter criteria

You can set filter criteria to build the collection of zones in SET_OPSZONE. Filter criteria are defined by:

  • SET_OPSZONE.FilterPrefixes: Builds the SET_OPSZONE with the zones having a certain text pattern in their name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions

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

SET_OPSZONE iterators

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


Global SET_PLAYER

Mission designers can use the Core.Set#SET_PLAYER class to build sets of units belonging to alive players:

SET_PLAYER constructor

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

#SET_PLAYER SET_PLAYER

Mission designers can use the Core.Set#SET_PLAYER class to build sets of units belonging to alive players:

SET_PLAYER constructor

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

SET_PLAYER filter criteria

You can set filter criteria to define the set of clients within the SET_PLAYER. Filter criteria are defined by:

  • SET_PLAYER.FilterCoalitions: Builds the SET_PLAYER with the clients belonging to the coalition(s).
  • SET_PLAYER.FilterCategories: Builds the SET_PLAYER with the clients belonging to the category(ies).
  • SET_PLAYER.FilterTypes: Builds the SET_PLAYER with the clients belonging to the client type(s).
  • SET_PLAYER.FilterCountries: Builds the SET_PLAYER with the clients belonging to the country(ies).
  • SET_PLAYER.FilterPrefixes: Builds the SET_PLAYER with the clients sharing the same string(s) in their unit/pilot name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions

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

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

SET_PLAYER iterators

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


Global SET_SCENERY

Mission designers can use the SET_SCENERY class to build sets of scenery belonging to certain:

  • Zone Sets

SET_SCENERY constructor

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

#SET_SCENERY SET_SCENERY

Mission designers can use the SET_SCENERY class to build sets of scenery belonging to certain:

  • Zone Sets

SET_SCENERY constructor

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

Add or Remove SCENERY(s) from SET_SCENERY

SCENERYs can be added and removed using the Core.Set#SET_SCENERY.AddSceneryByName and Core.Set#SET_SCENERY.RemoveSceneryByName respectively. These methods take a single SCENERY name or an array of SCENERY names to be added or removed from SET_SCENERY.

SET_SCENERY filter criteria

N/A at the moment

SET_SCENERY iterators

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

SET_SCENERY atomic methods

N/A at the moment


Global SET_STATIC

Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Static types
  • Starting with certain prefix strings.
#SET_STATIC SET_STATIC

Mission designers can use the SET_STATIC class to build sets of Statics belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Static types
  • Starting with certain prefix strings.

SET_STATIC constructor

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

Add or Remove STATIC(s) from SET_STATIC

STATICs can be added and removed using the Core.Set#SET_STATIC.AddStaticsByName and Core.Set#SET_STATIC.RemoveStaticsByName respectively. These methods take a single STATIC name or an array of STATIC names to be added or removed from SET_STATIC.

SET_STATIC filter criteria

You can set filter criteria to define the set of units within the SET_STATIC. Filter criteria are defined by:

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

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. The iterator methods will walk the SET_STATIC set, and call for each element within the set a function that you provide. The following iterator methods are currently available within the SET_STATIC:

SET_STATIC atomic methods

Various methods exist for a SET_STATIC to perform actions or calculations and retrieve results from the SET_STATIC:


Global SET_UNIT

Mission designers can use the SET_UNIT class to build sets of units belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Unit types
  • Starting with certain prefix strings.
#SET_UNIT SET_UNIT

Mission designers can use the SET_UNIT class to build sets of units belonging to certain:

  • Coalitions
  • Categories
  • Countries
  • Unit types
  • Starting with certain prefix strings.

1) SET_UNIT constructor

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

2) Add or Remove UNIT(s) from SET_UNIT

UNITs can be added and removed using the Core.Set#SET_UNIT.AddUnitsByName and Core.Set#SET_UNIT.RemoveUnitsByName respectively. These methods take a single UNIT name or an array of UNIT names to be added or removed from SET_UNIT.

3) SET_UNIT filter criteria

You can set filter criteria to define the set of units within the SET_UNIT. Filter criteria are defined by:

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

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. The iterator methods will walk the SET_UNIT set, and call for each element within the set a function that you provide. The following iterator methods are currently available within the SET_UNIT:

  • SET_UNIT.ForEachUnit: Calls a function for each alive unit it finds within the SET_UNIT.
  • SET_UNIT.ForEachUnitInZone: Iterate the SET_UNIT and call an iterator function for each alive UNIT object presence completely in a Core.Zone, providing the UNIT object and optional parameters to the called function.
  • SET_UNIT.ForEachUnitNotInZone: Iterate the SET_UNIT and call an iterator function for each alive UNIT object presence not in a Core.Zone, providing the UNIT object and optional parameters to the called function.
  • #SET_UNIT: Iterate the SET_UNIT sorted *per Threat Level and call an iterator function for each alive UNIT, providing the UNIT and optional parameters

5) SET_UNIT atomic methods

Various methods exist for a SET_UNIT to perform actions or calculations and retrieve results from the SET_UNIT:

6) SET_UNIT trigger events on the UNIT objects.

The SET is derived from the FSM class, which provides extra capabilities to track the contents of the UNIT objects in 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 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:

   -- Create the SetCarrier SET_UNIT collection.

   local SetHelicopter = SET_UNIT:New():FilterPrefixes( "Helicopter" ):FilterStart()

   -- Put a Dead event handler on SetCarrier, to ensure that when a carrier unit is destroyed, that all internal parameters are reset.

   function SetHelicopter:OnAfterDead( From, Event, To, UnitObject )
     --self:F( { UnitObject = UnitObject:GetName() } )
   end

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

   -- Now we have a constructor of the class AI_CARGO_DISPATCHER, that receives the SetHelicopter as a parameter.
   -- Within that constructor, we want to set an enclosed event handler OnAfterDead for SetHelicopter.
   -- But within the OnAfterDead method, we want to refer to the self variable of the AI_CARGO_DISPATCHER.

   function ACLASS:New( SetCarrier, SetCargo, SetDeployZones )

     local self = BASE:Inherit( self, FSM:New() ) -- #AI_CARGO_DISPATCHER

     -- Put a Dead event handler on SetCarrier, to ensure that when a carrier is destroyed, that all internal parameters are reset.
     -- Note the "." notation, and the explicit declaration of SetHelicopter, which would be using the ":" notation the implicit self variable declaration.

     function SetHelicopter.OnAfterDead( SetHelicopter, From, Event, To, UnitObject )
       SetHelicopter:F( { UnitObject = UnitObject:GetName() } )
       self.array[UnitObject] = nil  -- So here I clear the array table entry of the self object ACLASS.
     end

   end

Global SET_ZONE

Mission designers can use the Core.Set#SET_ZONE class to build sets of zones of various types.

#SET_ZONE SET_ZONE

Mission designers can use the Core.Set#SET_ZONE class to build sets of zones of various types.

SET_ZONE constructor

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

Add or Remove ZONEs from SET_ZONE

ZONEs can be added and removed using the Core.Set#SET_ZONE.AddZonesByName and Core.Set#SET_ZONE.RemoveZonesByName respectively. These methods take a single ZONE name or an array of ZONE names to be added or removed from SET_ZONE.

SET_ZONE filter criteria

You can set filter criteria to build the collection of zones in SET_ZONE. Filter criteria are defined by:

  • SET_ZONE.FilterPrefixes: Builds the SET_ZONE with the zones having a certain text pattern in their name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions

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

SET_ZONE iterators

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


Global SET_ZONE_GOAL

Mission designers can use the Core.Set#SET_ZONE_GOAL class to build sets of zones of various types.

#SET_ZONE_GOAL SET_ZONE_GOAL

Mission designers can use the Core.Set#SET_ZONE_GOAL class to build sets of zones of various types.

SET_ZONE_GOAL constructor

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

Add or Remove ZONEs from SET_ZONE_GOAL

ZONEs can be added and removed using the Core.Set#SET_ZONE_GOAL.AddZonesByName and Core.Set#SET_ZONE_GOAL.RemoveZonesByName respectively. These methods take a single ZONE name or an array of ZONE names to be added or removed from SET_ZONE_GOAL.

SET_ZONE_GOAL filter criteria

You can set filter criteria to build the collection of zones in SET_ZONE_GOAL. Filter criteria are defined by:

  • SET_ZONE_GOAL.FilterPrefixes: Builds the SET_ZONE_GOAL with the zones having a certain text pattern in their name. Attention! LUA regular expression apply here, so special characters in names like minus, dot, hash (#) etc might lead to unexpected results. Have a read through here to understand the application of regular expressions: LUA regular expressions

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

SET_ZONE_GOAL iterators

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


Type(s)

Fields and Methods inherited from SET_AIRBASE Description

SET_AIRBASE:AddAirbase(airbase)

Add an AIRBASE object to SET_AIRBASE.

SET_AIRBASE:AddAirbasesByName(AddAirbaseNames)

Add AIRBASEs to SET_AIRBASE.

SET_AIRBASE:AddInDatabase(Event)

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

SET_AIRBASE:FilterCategories(Categories)

Builds a set of airbases out of categories.

SET_AIRBASE:FilterCoalitions(Coalitions)

Builds a set of airbases of coalitions.

SET_AIRBASE:FilterStart()

Starts the filtering.

SET_AIRBASE:FindAirbase(AirbaseName)

Finds a Airbase based on the Airbase Name.

SET_AIRBASE:FindAirbaseInRange(Coordinate, Range)

Finds an Airbase in range of a coordinate.

SET_AIRBASE:FindInDatabase(Event)

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

SET_AIRBASE:FindNearestAirbaseFromPointVec2(PointVec2)

Iterate the SET_AIRBASE while identifying the nearest Wrapper.Airbase#AIRBASE from a Core.Point#POINT_VEC2.

SET_AIRBASE:ForEachAirbase(IteratorFunction, ...)

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

SET_AIRBASE:GetRandomAirbase()

Finds a random Airbase in the set.

SET_AIRBASE:IsIncludeObject(MAirbase)

SET_AIRBASE:New()

Creates a new SET_AIRBASE object, building a set of airbases belonging to a coalitions and categories.

SET_AIRBASE:OnEventBaseCaptured(EventData)

Base capturing event.

SET_AIRBASE:OnEventDead(EventData)

Dead event.

SET_AIRBASE:RemoveAirbasesByName(RemoveAirbaseNames)

Remove AIRBASEs from SET_AIRBASE.

Fields and Methods inherited from SET_BASE Description

SET_AIRBASE:Add(ObjectName, Object)

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

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.

SET_AIRBASE.CallScheduler

SET_AIRBASE:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_AIRBASE:CompareSets(SetA, SetB)

Compare two sets.

SET_AIRBASE:Count()

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

SET_AIRBASE.Database

SET_AIRBASE.Filter

Filters

SET_AIRBASE:FilterClear()

Clear all filters.

SET_AIRBASE:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_AIRBASE:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_AIRBASE:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_AIRBASE:FilterOnce()

Filters for the defined collection.

SET_AIRBASE:FilterStop()

Stops the filtering for the defined collection.

SET_AIRBASE:FindNearestObjectFromPointVec2(PointVec2)

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

SET_AIRBASE:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_AIRBASE: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_AIRBASE: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_AIRBASE:Get(ObjectName)

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

SET_AIRBASE:GetFirst()

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

SET_AIRBASE:GetLast()

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

SET_AIRBASE:GetObjectNames()

Gets a string with all the object names.

SET_AIRBASE:GetRandom()

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

SET_AIRBASE:GetRandomSurely()

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

SET_AIRBASE:GetSet()

Gets the Set.

SET_AIRBASE:GetSetComplement(SetB)

Get the complement of two sets.

SET_AIRBASE:GetSetIntersection(SetB)

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

SET_AIRBASE:GetSetNames()

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

SET_AIRBASE:GetSetObjects()

Returns a table of the Objects in the Set.

SET_AIRBASE:GetSetUnion(SetB)

Get the union of two sets.

SET_AIRBASE:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_AIRBASE.Index

Table of indices.

SET_AIRBASE:IsInSet(Object)

Decides whether an object is in the SET

SET_AIRBASE:IsIncludeObject(Object)

Decides whether to include the Object.

SET_AIRBASE:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_AIRBASE.List

Unused table.

SET_AIRBASE: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_AIRBASE:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_AIRBASE:Remove(ObjectName, NoTriggerEvent)

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

SET_AIRBASE.Set

Table of objects.

SET_AIRBASE:SetDatabase(BaseSet)

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

SET_AIRBASE:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_AIRBASE.SomeIteratorLimit

SET_AIRBASE:SortByName()

Sort the set by name.

SET_AIRBASE:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_AIRBASE:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_AIRBASE:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_AIRBASE:_FilterStart()

Starts the filtering for the defined collection.

SET_AIRBASE:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_AIRBASE.ClassID

The ID number of the class.

SET_AIRBASE.ClassName

The name of the class.

SET_AIRBASE.ClassNameAndID

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

SET_AIRBASE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_AIRBASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_AIRBASE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_AIRBASE:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_AIRBASE:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_AIRBASE:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_AIRBASE:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_AIRBASE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_AIRBASE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_AIRBASE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_AIRBASE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_AIRBASE:E(Arguments)

Log an exception which will be traced always.

SET_AIRBASE:EventDispatcher()

Returns the event dispatcher

SET_AIRBASE:EventRemoveAll()

Remove all subscribed events

SET_AIRBASE:F(Arguments)

Trace a function call.

SET_AIRBASE:F2(Arguments)

Trace a function call level 2.

SET_AIRBASE:F3(Arguments)

Trace a function call level 3.

SET_AIRBASE:GetClassID()

Get the ClassID of the class instance.

SET_AIRBASE:GetClassName()

Get the ClassName of the class instance.

SET_AIRBASE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_AIRBASE:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_AIRBASE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_AIRBASE:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_AIRBASE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_AIRBASE:I(Arguments)

Log an information which will be traced always.

SET_AIRBASE:Inherit(Child, Parent)

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

SET_AIRBASE:IsInstanceOf(ClassName)

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

SET_AIRBASE:IsTrace()

Enquires if tracing is on (for the class).

SET_AIRBASE:New()

BASE constructor.

SET_AIRBASE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_AIRBASE:OnEventBDA(EventData)

BDA.

SET_AIRBASE:OnEventBaseCaptured(EventData)

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

SET_AIRBASE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_AIRBASE:OnEventCrash(EventData)

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

SET_AIRBASE:OnEventDead(EventData)

Occurs when an object is dead.

SET_AIRBASE:OnEventDetailedFailure(EventData)

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

SET_AIRBASE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_AIRBASE:OnEventDynamicCargoLoaded(EventData)

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

SET_AIRBASE:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_AIRBASE:OnEventDynamicCargoUnloaded(EventData)

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

SET_AIRBASE:OnEventEjection(EventData)

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

SET_AIRBASE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_AIRBASE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_AIRBASE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_AIRBASE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_AIRBASE:OnEventKill(EventData)

Occurs on the death of a unit.

SET_AIRBASE:OnEventLand(EventData)

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

SET_AIRBASE:OnEventLandingAfterEjection(EventData)

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

SET_AIRBASE:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_AIRBASE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_AIRBASE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_AIRBASE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_AIRBASE:OnEventMissionEnd(EventData)

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

SET_AIRBASE:OnEventMissionStart(EventData)

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

SET_AIRBASE:OnEventNewDynamicCargo(EventData)

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

SET_AIRBASE:OnEventParatrooperLanding(EventData)

Weapon add.

SET_AIRBASE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_AIRBASE:OnEventPlayerEnterAircraft(EventData)

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

SET_AIRBASE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_AIRBASE:OnEventPlayerLeaveUnit(EventData)

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

SET_AIRBASE:OnEventRefueling(EventData)

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

SET_AIRBASE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_AIRBASE:OnEventScore(EventData)

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

SET_AIRBASE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_AIRBASE:OnEventShootingStart(EventData)

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

SET_AIRBASE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_AIRBASE:OnEventTakeoff(EventData)

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

SET_AIRBASE:OnEventTriggerZone(EventData)

Trigger zone.

SET_AIRBASE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_AIRBASE:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_AIRBASE.Scheduler

SET_AIRBASE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_AIRBASE:SetState(Object, Key, Value)

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

SET_AIRBASE:T(Arguments)

Trace a function logic level 1.

SET_AIRBASE:T2(Arguments)

Trace a function logic level 2.

SET_AIRBASE:T3(Arguments)

Trace a function logic level 3.

SET_AIRBASE:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_AIRBASE:TraceClass(Class)

Set tracing for a class

SET_AIRBASE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_AIRBASE:TraceLevel(Level)

Set trace level

SET_AIRBASE:TraceOff()

Set trace off.

SET_AIRBASE:TraceOn()

Set trace on.

SET_AIRBASE: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_AIRBASE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_AIRBASE._

SET_AIRBASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_AIRBASE:_Serialize(Arguments)

(Internal) Serialize arguments

SET_AIRBASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_AIRBASE.__

SET_AIRBASE:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_BASE Description

SET_BASE:Add(ObjectName, Object)

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

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.

SET_BASE.CallScheduler

SET_BASE:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_BASE:CompareSets(SetA, SetB)

Compare two sets.

SET_BASE:Count()

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

SET_BASE.Database

SET_BASE.Filter

Filters

SET_BASE:FilterClear()

Clear all filters.

SET_BASE:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_BASE:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_BASE:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_BASE:FilterOnce()

Filters for the defined collection.

SET_BASE:FilterStop()

Stops the filtering for the defined collection.

SET_BASE:FindNearestObjectFromPointVec2(PointVec2)

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

SET_BASE:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_BASE: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_BASE: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_BASE:Get(ObjectName)

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

SET_BASE:GetFirst()

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

SET_BASE:GetLast()

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

SET_BASE:GetObjectNames()

Gets a string with all the object names.

SET_BASE:GetRandom()

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

SET_BASE:GetRandomSurely()

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

SET_BASE:GetSet()

Gets the Set.

SET_BASE:GetSetComplement(SetB)

Get the complement of two sets.

SET_BASE:GetSetIntersection(SetB)

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

SET_BASE:GetSetNames()

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

SET_BASE:GetSetObjects()

Returns a table of the Objects in the Set.

SET_BASE:GetSetUnion(SetB)

Get the union of two sets.

SET_BASE:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_BASE.Index

Table of indices.

SET_BASE:IsInSet(Object)

Decides whether an object is in the SET

SET_BASE:IsIncludeObject(Object)

Decides whether to include the Object.

SET_BASE:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_BASE.List

Unused table.

SET_BASE: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_BASE:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_BASE:Remove(ObjectName, NoTriggerEvent)

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

SET_BASE.Set

Table of objects.

SET_BASE:SetDatabase(BaseSet)

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

SET_BASE:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_BASE.SomeIteratorLimit

SET_BASE:SortByName()

Sort the set by name.

SET_BASE:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_BASE:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_BASE:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_BASE:_FilterStart()

Starts the filtering for the defined collection.

SET_BASE:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_BASE.ClassID

The ID number of the class.

SET_BASE.ClassName

The name of the class.

SET_BASE.ClassNameAndID

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

SET_BASE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_BASE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_BASE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_BASE:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_BASE:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_BASE:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_BASE:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_BASE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_BASE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_BASE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_BASE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_BASE:E(Arguments)

Log an exception which will be traced always.

SET_BASE:EventDispatcher()

Returns the event dispatcher

SET_BASE:EventRemoveAll()

Remove all subscribed events

SET_BASE:F(Arguments)

Trace a function call.

SET_BASE:F2(Arguments)

Trace a function call level 2.

SET_BASE:F3(Arguments)

Trace a function call level 3.

SET_BASE:GetClassID()

Get the ClassID of the class instance.

SET_BASE:GetClassName()

Get the ClassName of the class instance.

SET_BASE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_BASE:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_BASE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_BASE:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_BASE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_BASE:I(Arguments)

Log an information which will be traced always.

SET_BASE:Inherit(Child, Parent)

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

SET_BASE:IsInstanceOf(ClassName)

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

SET_BASE:IsTrace()

Enquires if tracing is on (for the class).

SET_BASE:New()

BASE constructor.

SET_BASE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_BASE:OnEventBDA(EventData)

BDA.

SET_BASE:OnEventBaseCaptured(EventData)

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

SET_BASE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_BASE:OnEventCrash(EventData)

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

SET_BASE:OnEventDead(EventData)

Occurs when an object is dead.

SET_BASE:OnEventDetailedFailure(EventData)

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

SET_BASE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_BASE:OnEventDynamicCargoLoaded(EventData)

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

SET_BASE:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_BASE:OnEventDynamicCargoUnloaded(EventData)

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

SET_BASE:OnEventEjection(EventData)

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

SET_BASE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_BASE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_BASE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_BASE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_BASE:OnEventKill(EventData)

Occurs on the death of a unit.

SET_BASE:OnEventLand(EventData)

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

SET_BASE:OnEventLandingAfterEjection(EventData)

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

SET_BASE:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_BASE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_BASE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_BASE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_BASE:OnEventMissionEnd(EventData)

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

SET_BASE:OnEventMissionStart(EventData)

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

SET_BASE:OnEventNewDynamicCargo(EventData)

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

SET_BASE:OnEventParatrooperLanding(EventData)

Weapon add.

SET_BASE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_BASE:OnEventPlayerEnterAircraft(EventData)

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

SET_BASE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_BASE:OnEventPlayerLeaveUnit(EventData)

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

SET_BASE:OnEventRefueling(EventData)

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

SET_BASE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_BASE:OnEventScore(EventData)

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

SET_BASE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_BASE:OnEventShootingStart(EventData)

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

SET_BASE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_BASE:OnEventTakeoff(EventData)

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

SET_BASE:OnEventTriggerZone(EventData)

Trigger zone.

SET_BASE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_BASE:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_BASE.Scheduler

SET_BASE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_BASE:SetState(Object, Key, Value)

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

SET_BASE:T(Arguments)

Trace a function logic level 1.

SET_BASE:T2(Arguments)

Trace a function logic level 2.

SET_BASE:T3(Arguments)

Trace a function logic level 3.

SET_BASE:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_BASE:TraceClass(Class)

Set tracing for a class

SET_BASE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_BASE:TraceLevel(Level)

Set trace level

SET_BASE:TraceOff()

Set trace off.

SET_BASE:TraceOn()

Set trace on.

SET_BASE: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_BASE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_BASE._

SET_BASE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_BASE:_Serialize(Arguments)

(Internal) Serialize arguments

SET_BASE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_BASE.__

SET_BASE:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_BASE.Filters Description

SET_BASE.Filters.Coalition

Coalitions

SET_BASE.Filters.Functions

SET_BASE.Filters.Prefix

Prefixes.

Fields and Methods inherited from SET_CARGO Description

SET_CARGO:AddCargo(Cargo)

(R2.1) Add CARGO to SET_CARGO.

SET_CARGO:AddCargosByName(AddCargoNames)

(R2.1) Add CARGOs to SET_CARGO.

SET_CARGO:AddInDatabase(Event)

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

SET_CARGO:FilterCoalitions(Coalitions)

(R2.1) Builds a set of cargos of coalitions.

SET_CARGO:FilterCountries(Countries)

(R2.1) Builds a set of cargos of defined countries.

SET_CARGO:FilterPrefixes(Prefixes)

Builds a set of CARGOs that contain a given string in their name.

SET_CARGO:FilterStart()

(R2.1) Starts the filtering.

SET_CARGO:FilterStop()

Stops the filtering for the defined collection.

SET_CARGO:FilterTypes(Types)

(R2.1) Builds a set of cargos of defined cargo types.

SET_CARGO:FindCargo(CargoName)

(R2.1) Finds a Cargo based on the Cargo Name.

SET_CARGO:FindInDatabase(Event)

(R2.1) Handles the Database to check on any event that Object exists in the Database.

SET_CARGO:FindNearestCargoFromPointVec2(PointVec2)

(R2.1) Iterate the SET_CARGO while identifying the nearest Cargo.Cargo#CARGO from a Core.Point#POINT_VEC2.

SET_CARGO:FirstCargoDeployed()

Iterate the SET_CARGO while identifying the first Cargo.Cargo#CARGO that is Deployed.

SET_CARGO:FirstCargoLoaded()

Iterate the SET_CARGO while identifying the first Cargo.Cargo#CARGO that is Loaded.

SET_CARGO:FirstCargoUnLoaded()

Iterate the SET_CARGO while identifying the first Cargo.Cargo#CARGO that is UnLoaded.

SET_CARGO:FirstCargoUnLoadedAndNotDeployed()

Iterate the SET_CARGO while identifying the first Cargo.Cargo#CARGO that is UnLoaded and not Deployed.

SET_CARGO:FirstCargoWithState(State)

SET_CARGO:FirstCargoWithStateAndNotDeployed(State)

SET_CARGO:ForEachCargo(IteratorFunction, ...)

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

SET_CARGO:IsIncludeObject(MCargo)

(R2.1)

SET_CARGO:New()

Creates a new SET_CARGO object, building a set of cargos belonging to a coalitions and categories.

SET_CARGO:OnEventDeleteCargo(EventData)

(R2.1) Handles the OnDead or OnCrash event for alive units set.

SET_CARGO:OnEventNewCargo(EventData)

(R2.1) Handles the OnEventNewCargo event for the Set.

SET_CARGO:RemoveCargosByName(RemoveCargoNames)

(R2.1) Remove CARGOs from SET_CARGO.

Fields and Methods inherited from SET_BASE Description

SET_CARGO:Add(ObjectName, Object)

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

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.

SET_CARGO.CallScheduler

SET_CARGO:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_CARGO:CompareSets(SetA, SetB)

Compare two sets.

SET_CARGO:Count()

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

SET_CARGO.Database

SET_CARGO.Filter

Filters

SET_CARGO:FilterClear()

Clear all filters.

SET_CARGO:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_CARGO:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_CARGO:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_CARGO:FilterOnce()

Filters for the defined collection.

SET_CARGO:FilterStop()

Stops the filtering for the defined collection.

SET_CARGO:FindNearestObjectFromPointVec2(PointVec2)

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

SET_CARGO:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_CARGO: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_CARGO: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_CARGO:Get(ObjectName)

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

SET_CARGO:GetFirst()

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

SET_CARGO:GetLast()

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

SET_CARGO:GetObjectNames()

Gets a string with all the object names.

SET_CARGO:GetRandom()

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

SET_CARGO:GetRandomSurely()

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

SET_CARGO:GetSet()

Gets the Set.

SET_CARGO:GetSetComplement(SetB)

Get the complement of two sets.

SET_CARGO:GetSetIntersection(SetB)

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

SET_CARGO:GetSetNames()

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

SET_CARGO:GetSetObjects()

Returns a table of the Objects in the Set.

SET_CARGO:GetSetUnion(SetB)

Get the union of two sets.

SET_CARGO:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_CARGO.Index

Table of indices.

SET_CARGO:IsInSet(Object)

Decides whether an object is in the SET

SET_CARGO:IsIncludeObject(Object)

Decides whether to include the Object.

SET_CARGO:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_CARGO.List

Unused table.

SET_CARGO: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_CARGO:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_CARGO:Remove(ObjectName, NoTriggerEvent)

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

SET_CARGO.Set

Table of objects.

SET_CARGO:SetDatabase(BaseSet)

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

SET_CARGO:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_CARGO.SomeIteratorLimit

SET_CARGO:SortByName()

Sort the set by name.

SET_CARGO:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_CARGO:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_CARGO:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_CARGO:_FilterStart()

Starts the filtering for the defined collection.

SET_CARGO:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_CARGO.ClassID

The ID number of the class.

SET_CARGO.ClassName

The name of the class.

SET_CARGO.ClassNameAndID

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

SET_CARGO:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_CARGO:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_CARGO:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_CARGO:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_CARGO:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_CARGO:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_CARGO:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_CARGO:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_CARGO:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_CARGO:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_CARGO:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_CARGO:E(Arguments)

Log an exception which will be traced always.

SET_CARGO:EventDispatcher()

Returns the event dispatcher

SET_CARGO:EventRemoveAll()

Remove all subscribed events

SET_CARGO:F(Arguments)

Trace a function call.

SET_CARGO:F2(Arguments)

Trace a function call level 2.

SET_CARGO:F3(Arguments)

Trace a function call level 3.

SET_CARGO:GetClassID()

Get the ClassID of the class instance.

SET_CARGO:GetClassName()

Get the ClassName of the class instance.

SET_CARGO:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_CARGO:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_CARGO:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_CARGO:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_CARGO:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_CARGO:I(Arguments)

Log an information which will be traced always.

SET_CARGO:Inherit(Child, Parent)

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

SET_CARGO:IsInstanceOf(ClassName)

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

SET_CARGO:IsTrace()

Enquires if tracing is on (for the class).

SET_CARGO:New()

BASE constructor.

SET_CARGO:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_CARGO:OnEventBDA(EventData)

BDA.

SET_CARGO:OnEventBaseCaptured(EventData)

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

SET_CARGO:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_CARGO:OnEventCrash(EventData)

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

SET_CARGO:OnEventDead(EventData)

Occurs when an object is dead.

SET_CARGO:OnEventDetailedFailure(EventData)

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

SET_CARGO:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_CARGO:OnEventDynamicCargoLoaded(EventData)

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

SET_CARGO:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_CARGO:OnEventDynamicCargoUnloaded(EventData)

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

SET_CARGO:OnEventEjection(EventData)

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

SET_CARGO:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_CARGO:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_CARGO:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_CARGO:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_CARGO:OnEventKill(EventData)

Occurs on the death of a unit.

SET_CARGO:OnEventLand(EventData)

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

SET_CARGO:OnEventLandingAfterEjection(EventData)

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

SET_CARGO:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_CARGO:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_CARGO:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_CARGO:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_CARGO:OnEventMissionEnd(EventData)

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

SET_CARGO:OnEventMissionStart(EventData)

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

SET_CARGO:OnEventNewDynamicCargo(EventData)

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

SET_CARGO:OnEventParatrooperLanding(EventData)

Weapon add.

SET_CARGO:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_CARGO:OnEventPlayerEnterAircraft(EventData)

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

SET_CARGO:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_CARGO:OnEventPlayerLeaveUnit(EventData)

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

SET_CARGO:OnEventRefueling(EventData)

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

SET_CARGO:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_CARGO:OnEventScore(EventData)

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

SET_CARGO:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_CARGO:OnEventShootingStart(EventData)

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

SET_CARGO:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_CARGO:OnEventTakeoff(EventData)

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

SET_CARGO:OnEventTriggerZone(EventData)

Trigger zone.

SET_CARGO:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_CARGO:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_CARGO.Scheduler

SET_CARGO:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_CARGO:SetState(Object, Key, Value)

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

SET_CARGO:T(Arguments)

Trace a function logic level 1.

SET_CARGO:T2(Arguments)

Trace a function logic level 2.

SET_CARGO:T3(Arguments)

Trace a function logic level 3.

SET_CARGO:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_CARGO:TraceClass(Class)

Set tracing for a class

SET_CARGO:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_CARGO:TraceLevel(Level)

Set trace level

SET_CARGO:TraceOff()

Set trace off.

SET_CARGO:TraceOn()

Set trace on.

SET_CARGO: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_CARGO:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_CARGO._

SET_CARGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_CARGO:_Serialize(Arguments)

(Internal) Serialize arguments

SET_CARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_CARGO.__

SET_CARGO:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_CLIENT Description

SET_CLIENT:AddClientsByName(AddClientNames)

Add CLIENT(s) to SET_CLIENT.

SET_CLIENT:AddInDatabase(Event)

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

SET_CLIENT:CountAlive()

Iterate the SET_CLIENT and count alive units.

SET_CLIENT:FilterActive(Active)

Builds a set of clients that are only active.

SET_CLIENT:FilterAlive()

Builds a set of units which exist and are alive.

SET_CLIENT:FilterCallsigns(Callsigns)

Builds a set of clients of certain callsigns.

SET_CLIENT:FilterCategories(Categories)

Builds a set of clients out of categories.

SET_CLIENT:FilterCoalitions(Coalitions)

Builds a set of clients of coalitions.

SET_CLIENT:FilterCountries(Countries)

Builds a set of clients of defined countries.

SET_CLIENT:FilterFunction(ConditionFunction, ...)

[User] Add a custom condition function.

SET_CLIENT:FilterPlayernames(Playernames)

Builds a set of clients of certain playernames.

SET_CLIENT:FilterPrefixes(Prefixes)

Builds a set of CLIENTs that contain the given string in their unit/pilot name and NOT the group name! Attention! Bad naming convention as this does not filter only prefixes but all clients that contain the string.

SET_CLIENT:FilterStart()

Starts the filtering.

SET_CLIENT:FilterStop()

Stops the filtering.

SET_CLIENT:FilterTypes(Types)

Builds a set of clients of defined client types.

SET_CLIENT:FilterZoneTimer(Seconds)

Set filter timer interval for FilterZones if using active filtering with FilterStart().

SET_CLIENT:FilterZones(Zones)

Builds a set of clients in zones.

SET_CLIENT:FindClient(ClientName)

Finds a Client based on the Client Name.

SET_CLIENT:FindInDatabase(Event)

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

SET_CLIENT:ForEachClient(IteratorFunction, ...)

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

SET_CLIENT:ForEachClientInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_CLIENT and call an iterator function for each alive CLIENT presence completely in a Core.Zone, providing the CLIENT and optional parameters to the called function.

SET_CLIENT:ForEachClientNotInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_CLIENT and call an iterator function for each alive CLIENT presence not in a Core.Zone, providing the CLIENT and optional parameters to the called function.

SET_CLIENT:GetAliveSet()

Gets the alive set.

SET_CLIENT:IsIncludeObject(MClient)

SET_CLIENT:New()

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

SET_CLIENT:RemoveClientsByName(RemoveClientNames)

Remove CLIENT(s) from SET_CLIENT.

SET_CLIENT.ZoneTimer

SET_CLIENT.ZoneTimerInterval

SET_CLIENT:_ContinousZoneFilter()

[Internal] Private function for use of continous zone filter

SET_CLIENT:_EventPlayerEnterUnit(Event)

Handle CA slots addition

SET_CLIENT:_EventPlayerLeaveUnit(Event)

Handle CA slots removal

Fields and Methods inherited from SET_BASE Description

SET_CLIENT:Add(ObjectName, Object)

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

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.

SET_CLIENT.CallScheduler

SET_CLIENT:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_CLIENT:CompareSets(SetA, SetB)

Compare two sets.

SET_CLIENT:Count()

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

SET_CLIENT.Database

SET_CLIENT.Filter

Filters

SET_CLIENT:FilterClear()

Clear all filters.

SET_CLIENT:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_CLIENT:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_CLIENT:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_CLIENT:FilterOnce()

Filters for the defined collection.

SET_CLIENT:FilterStop()

Stops the filtering for the defined collection.

SET_CLIENT:FindNearestObjectFromPointVec2(PointVec2)

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

SET_CLIENT:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_CLIENT: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_CLIENT: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_CLIENT:Get(ObjectName)

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

SET_CLIENT:GetFirst()

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

SET_CLIENT:GetLast()

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

SET_CLIENT:GetObjectNames()

Gets a string with all the object names.

SET_CLIENT:GetRandom()

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

SET_CLIENT:GetRandomSurely()

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

SET_CLIENT:GetSet()

Gets the Set.

SET_CLIENT:GetSetComplement(SetB)

Get the complement of two sets.

SET_CLIENT:GetSetIntersection(SetB)

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

SET_CLIENT:GetSetNames()

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

SET_CLIENT:GetSetObjects()

Returns a table of the Objects in the Set.

SET_CLIENT:GetSetUnion(SetB)

Get the union of two sets.

SET_CLIENT:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_CLIENT.Index

Table of indices.

SET_CLIENT:IsInSet(Object)

Decides whether an object is in the SET

SET_CLIENT:IsIncludeObject(Object)

Decides whether to include the Object.

SET_CLIENT:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_CLIENT.List

Unused table.

SET_CLIENT: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_CLIENT:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_CLIENT:Remove(ObjectName, NoTriggerEvent)

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

SET_CLIENT.Set

Table of objects.

SET_CLIENT:SetDatabase(BaseSet)

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

SET_CLIENT:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_CLIENT.SomeIteratorLimit

SET_CLIENT:SortByName()

Sort the set by name.

SET_CLIENT:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_CLIENT:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_CLIENT:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_CLIENT:_FilterStart()

Starts the filtering for the defined collection.

SET_CLIENT:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_CLIENT.ClassID

The ID number of the class.

SET_CLIENT.ClassName

The name of the class.

SET_CLIENT.ClassNameAndID

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

SET_CLIENT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_CLIENT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_CLIENT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_CLIENT:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_CLIENT:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_CLIENT:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_CLIENT:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_CLIENT:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_CLIENT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_CLIENT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_CLIENT:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_CLIENT:E(Arguments)

Log an exception which will be traced always.

SET_CLIENT:EventDispatcher()

Returns the event dispatcher

SET_CLIENT:EventRemoveAll()

Remove all subscribed events

SET_CLIENT:F(Arguments)

Trace a function call.

SET_CLIENT:F2(Arguments)

Trace a function call level 2.

SET_CLIENT:F3(Arguments)

Trace a function call level 3.

SET_CLIENT:GetClassID()

Get the ClassID of the class instance.

SET_CLIENT:GetClassName()

Get the ClassName of the class instance.

SET_CLIENT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_CLIENT:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_CLIENT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_CLIENT:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_CLIENT:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_CLIENT:I(Arguments)

Log an information which will be traced always.

SET_CLIENT:Inherit(Child, Parent)

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

SET_CLIENT:IsInstanceOf(ClassName)

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

SET_CLIENT:IsTrace()

Enquires if tracing is on (for the class).

SET_CLIENT:New()

BASE constructor.

SET_CLIENT:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_CLIENT:OnEventBDA(EventData)

BDA.

SET_CLIENT:OnEventBaseCaptured(EventData)

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

SET_CLIENT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_CLIENT:OnEventCrash(EventData)

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

SET_CLIENT:OnEventDead(EventData)

Occurs when an object is dead.

SET_CLIENT:OnEventDetailedFailure(EventData)

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

SET_CLIENT:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_CLIENT:OnEventDynamicCargoLoaded(EventData)

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

SET_CLIENT:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_CLIENT:OnEventDynamicCargoUnloaded(EventData)

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

SET_CLIENT:OnEventEjection(EventData)

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

SET_CLIENT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_CLIENT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_CLIENT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_CLIENT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_CLIENT:OnEventKill(EventData)

Occurs on the death of a unit.

SET_CLIENT:OnEventLand(EventData)

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

SET_CLIENT:OnEventLandingAfterEjection(EventData)

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

SET_CLIENT:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_CLIENT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_CLIENT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_CLIENT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_CLIENT:OnEventMissionEnd(EventData)

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

SET_CLIENT:OnEventMissionStart(EventData)

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

SET_CLIENT:OnEventNewDynamicCargo(EventData)

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

SET_CLIENT:OnEventParatrooperLanding(EventData)

Weapon add.

SET_CLIENT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_CLIENT:OnEventPlayerEnterAircraft(EventData)

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

SET_CLIENT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_CLIENT:OnEventPlayerLeaveUnit(EventData)

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

SET_CLIENT:OnEventRefueling(EventData)

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

SET_CLIENT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_CLIENT:OnEventScore(EventData)

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

SET_CLIENT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_CLIENT:OnEventShootingStart(EventData)

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

SET_CLIENT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_CLIENT:OnEventTakeoff(EventData)

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

SET_CLIENT:OnEventTriggerZone(EventData)

Trigger zone.

SET_CLIENT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_CLIENT:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_CLIENT.Scheduler

SET_CLIENT:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_CLIENT:SetState(Object, Key, Value)

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

SET_CLIENT:T(Arguments)

Trace a function logic level 1.

SET_CLIENT:T2(Arguments)

Trace a function logic level 2.

SET_CLIENT:T3(Arguments)

Trace a function logic level 3.

SET_CLIENT:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_CLIENT:TraceClass(Class)

Set tracing for a class

SET_CLIENT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_CLIENT:TraceLevel(Level)

Set trace level

SET_CLIENT:TraceOff()

Set trace off.

SET_CLIENT:TraceOn()

Set trace on.

SET_CLIENT: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_CLIENT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_CLIENT._

SET_CLIENT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_CLIENT:_Serialize(Arguments)

(Internal) Serialize arguments

SET_CLIENT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_CLIENT.__

SET_CLIENT:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_DYNAMICCARGO Description

SET_DYNAMICCARGO.CallScheduler

SET_DYNAMICCARGO.Filter

Filters.

SET_DYNAMICCARGO:FilterCoalitions(Coalitions)

Builds a set of dynamic cargo of defined coalitions.

SET_DYNAMICCARGO:FilterCountries(Countries)

Builds a set of dynamic cargo of defined countries.

SET_DYNAMICCARGO:FilterCrashes()

This filter is N/A for SET_DYNAMICCARGO

SET_DYNAMICCARGO:FilterCurrentOwner(PlayerName)

Builds a set of DYNAMICCARGOs that are owned at the moment by this player name.

SET_DYNAMICCARGO:FilterDeads()

This filter is N/A for SET_DYNAMICCARGO

SET_DYNAMICCARGO:FilterFunction(ConditionFunction, ...)

[User] Add a custom condition function.

SET_DYNAMICCARGO:FilterIsLoaded()

Builds a set of DYNAMICCARGOs that are in state DYNAMICCARGO.State.LOADED (i.e.

SET_DYNAMICCARGO:FilterIsNew()

Builds a set of DYNAMICCARGOs that are in state DYNAMICCARGO.State.NEW (i.e.

SET_DYNAMICCARGO:FilterIsUnloaded()

Builds a set of DYNAMICCARGOs that are in state DYNAMICCARGO.State.LOADED (i.e.

SET_DYNAMICCARGO:FilterNamePattern(Patterns)

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

SET_DYNAMICCARGO:FilterPrefixes(Prefixes)

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

SET_DYNAMICCARGO:FilterStart()

Starts the filtering.

SET_DYNAMICCARGO:FilterStop()

Stops the filtering.

SET_DYNAMICCARGO:FilterTypes(Types)

Builds a set of dynamic cargo of defined dynamic cargo type names.

SET_DYNAMICCARGO:FilterZoneTimer(Seconds)

Set filter timer interval for FilterZones if using active filtering with FilterStart().

SET_DYNAMICCARGO:FilterZones(Zones)

Builds a set of dynamic cargo in zones.

SET_DYNAMICCARGO:FindInDatabase(Event)

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

SET_DYNAMICCARGO:GetOwnerClientObjects()

Returns a list of current owners (Wrapper.Client#CLIENT objects) indexed by playername from the SET.

SET_DYNAMICCARGO:GetOwnerNames()

Returns a list of current owners (playernames) indexed by playername from the SET.

SET_DYNAMICCARGO:GetStorageObjects()

Returns a list of Wrapper.Storage#STORAGE objects from the SET indexed by cargo name.

SET_DYNAMICCARGO.Index

Table of indices.

SET_DYNAMICCARGO:IsIncludeObject(DCargo)

SET_DYNAMICCARGO.List

Unused table.

SET_DYNAMICCARGO:New()

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

SET_DYNAMICCARGO.Set

Table of objects.

SET_DYNAMICCARGO.ZoneTimer

Timer for active filtering of zones.

SET_DYNAMICCARGO.ZoneTimerInterval

SET_DYNAMICCARGO:_ContinousZoneFilter()

[Internal] Private function for use of continous zone filter

SET_DYNAMICCARGO:_EventHandlerDCAdd(Event)

Handles the events for the Set.

SET_DYNAMICCARGO:_EventHandlerDCRemove(Event)

Handles the remove event for dynamic cargo set.

Fields and Methods inherited from SET_BASE Description

SET_DYNAMICCARGO:Add(ObjectName, Object)

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

SET_DYNAMICCARGO:AddObject(Object)

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

SET_DYNAMICCARGO:AddSet(SetToAdd)

Add a SET to this set.

SET_DYNAMICCARGO.CallScheduler

SET_DYNAMICCARGO:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_DYNAMICCARGO:CompareSets(SetA, SetB)

Compare two sets.

SET_DYNAMICCARGO:Count()

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

SET_DYNAMICCARGO.Database

SET_DYNAMICCARGO.Filter

Filters

SET_DYNAMICCARGO:FilterClear()

Clear all filters.

SET_DYNAMICCARGO:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_DYNAMICCARGO:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_DYNAMICCARGO:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_DYNAMICCARGO:FilterOnce()

Filters for the defined collection.

SET_DYNAMICCARGO:FilterStop()

Stops the filtering for the defined collection.

SET_DYNAMICCARGO:FindNearestObjectFromPointVec2(PointVec2)

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

SET_DYNAMICCARGO:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_DYNAMICCARGO: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_DYNAMICCARGO: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_DYNAMICCARGO:Get(ObjectName)

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

SET_DYNAMICCARGO:GetFirst()

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

SET_DYNAMICCARGO:GetLast()

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

SET_DYNAMICCARGO:GetObjectNames()

Gets a string with all the object names.

SET_DYNAMICCARGO:GetRandom()

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

SET_DYNAMICCARGO:GetRandomSurely()

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

SET_DYNAMICCARGO:GetSet()

Gets the Set.

SET_DYNAMICCARGO:GetSetComplement(SetB)

Get the complement of two sets.

SET_DYNAMICCARGO:GetSetIntersection(SetB)

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

SET_DYNAMICCARGO:GetSetNames()

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

SET_DYNAMICCARGO:GetSetObjects()

Returns a table of the Objects in the Set.

SET_DYNAMICCARGO:GetSetUnion(SetB)

Get the union of two sets.

SET_DYNAMICCARGO:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_DYNAMICCARGO.Index

Table of indices.

SET_DYNAMICCARGO:IsInSet(Object)

Decides whether an object is in the SET

SET_DYNAMICCARGO:IsIncludeObject(Object)

Decides whether to include the Object.

SET_DYNAMICCARGO:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_DYNAMICCARGO.List

Unused table.

SET_DYNAMICCARGO: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_DYNAMICCARGO:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_DYNAMICCARGO:Remove(ObjectName, NoTriggerEvent)

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

SET_DYNAMICCARGO.Set

Table of objects.

SET_DYNAMICCARGO:SetDatabase(BaseSet)

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

SET_DYNAMICCARGO:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_DYNAMICCARGO.SomeIteratorLimit

SET_DYNAMICCARGO:SortByName()

Sort the set by name.

SET_DYNAMICCARGO:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_DYNAMICCARGO:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_DYNAMICCARGO:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_DYNAMICCARGO:_FilterStart()

Starts the filtering for the defined collection.

SET_DYNAMICCARGO:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_DYNAMICCARGO.ClassID

The ID number of the class.

SET_DYNAMICCARGO.ClassName

The name of the class.

SET_DYNAMICCARGO.ClassNameAndID

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

SET_DYNAMICCARGO:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_DYNAMICCARGO:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_DYNAMICCARGO:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_DYNAMICCARGO:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_DYNAMICCARGO:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_DYNAMICCARGO:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_DYNAMICCARGO:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_DYNAMICCARGO:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_DYNAMICCARGO:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_DYNAMICCARGO:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_DYNAMICCARGO:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_DYNAMICCARGO:E(Arguments)

Log an exception which will be traced always.

SET_DYNAMICCARGO:EventDispatcher()

Returns the event dispatcher

SET_DYNAMICCARGO:EventRemoveAll()

Remove all subscribed events

SET_DYNAMICCARGO:F(Arguments)

Trace a function call.

SET_DYNAMICCARGO:F2(Arguments)

Trace a function call level 2.

SET_DYNAMICCARGO:F3(Arguments)

Trace a function call level 3.

SET_DYNAMICCARGO:GetClassID()

Get the ClassID of the class instance.

SET_DYNAMICCARGO:GetClassName()

Get the ClassName of the class instance.

SET_DYNAMICCARGO:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_DYNAMICCARGO:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_DYNAMICCARGO:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_DYNAMICCARGO:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_DYNAMICCARGO:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_DYNAMICCARGO:I(Arguments)

Log an information which will be traced always.

SET_DYNAMICCARGO:Inherit(Child, Parent)

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

SET_DYNAMICCARGO:IsInstanceOf(ClassName)

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

SET_DYNAMICCARGO:IsTrace()

Enquires if tracing is on (for the class).

SET_DYNAMICCARGO:New()

BASE constructor.

SET_DYNAMICCARGO:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_DYNAMICCARGO:OnEventBDA(EventData)

BDA.

SET_DYNAMICCARGO:OnEventBaseCaptured(EventData)

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

SET_DYNAMICCARGO:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_DYNAMICCARGO:OnEventCrash(EventData)

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

SET_DYNAMICCARGO:OnEventDead(EventData)

Occurs when an object is dead.

SET_DYNAMICCARGO:OnEventDetailedFailure(EventData)

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

SET_DYNAMICCARGO:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_DYNAMICCARGO:OnEventDynamicCargoLoaded(EventData)

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

SET_DYNAMICCARGO:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_DYNAMICCARGO:OnEventDynamicCargoUnloaded(EventData)

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

SET_DYNAMICCARGO:OnEventEjection(EventData)

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

SET_DYNAMICCARGO:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_DYNAMICCARGO:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_DYNAMICCARGO:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_DYNAMICCARGO:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_DYNAMICCARGO:OnEventKill(EventData)

Occurs on the death of a unit.

SET_DYNAMICCARGO:OnEventLand(EventData)

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

SET_DYNAMICCARGO:OnEventLandingAfterEjection(EventData)

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

SET_DYNAMICCARGO:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_DYNAMICCARGO:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_DYNAMICCARGO:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_DYNAMICCARGO:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_DYNAMICCARGO:OnEventMissionEnd(EventData)

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

SET_DYNAMICCARGO:OnEventMissionStart(EventData)

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

SET_DYNAMICCARGO:OnEventNewDynamicCargo(EventData)

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

SET_DYNAMICCARGO:OnEventParatrooperLanding(EventData)

Weapon add.

SET_DYNAMICCARGO:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_DYNAMICCARGO:OnEventPlayerEnterAircraft(EventData)

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

SET_DYNAMICCARGO:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_DYNAMICCARGO:OnEventPlayerLeaveUnit(EventData)

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

SET_DYNAMICCARGO:OnEventRefueling(EventData)

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

SET_DYNAMICCARGO:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_DYNAMICCARGO:OnEventScore(EventData)

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

SET_DYNAMICCARGO:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_DYNAMICCARGO:OnEventShootingStart(EventData)

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

SET_DYNAMICCARGO:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_DYNAMICCARGO:OnEventTakeoff(EventData)

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

SET_DYNAMICCARGO:OnEventTriggerZone(EventData)

Trigger zone.

SET_DYNAMICCARGO:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_DYNAMICCARGO:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_DYNAMICCARGO.Scheduler

SET_DYNAMICCARGO:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_DYNAMICCARGO:SetState(Object, Key, Value)

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

SET_DYNAMICCARGO:T(Arguments)

Trace a function logic level 1.

SET_DYNAMICCARGO:T2(Arguments)

Trace a function logic level 2.

SET_DYNAMICCARGO:T3(Arguments)

Trace a function logic level 3.

SET_DYNAMICCARGO:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_DYNAMICCARGO:TraceClass(Class)

Set tracing for a class

SET_DYNAMICCARGO:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_DYNAMICCARGO:TraceLevel(Level)

Set trace level

SET_DYNAMICCARGO:TraceOff()

Set trace off.

SET_DYNAMICCARGO:TraceOn()

Set trace on.

SET_DYNAMICCARGO: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_DYNAMICCARGO:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_DYNAMICCARGO._

SET_DYNAMICCARGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_DYNAMICCARGO:_Serialize(Arguments)

(Internal) Serialize arguments

SET_DYNAMICCARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_DYNAMICCARGO.__

SET_DYNAMICCARGO:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_GROUP Description

SET_GROUP:Activate(Delay)

Activate late activated groups.

SET_GROUP:AddGroup(group, DontSetCargoBayLimit)

Add a GROUP to SET_GROUP.

SET_GROUP:AddGroupsByName(AddGroupNames)

Add GROUP(s) to SET_GROUP.

SET_GROUP:AddInDatabase(Event)

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

SET_GROUP:AllCompletelyInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if all the Wrapper.Group#GROUP are completely in the Core.Zone#ZONE

SET_GROUP:AnyCompletelyInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if at least one of the Wrapper.Group#GROUP is completely inside the Core.Zone#ZONE

SET_GROUP:AnyInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if at least one #UNIT of one Wrapper.Group#GROUP of the #SET_GROUP is in Core.Zone

SET_GROUP:AnyPartlyInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if at least one Wrapper.Group#GROUP of the #SET_GROUP is partly in Core.Zone.

SET_GROUP:CountAlive()

Iterate the SET_GROUP and count how many GROUPs and UNITs are alive.

SET_GROUP:CountInZone(ZoneObject, Zone)

Iterate the SET_GROUP and count how many GROUPs are completely in the Zone That could easily be done with SET_GROUP:ForEachGroupCompletelyInZone(), but this function provides an easy to use shortcut...

SET_GROUP:CountUnitInZone(ZoneObject, Zone)

Iterate the SET_GROUP and count how many UNITs are completely in the Zone

SET_GROUP:FilterActive(Active)

Builds a set of groups that are active, ie in the mission but not yet activated (false) or actived (true).

SET_GROUP:FilterAlive()

Build a set of groups that are alive.

SET_GROUP:FilterCategories(Categories, Clear)

Builds a set of groups out of categories.

SET_GROUP:FilterCategoryAirplane()

Builds a set of groups out of airplane category.

SET_GROUP:FilterCategoryGround()

Builds a set of groups out of ground category.

SET_GROUP:FilterCategoryHelicopter()

Builds a set of groups out of helicopter category.

SET_GROUP:FilterCategoryShip()

Builds a set of groups out of ship category.

SET_GROUP:FilterCategoryStructure()

Builds a set of groups out of structure category.

SET_GROUP:FilterCoalitions(Coalitions, Clear)

Builds a set of groups of coalitions.

SET_GROUP:FilterCountries(Countries)

Builds a set of groups of defined countries.

SET_GROUP:FilterFunction(ConditionFunction, ...)

[User] Add a custom condition function.

SET_GROUP:FilterOnce()

Filter the set once

SET_GROUP:FilterPrefixes(Prefixes)

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

SET_GROUP:FilterStart()

Starts the filtering.

SET_GROUP:FilterStop()

Stops the filtering.

SET_GROUP:FilterZoneTimer(Seconds)

Set filter timer interval for FilterZones if using active filtering with FilterStart().

SET_GROUP:FilterZones(Zones, Clear)

Builds a set of groups in zones.

SET_GROUP:FindGroup(GroupName)

Finds a Group based on the Group Name.

SET_GROUP:FindInDatabase(Event)

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

SET_GROUP:FindNearestGroupFromPointVec2(PointVec2)

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

SET_GROUP:ForEachGroup(IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each GROUP object, providing the GROUP and optional parameters.

SET_GROUP:ForEachGroupAlive(IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each alive GROUP object, providing the GROUP and optional parameters.

SET_GROUP:ForEachGroupAnyInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each alive GROUP that has any unit in the Core.Zone, providing the GROUP and optional parameters to the called function.

SET_GROUP:ForEachGroupCompletelyInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each alive GROUP presence completely in a Core.Zone, providing the GROUP and optional parameters to the called function.

SET_GROUP:ForEachGroupNotInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each alive GROUP presence not in a Core.Zone, providing the GROUP and optional parameters to the called function.

SET_GROUP:ForEachGroupPartlyInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for each alive GROUP presence partly in a Core.Zone, providing the GROUP and optional parameters to the called function.

SET_GROUP:ForSomeGroup(IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for some GROUP objects, providing the GROUP and optional parameters.

SET_GROUP:ForSomeGroupAlive(IteratorFunction, ...)

Iterate the SET_GROUP and call an iterator function for some alive GROUP objects, providing the GROUP and optional parameters.

SET_GROUP:GetAliveSet()

Get a new set that only contains alive groups.

SET_GROUP:GetClosestGroup(Coordinate, Coalitions)

Get the closest group of the set with respect to a given reference coordinate.

SET_GROUP:GetUnitTypeNames()

Returns a report of of unit types.

SET_GROUP:IsIncludeObject(MGroup)

SET_GROUP:New()

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

SET_GROUP:NoneInZone(ZoneObject, Zone)

Iterate the SET_GROUP and return true if no Wrapper.Group#GROUP of the #SET_GROUP is in Core.Zone This could also be achieved with not SET_GROUP:AnyPartlyInZone(Zone), but it's easier for the mission designer to add a dedicated method

SET_GROUP:RemoveGroupsByName(RemoveGroupNames)

Remove GROUP(s) from SET_GROUP.

SET_GROUP:SetCargoBayWeightLimit()

Iterate the SET_GROUP and set for each unit the default cargo bay weight limit.

SET_GROUP.ZoneTimer

SET_GROUP.ZoneTimerInterval

SET_GROUP:_ContinousZoneFilter()

[Internal] Private function for use of continous zone filter

SET_GROUP:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive groups set.

Fields and Methods inherited from SET_BASE Description

SET_GROUP:Add(ObjectName, Object)

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

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.

SET_GROUP.CallScheduler

SET_GROUP:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_GROUP:CompareSets(SetA, SetB)

Compare two sets.

SET_GROUP:Count()

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

SET_GROUP.Database

SET_GROUP.Filter

Filters

SET_GROUP:FilterClear()

Clear all filters.

SET_GROUP:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_GROUP:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_GROUP:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_GROUP:FilterOnce()

Filters for the defined collection.

SET_GROUP:FilterStop()

Stops the filtering for the defined collection.

SET_GROUP:FindNearestObjectFromPointVec2(PointVec2)

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

SET_GROUP:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_GROUP: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_GROUP: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_GROUP:Get(ObjectName)

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

SET_GROUP:GetFirst()

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

SET_GROUP:GetLast()

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

SET_GROUP:GetObjectNames()

Gets a string with all the object names.

SET_GROUP:GetRandom()

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

SET_GROUP:GetRandomSurely()

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

SET_GROUP:GetSet()

Gets the Set.

SET_GROUP:GetSetComplement(SetB)

Get the complement of two sets.

SET_GROUP:GetSetIntersection(SetB)

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

SET_GROUP:GetSetNames()

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

SET_GROUP:GetSetObjects()

Returns a table of the Objects in the Set.

SET_GROUP:GetSetUnion(SetB)

Get the union of two sets.

SET_GROUP:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_GROUP.Index

Table of indices.

SET_GROUP:IsInSet(Object)

Decides whether an object is in the SET

SET_GROUP:IsIncludeObject(Object)

Decides whether to include the Object.

SET_GROUP:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_GROUP.List

Unused table.

SET_GROUP: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_GROUP:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_GROUP:Remove(ObjectName, NoTriggerEvent)

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

SET_GROUP.Set

Table of objects.

SET_GROUP:SetDatabase(BaseSet)

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

SET_GROUP:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_GROUP.SomeIteratorLimit

SET_GROUP:SortByName()

Sort the set by name.

SET_GROUP:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_GROUP:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_GROUP:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_GROUP:_FilterStart()

Starts the filtering for the defined collection.

SET_GROUP:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_GROUP.ClassID

The ID number of the class.

SET_GROUP.ClassName

The name of the class.

SET_GROUP.ClassNameAndID

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

SET_GROUP:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_GROUP:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_GROUP:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_GROUP:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_GROUP:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_GROUP:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_GROUP:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_GROUP:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_GROUP:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_GROUP:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_GROUP:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_GROUP:E(Arguments)

Log an exception which will be traced always.

SET_GROUP:EventDispatcher()

Returns the event dispatcher

SET_GROUP:EventRemoveAll()

Remove all subscribed events

SET_GROUP:F(Arguments)

Trace a function call.

SET_GROUP:F2(Arguments)

Trace a function call level 2.

SET_GROUP:F3(Arguments)

Trace a function call level 3.

SET_GROUP:GetClassID()

Get the ClassID of the class instance.

SET_GROUP:GetClassName()

Get the ClassName of the class instance.

SET_GROUP:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_GROUP:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_GROUP:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_GROUP:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_GROUP:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_GROUP:I(Arguments)

Log an information which will be traced always.

SET_GROUP:Inherit(Child, Parent)

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

SET_GROUP:IsInstanceOf(ClassName)

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

SET_GROUP:IsTrace()

Enquires if tracing is on (for the class).

SET_GROUP:New()

BASE constructor.

SET_GROUP:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_GROUP:OnEventBDA(EventData)

BDA.

SET_GROUP:OnEventBaseCaptured(EventData)

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

SET_GROUP:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_GROUP:OnEventCrash(EventData)

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

SET_GROUP:OnEventDead(EventData)

Occurs when an object is dead.

SET_GROUP:OnEventDetailedFailure(EventData)

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

SET_GROUP:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_GROUP:OnEventDynamicCargoLoaded(EventData)

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

SET_GROUP:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_GROUP:OnEventDynamicCargoUnloaded(EventData)

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

SET_GROUP:OnEventEjection(EventData)

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

SET_GROUP:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_GROUP:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_GROUP:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_GROUP:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_GROUP:OnEventKill(EventData)

Occurs on the death of a unit.

SET_GROUP:OnEventLand(EventData)

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

SET_GROUP:OnEventLandingAfterEjection(EventData)

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

SET_GROUP:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_GROUP:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_GROUP:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_GROUP:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_GROUP:OnEventMissionEnd(EventData)

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

SET_GROUP:OnEventMissionStart(EventData)

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

SET_GROUP:OnEventNewDynamicCargo(EventData)

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

SET_GROUP:OnEventParatrooperLanding(EventData)

Weapon add.

SET_GROUP:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_GROUP:OnEventPlayerEnterAircraft(EventData)

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

SET_GROUP:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_GROUP:OnEventPlayerLeaveUnit(EventData)

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

SET_GROUP:OnEventRefueling(EventData)

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

SET_GROUP:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_GROUP:OnEventScore(EventData)

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

SET_GROUP:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_GROUP:OnEventShootingStart(EventData)

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

SET_GROUP:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_GROUP:OnEventTakeoff(EventData)

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

SET_GROUP:OnEventTriggerZone(EventData)

Trigger zone.

SET_GROUP:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_GROUP:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_GROUP.Scheduler

SET_GROUP:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_GROUP:SetState(Object, Key, Value)

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

SET_GROUP:T(Arguments)

Trace a function logic level 1.

SET_GROUP:T2(Arguments)

Trace a function logic level 2.

SET_GROUP:T3(Arguments)

Trace a function logic level 3.

SET_GROUP:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_GROUP:TraceClass(Class)

Set tracing for a class

SET_GROUP:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_GROUP:TraceLevel(Level)

Set trace level

SET_GROUP:TraceOff()

Set trace off.

SET_GROUP:TraceOn()

Set trace on.

SET_GROUP: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_GROUP:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_GROUP._

SET_GROUP:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_GROUP:_Serialize(Arguments)

(Internal) Serialize arguments

SET_GROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_GROUP.__

SET_GROUP:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_OPSGROUP Description

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:AddObject(Object)

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

SET_OPSGROUP:FilterActive(Active)

Builds a set of groups that are only active.

SET_OPSGROUP:FilterCategories(Categories, Clear)

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

Builds a set of groups of coalitions.

SET_OPSGROUP:FilterCountries(Countries, Clear)

Builds a set of groups of defined countries.

SET_OPSGROUP:FilterPrefixes(Prefixes, Clear)

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 a new set that only contains alive groups.

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:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_OPSGROUP:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive groups set.

Fields and Methods inherited from SET_BASE Description

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

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

Filters

SET_OPSGROUP:FilterClear()

Clear all 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:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

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 in the set 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:GetRandomSurely()

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

Returns a table 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 indices.

SET_OPSGROUP:IsInSet(Object)

Decides whether an object is in the SET

SET_OPSGROUP:IsIncludeObject(Object)

Decides whether to include the Object.

SET_OPSGROUP:IsNotInSet(Object)

Decides whether an object is not in the SET

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:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_OPSGROUP.SomeIteratorLimit

SET_OPSGROUP:SortByName()

Sort the set by name.

SET_OPSGROUP:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

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 BASE Description

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

Creation of a Crash Event.

SET_OPSGROUP:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_OPSGROUP:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_OPSGROUP:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_OPSGROUP:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_OPSGROUP:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO 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:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash 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 Core.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 Event for an object is triggered.

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:OnEventDynamicCargoLoaded(EventData)

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

SET_OPSGROUP:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_OPSGROUP:OnEventDynamicCargoUnloaded(EventData)

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

SET_OPSGROUP:OnEventEjection(EventData)

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

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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

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 Have a look at the class Core.Event#EVENT as these are just the prototypes.

SET_OPSGROUP:OnEventMissionStart(EventData)

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

SET_OPSGROUP:OnEventNewDynamicCargo(EventData)

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

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

Stops the Schedule.

SET_OPSGROUP.Scheduler

SET_OPSGROUP:SetEventPriority(EventPriority)

Set the Class Core.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:_Serialize(Arguments)

(Internal) Serialize arguments

SET_OPSGROUP:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_OPSGROUP.__

SET_OPSGROUP:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_OPSZONE Description

SET_OPSZONE:AddInDatabase(Event)

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

SET_OPSZONE:AddZone(Zone)

Add an OPSZONE to set.

SET_OPSZONE:FilterClear()

Clear all filters.

SET_OPSZONE:FilterCoalitions(Coalitions)

Builds a set of groups of coalitions.

SET_OPSZONE:FilterOnce()

Filters for the defined collection.

SET_OPSZONE:FilterPrefixes(Prefixes)

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

SET_OPSZONE:FilterStart()

Starts the filtering.

SET_OPSZONE:FilterStop()

Stops the filtering for the defined collection.

SET_OPSZONE:FindInDatabase(Event)

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

SET_OPSZONE:FindZone(ZoneName)

Finds a Zone based on its name.

SET_OPSZONE:ForEachZone(IteratorFunction, ...)

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

SET_OPSZONE:GetClosestZone(Coordinate, Coalitions)

Get the closest OPSZONE from a given reference coordinate.

SET_OPSZONE:GetRandomZone()

Get a random zone from the set.

SET_OPSZONE:IsCoordinateInZone(Coordinate)

Validate if a coordinate is in one of the zones in the set.

SET_OPSZONE:IsIncludeObject(MZone)

Private function that checks if an object is contained in the set or filtered.

SET_OPSZONE:New()

Creates a new SET_OPSZONE object, building a set of zones.

SET_OPSZONE:OnEventDeleteZoneGoal(EventData)

Handles the OnDead or OnCrash event for alive units set.

SET_OPSZONE:OnEventNewZoneGoal(EventData)

Handles the OnEventNewZone event for the Set.

SET_OPSZONE:RemoveZonesByName(RemoveZoneNames)

Remove ZONEs from SET_OPSZONE.

SET_OPSZONE:SetZoneProbability(ZoneName, Probability)

Set a zone probability.

SET_OPSZONE:Start()

Start all opszones of the set.

Fields and Methods inherited from SET_BASE Description

SET_OPSZONE:Add(ObjectName, Object)

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

SET_OPSZONE:AddObject(Object)

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

SET_OPSZONE:AddSet(SetToAdd)

Add a SET to this set.

SET_OPSZONE.CallScheduler

SET_OPSZONE:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_OPSZONE:CompareSets(SetA, SetB)

Compare two sets.

SET_OPSZONE:Count()

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

SET_OPSZONE.Database

SET_OPSZONE.Filter

Filters

SET_OPSZONE:FilterClear()

Clear all filters.

SET_OPSZONE:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_OPSZONE:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_OPSZONE:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_OPSZONE:FilterOnce()

Filters for the defined collection.

SET_OPSZONE:FilterStop()

Stops the filtering for the defined collection.

SET_OPSZONE:FindNearestObjectFromPointVec2(PointVec2)

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

SET_OPSZONE:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_OPSZONE: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_OPSZONE: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_OPSZONE:Get(ObjectName)

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

SET_OPSZONE:GetFirst()

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

SET_OPSZONE:GetLast()

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

SET_OPSZONE:GetObjectNames()

Gets a string with all the object names.

SET_OPSZONE:GetRandom()

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

SET_OPSZONE:GetRandomSurely()

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

SET_OPSZONE:GetSet()

Gets the Set.

SET_OPSZONE:GetSetComplement(SetB)

Get the complement of two sets.

SET_OPSZONE:GetSetIntersection(SetB)

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

SET_OPSZONE:GetSetNames()

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

SET_OPSZONE:GetSetObjects()

Returns a table of the Objects in the Set.

SET_OPSZONE:GetSetUnion(SetB)

Get the union of two sets.

SET_OPSZONE:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_OPSZONE.Index

Table of indices.

SET_OPSZONE:IsInSet(Object)

Decides whether an object is in the SET

SET_OPSZONE:IsIncludeObject(Object)

Decides whether to include the Object.

SET_OPSZONE:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_OPSZONE.List

Unused table.

SET_OPSZONE: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_OPSZONE:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_OPSZONE:Remove(ObjectName, NoTriggerEvent)

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

SET_OPSZONE.Set

Table of objects.

SET_OPSZONE:SetDatabase(BaseSet)

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

SET_OPSZONE:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_OPSZONE.SomeIteratorLimit

SET_OPSZONE:SortByName()

Sort the set by name.

SET_OPSZONE:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_OPSZONE:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_OPSZONE:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_OPSZONE:_FilterStart()

Starts the filtering for the defined collection.

SET_OPSZONE:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_OPSZONE.ClassID

The ID number of the class.

SET_OPSZONE.ClassName

The name of the class.

SET_OPSZONE.ClassNameAndID

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

SET_OPSZONE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_OPSZONE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_OPSZONE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_OPSZONE:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_OPSZONE:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_OPSZONE:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_OPSZONE:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_OPSZONE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_OPSZONE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_OPSZONE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_OPSZONE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_OPSZONE:E(Arguments)

Log an exception which will be traced always.

SET_OPSZONE:EventDispatcher()

Returns the event dispatcher

SET_OPSZONE:EventRemoveAll()

Remove all subscribed events

SET_OPSZONE:F(Arguments)

Trace a function call.

SET_OPSZONE:F2(Arguments)

Trace a function call level 2.

SET_OPSZONE:F3(Arguments)

Trace a function call level 3.

SET_OPSZONE:GetClassID()

Get the ClassID of the class instance.

SET_OPSZONE:GetClassName()

Get the ClassName of the class instance.

SET_OPSZONE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_OPSZONE:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_OPSZONE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_OPSZONE:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_OPSZONE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_OPSZONE:I(Arguments)

Log an information which will be traced always.

SET_OPSZONE:Inherit(Child, Parent)

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

SET_OPSZONE:IsInstanceOf(ClassName)

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

SET_OPSZONE:IsTrace()

Enquires if tracing is on (for the class).

SET_OPSZONE:New()

BASE constructor.

SET_OPSZONE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_OPSZONE:OnEventBDA(EventData)

BDA.

SET_OPSZONE:OnEventBaseCaptured(EventData)

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

SET_OPSZONE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_OPSZONE:OnEventCrash(EventData)

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

SET_OPSZONE:OnEventDead(EventData)

Occurs when an object is dead.

SET_OPSZONE:OnEventDetailedFailure(EventData)

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

SET_OPSZONE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_OPSZONE:OnEventDynamicCargoLoaded(EventData)

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

SET_OPSZONE:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_OPSZONE:OnEventDynamicCargoUnloaded(EventData)

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

SET_OPSZONE:OnEventEjection(EventData)

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

SET_OPSZONE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_OPSZONE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_OPSZONE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_OPSZONE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_OPSZONE:OnEventKill(EventData)

Occurs on the death of a unit.

SET_OPSZONE:OnEventLand(EventData)

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

SET_OPSZONE:OnEventLandingAfterEjection(EventData)

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

SET_OPSZONE:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_OPSZONE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_OPSZONE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_OPSZONE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_OPSZONE:OnEventMissionEnd(EventData)

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

SET_OPSZONE:OnEventMissionStart(EventData)

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

SET_OPSZONE:OnEventNewDynamicCargo(EventData)

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

SET_OPSZONE:OnEventParatrooperLanding(EventData)

Weapon add.

SET_OPSZONE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_OPSZONE:OnEventPlayerEnterAircraft(EventData)

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

SET_OPSZONE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_OPSZONE:OnEventPlayerLeaveUnit(EventData)

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

SET_OPSZONE:OnEventRefueling(EventData)

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

SET_OPSZONE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_OPSZONE:OnEventScore(EventData)

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

SET_OPSZONE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_OPSZONE:OnEventShootingStart(EventData)

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

SET_OPSZONE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_OPSZONE:OnEventTakeoff(EventData)

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

SET_OPSZONE:OnEventTriggerZone(EventData)

Trigger zone.

SET_OPSZONE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_OPSZONE:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_OPSZONE.Scheduler

SET_OPSZONE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_OPSZONE:SetState(Object, Key, Value)

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

SET_OPSZONE:T(Arguments)

Trace a function logic level 1.

SET_OPSZONE:T2(Arguments)

Trace a function logic level 2.

SET_OPSZONE:T3(Arguments)

Trace a function logic level 3.

SET_OPSZONE:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_OPSZONE:TraceClass(Class)

Set tracing for a class

SET_OPSZONE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_OPSZONE:TraceLevel(Level)

Set trace level

SET_OPSZONE:TraceOff()

Set trace off.

SET_OPSZONE:TraceOn()

Set trace on.

SET_OPSZONE: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_OPSZONE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_OPSZONE._

SET_OPSZONE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_OPSZONE:_Serialize(Arguments)

(Internal) Serialize arguments

SET_OPSZONE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_OPSZONE.__

SET_OPSZONE:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_PLAYER Description

SET_PLAYER:AddClientsByName(AddClientNames)

Add CLIENT(s) to SET_PLAYER.

SET_PLAYER:AddInDatabase(Event)

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

SET_PLAYER:FilterCategories(Categories)

Builds a set of clients out of categories joined by players.

SET_PLAYER:FilterCoalitions(Coalitions)

Builds a set of clients of coalitions joined by specific players.

SET_PLAYER:FilterCountries(Countries)

Builds a set of clients of defined countries.

SET_PLAYER:FilterPrefixes(Prefixes)

Builds a set of PLAYERs that contain the given string in their unit/pilot name.

SET_PLAYER:FilterStart()

Starts the filtering.

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.

SET_PLAYER:FindClient(PlayerName)

Finds a Client based on the Player Name.

SET_PLAYER:FindInDatabase(Event)

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

SET_PLAYER:ForEachPlayer(IteratorFunction, ...)

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

SET_PLAYER:ForEachPlayerInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_PLAYER and call an iterator function for each alive CLIENT presence completely in a Core.Zone, providing the CLIENT and optional parameters to the called function.

SET_PLAYER:ForEachPlayerNotInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_PLAYER and call an iterator function for each alive CLIENT presence not in a Core.Zone, providing the CLIENT and optional parameters to the called function.

SET_PLAYER:IsIncludeObject(MClient)

SET_PLAYER:New()

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

SET_PLAYER:RemoveClientsByName(RemoveClientNames)

Remove CLIENT(s) from SET_PLAYER.

Fields and Methods inherited from SET_BASE Description

SET_PLAYER:Add(ObjectName, Object)

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

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.

SET_PLAYER.CallScheduler

SET_PLAYER:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_PLAYER:CompareSets(SetA, SetB)

Compare two sets.

SET_PLAYER:Count()

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

SET_PLAYER.Database

SET_PLAYER.Filter

Filters

SET_PLAYER:FilterClear()

Clear all filters.

SET_PLAYER:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_PLAYER:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_PLAYER:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_PLAYER:FilterOnce()

Filters for the defined collection.

SET_PLAYER:FilterStop()

Stops the filtering for the defined collection.

SET_PLAYER:FindNearestObjectFromPointVec2(PointVec2)

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

SET_PLAYER:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_PLAYER: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_PLAYER: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_PLAYER:Get(ObjectName)

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

SET_PLAYER:GetFirst()

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

SET_PLAYER:GetLast()

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

SET_PLAYER:GetObjectNames()

Gets a string with all the object names.

SET_PLAYER:GetRandom()

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

SET_PLAYER:GetRandomSurely()

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

SET_PLAYER:GetSet()

Gets the Set.

SET_PLAYER:GetSetComplement(SetB)

Get the complement of two sets.

SET_PLAYER:GetSetIntersection(SetB)

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

SET_PLAYER:GetSetNames()

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

SET_PLAYER:GetSetObjects()

Returns a table of the Objects in the Set.

SET_PLAYER:GetSetUnion(SetB)

Get the union of two sets.

SET_PLAYER:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_PLAYER.Index

Table of indices.

SET_PLAYER:IsInSet(Object)

Decides whether an object is in the SET

SET_PLAYER:IsIncludeObject(Object)

Decides whether to include the Object.

SET_PLAYER:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_PLAYER.List

Unused table.

SET_PLAYER: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_PLAYER:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_PLAYER:Remove(ObjectName, NoTriggerEvent)

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

SET_PLAYER.Set

Table of objects.

SET_PLAYER:SetDatabase(BaseSet)

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

SET_PLAYER:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_PLAYER.SomeIteratorLimit

SET_PLAYER:SortByName()

Sort the set by name.

SET_PLAYER:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_PLAYER:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_PLAYER:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_PLAYER:_FilterStart()

Starts the filtering for the defined collection.

SET_PLAYER:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_PLAYER.ClassID

The ID number of the class.

SET_PLAYER.ClassName

The name of the class.

SET_PLAYER.ClassNameAndID

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

SET_PLAYER:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_PLAYER:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_PLAYER:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_PLAYER:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_PLAYER:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_PLAYER:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_PLAYER:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_PLAYER:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_PLAYER:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_PLAYER:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_PLAYER:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_PLAYER:E(Arguments)

Log an exception which will be traced always.

SET_PLAYER:EventDispatcher()

Returns the event dispatcher

SET_PLAYER:EventRemoveAll()

Remove all subscribed events

SET_PLAYER:F(Arguments)

Trace a function call.

SET_PLAYER:F2(Arguments)

Trace a function call level 2.

SET_PLAYER:F3(Arguments)

Trace a function call level 3.

SET_PLAYER:GetClassID()

Get the ClassID of the class instance.

SET_PLAYER:GetClassName()

Get the ClassName of the class instance.

SET_PLAYER:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_PLAYER:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_PLAYER:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_PLAYER:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_PLAYER:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_PLAYER:I(Arguments)

Log an information which will be traced always.

SET_PLAYER:Inherit(Child, Parent)

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

SET_PLAYER:IsInstanceOf(ClassName)

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

SET_PLAYER:IsTrace()

Enquires if tracing is on (for the class).

SET_PLAYER:New()

BASE constructor.

SET_PLAYER:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_PLAYER:OnEventBDA(EventData)

BDA.

SET_PLAYER:OnEventBaseCaptured(EventData)

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

SET_PLAYER:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_PLAYER:OnEventCrash(EventData)

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

SET_PLAYER:OnEventDead(EventData)

Occurs when an object is dead.

SET_PLAYER:OnEventDetailedFailure(EventData)

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

SET_PLAYER:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_PLAYER:OnEventDynamicCargoLoaded(EventData)

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

SET_PLAYER:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_PLAYER:OnEventDynamicCargoUnloaded(EventData)

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

SET_PLAYER:OnEventEjection(EventData)

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

SET_PLAYER:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_PLAYER:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_PLAYER:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_PLAYER:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_PLAYER:OnEventKill(EventData)

Occurs on the death of a unit.

SET_PLAYER:OnEventLand(EventData)

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

SET_PLAYER:OnEventLandingAfterEjection(EventData)

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

SET_PLAYER:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_PLAYER:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_PLAYER:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_PLAYER:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_PLAYER:OnEventMissionEnd(EventData)

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

SET_PLAYER:OnEventMissionStart(EventData)

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

SET_PLAYER:OnEventNewDynamicCargo(EventData)

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

SET_PLAYER:OnEventParatrooperLanding(EventData)

Weapon add.

SET_PLAYER:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_PLAYER:OnEventPlayerEnterAircraft(EventData)

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

SET_PLAYER:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_PLAYER:OnEventPlayerLeaveUnit(EventData)

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

SET_PLAYER:OnEventRefueling(EventData)

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

SET_PLAYER:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_PLAYER:OnEventScore(EventData)

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

SET_PLAYER:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_PLAYER:OnEventShootingStart(EventData)

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

SET_PLAYER:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_PLAYER:OnEventTakeoff(EventData)

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

SET_PLAYER:OnEventTriggerZone(EventData)

Trigger zone.

SET_PLAYER:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_PLAYER:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_PLAYER.Scheduler

SET_PLAYER:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_PLAYER:SetState(Object, Key, Value)

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

SET_PLAYER:T(Arguments)

Trace a function logic level 1.

SET_PLAYER:T2(Arguments)

Trace a function logic level 2.

SET_PLAYER:T3(Arguments)

Trace a function logic level 3.

SET_PLAYER:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_PLAYER:TraceClass(Class)

Set tracing for a class

SET_PLAYER:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_PLAYER:TraceLevel(Level)

Set trace level

SET_PLAYER:TraceOff()

Set trace off.

SET_PLAYER:TraceOn()

Set trace on.

SET_PLAYER: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_PLAYER:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_PLAYER._

SET_PLAYER:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_PLAYER:_Serialize(Arguments)

(Internal) Serialize arguments

SET_PLAYER:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_PLAYER.__

SET_PLAYER:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_SCENERY Description

SET_SCENERY:AddScenery(AddScenery)

Add SCENERY(s) to SET_SCENERY.

SET_SCENERY:AddSceneryByName(AddSceneryNames)

Add SCENERY(s) to SET_SCENERY.

SET_SCENERY:CountAlive()

Iterate the SET_SCENERY and count how many SCENERYSs are alive.

SET_SCENERY:FilterOnce()

Filters for the defined collection.

SET_SCENERY:FilterPrefixes(Prefixes)

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

SET_SCENERY:FilterRoles(Role)

Builds a set of SCENERYs that contain an exact match of the "ROLE" property.

SET_SCENERY:FilterZones(Zones)

Builds a set of scenery objects in zones.

SET_SCENERY:FindScenery(SceneryName)

Finds a Scenery in the SET, based on the Scenery Name.

SET_SCENERY:ForEachScenery(IteratorFunction, ...)

Iterate the SET_SCENERY and call an iterator function for each alive SCENERY, providing the SCENERY and optional parameters.

SET_SCENERY:GetAliveSet()

Get a table of alive objects.

SET_SCENERY:GetCoordinate()

Get the center coordinate of the SET_SCENERY.

SET_SCENERY:GetLife()

Count overall current lifepoints of the SET objects.

SET_SCENERY:GetLife0()

Count overall initial (Life0) lifepoints of the SET objects.

SET_SCENERY:GetRelativeLife()

Calculate current relative lifepoints of the SET objects, i.e.

SET_SCENERY:IsIncludeObject(MScenery)

[Internal] Determine if an object is to be included in the SET

SET_SCENERY:New(ZoneSet)

Creates a new SET_SCENERY object.

SET_SCENERY:NewFromZone(Zone)

Creates a new SET_SCENERY object.

SET_SCENERY:RemoveSceneryByName(RemoveSceneryNames)

Remove SCENERY(s) from SET_SCENERY.

Fields and Methods inherited from SET_BASE Description

SET_SCENERY:Add(ObjectName, Object)

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

SET_SCENERY:AddObject(Object)

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

SET_SCENERY:AddSet(SetToAdd)

Add a SET to this set.

SET_SCENERY.CallScheduler

SET_SCENERY:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_SCENERY:CompareSets(SetA, SetB)

Compare two sets.

SET_SCENERY:Count()

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

SET_SCENERY.Database

SET_SCENERY.Filter

Filters

SET_SCENERY:FilterClear()

Clear all filters.

SET_SCENERY:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_SCENERY:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_SCENERY:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_SCENERY:FilterOnce()

Filters for the defined collection.

SET_SCENERY:FilterStop()

Stops the filtering for the defined collection.

SET_SCENERY:FindNearestObjectFromPointVec2(PointVec2)

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

SET_SCENERY:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_SCENERY: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_SCENERY: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_SCENERY:Get(ObjectName)

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

SET_SCENERY:GetFirst()

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

SET_SCENERY:GetLast()

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

SET_SCENERY:GetObjectNames()

Gets a string with all the object names.

SET_SCENERY:GetRandom()

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

SET_SCENERY:GetRandomSurely()

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

SET_SCENERY:GetSet()

Gets the Set.

SET_SCENERY:GetSetComplement(SetB)

Get the complement of two sets.

SET_SCENERY:GetSetIntersection(SetB)

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

SET_SCENERY:GetSetNames()

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

SET_SCENERY:GetSetObjects()

Returns a table of the Objects in the Set.

SET_SCENERY:GetSetUnion(SetB)

Get the union of two sets.

SET_SCENERY:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_SCENERY.Index

Table of indices.

SET_SCENERY:IsInSet(Object)

Decides whether an object is in the SET

SET_SCENERY:IsIncludeObject(Object)

Decides whether to include the Object.

SET_SCENERY:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_SCENERY.List

Unused table.

SET_SCENERY: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_SCENERY:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_SCENERY:Remove(ObjectName, NoTriggerEvent)

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

SET_SCENERY.Set

Table of objects.

SET_SCENERY:SetDatabase(BaseSet)

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

SET_SCENERY:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_SCENERY.SomeIteratorLimit

SET_SCENERY:SortByName()

Sort the set by name.

SET_SCENERY:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_SCENERY:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_SCENERY:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_SCENERY:_FilterStart()

Starts the filtering for the defined collection.

SET_SCENERY:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_SCENERY.ClassID

The ID number of the class.

SET_SCENERY.ClassName

The name of the class.

SET_SCENERY.ClassNameAndID

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

SET_SCENERY:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_SCENERY:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_SCENERY:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_SCENERY:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_SCENERY:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_SCENERY:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_SCENERY:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_SCENERY:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_SCENERY:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_SCENERY:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_SCENERY:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_SCENERY:E(Arguments)

Log an exception which will be traced always.

SET_SCENERY:EventDispatcher()

Returns the event dispatcher

SET_SCENERY:EventRemoveAll()

Remove all subscribed events

SET_SCENERY:F(Arguments)

Trace a function call.

SET_SCENERY:F2(Arguments)

Trace a function call level 2.

SET_SCENERY:F3(Arguments)

Trace a function call level 3.

SET_SCENERY:GetClassID()

Get the ClassID of the class instance.

SET_SCENERY:GetClassName()

Get the ClassName of the class instance.

SET_SCENERY:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_SCENERY:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_SCENERY:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_SCENERY:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_SCENERY:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_SCENERY:I(Arguments)

Log an information which will be traced always.

SET_SCENERY:Inherit(Child, Parent)

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

SET_SCENERY:IsInstanceOf(ClassName)

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

SET_SCENERY:IsTrace()

Enquires if tracing is on (for the class).

SET_SCENERY:New()

BASE constructor.

SET_SCENERY:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_SCENERY:OnEventBDA(EventData)

BDA.

SET_SCENERY:OnEventBaseCaptured(EventData)

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

SET_SCENERY:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_SCENERY:OnEventCrash(EventData)

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

SET_SCENERY:OnEventDead(EventData)

Occurs when an object is dead.

SET_SCENERY:OnEventDetailedFailure(EventData)

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

SET_SCENERY:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_SCENERY:OnEventDynamicCargoLoaded(EventData)

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

SET_SCENERY:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_SCENERY:OnEventDynamicCargoUnloaded(EventData)

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

SET_SCENERY:OnEventEjection(EventData)

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

SET_SCENERY:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_SCENERY:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_SCENERY:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_SCENERY:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_SCENERY:OnEventKill(EventData)

Occurs on the death of a unit.

SET_SCENERY:OnEventLand(EventData)

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

SET_SCENERY:OnEventLandingAfterEjection(EventData)

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

SET_SCENERY:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_SCENERY:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_SCENERY:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_SCENERY:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_SCENERY:OnEventMissionEnd(EventData)

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

SET_SCENERY:OnEventMissionStart(EventData)

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

SET_SCENERY:OnEventNewDynamicCargo(EventData)

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

SET_SCENERY:OnEventParatrooperLanding(EventData)

Weapon add.

SET_SCENERY:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_SCENERY:OnEventPlayerEnterAircraft(EventData)

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

SET_SCENERY:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_SCENERY:OnEventPlayerLeaveUnit(EventData)

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

SET_SCENERY:OnEventRefueling(EventData)

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

SET_SCENERY:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_SCENERY:OnEventScore(EventData)

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

SET_SCENERY:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_SCENERY:OnEventShootingStart(EventData)

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

SET_SCENERY:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_SCENERY:OnEventTakeoff(EventData)

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

SET_SCENERY:OnEventTriggerZone(EventData)

Trigger zone.

SET_SCENERY:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_SCENERY:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_SCENERY.Scheduler

SET_SCENERY:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_SCENERY:SetState(Object, Key, Value)

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

SET_SCENERY:T(Arguments)

Trace a function logic level 1.

SET_SCENERY:T2(Arguments)

Trace a function logic level 2.

SET_SCENERY:T3(Arguments)

Trace a function logic level 3.

SET_SCENERY:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_SCENERY:TraceClass(Class)

Set tracing for a class

SET_SCENERY:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_SCENERY:TraceLevel(Level)

Set trace level

SET_SCENERY:TraceOff()

Set trace off.

SET_SCENERY:TraceOn()

Set trace on.

SET_SCENERY: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_SCENERY:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_SCENERY._

SET_SCENERY:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_SCENERY:_Serialize(Arguments)

(Internal) Serialize arguments

SET_SCENERY:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_SCENERY.__

SET_SCENERY:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_STATIC Description

SET_STATIC:AddInDatabase(Event)

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

SET_STATIC:AddStatic(AddStatic)

Add STATIC(s) to SET_STATIC.

SET_STATIC:AddStaticsByName(AddStaticNames)

Add STATIC(s) to SET_STATIC.

SET_STATIC:CalculateThreatLevelA2G()

Calculate the maximum A2G threat level of the SET_STATIC.

SET_STATIC:CountAlive()

Iterate the SET_STATIC and count how many STATICSs are alive.

SET_STATIC:FilterCategories(Categories)

Builds a set of units out of categories.

SET_STATIC:FilterCoalitions(Coalitions)

Builds a set of units of coalitions.

SET_STATIC:FilterCountries(Countries)

Builds a set of units of defined countries.

SET_STATIC:FilterFunction(ConditionFunction, ...)

[User] Add a custom condition function.

SET_STATIC:FilterPrefixes(Prefixes)

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

SET_STATIC:FilterStart()

Starts the filtering.

SET_STATIC:FilterTypes(Types)

Builds a set of units of defined unit types.

SET_STATIC:FilterZones(Zones)

Builds a set of statics in zones.

SET_STATIC:FindInDatabase(Event)

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

SET_STATIC:FindStatic(StaticName)

Finds a Static based on the Static Name.

SET_STATIC:ForEachStatic(IteratorFunction, ...)

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

SET_STATIC:ForEachStaticCompletelyInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_STATIC and call an iterator function for each alive STATIC presence completely in a Core.Zone, providing the STATIC and optional parameters to the called function.

SET_STATIC:ForEachStaticInZone(IteratorFunction, ...)

Check if minimal one element of the SET_STATIC is in the Zone.

SET_STATIC:ForEachStaticNotInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_STATIC and call an iterator function for each alive STATIC presence not in a Core.Zone, providing the STATIC and optional parameters to the called function.

SET_STATIC:GetClosestStatic(Coordinate, Coalitions)

Get the closest static of the set with respect to a given reference coordinate.

SET_STATIC:GetCoordinate()

Get the center coordinate of the SET_STATIC.

SET_STATIC:GetFirst()

Get the first unit from the set.

SET_STATIC:GetHeading()

Get the average heading of the SET_STATIC.

SET_STATIC:GetStaticTypes()

Returns map of unit types.

SET_STATIC:GetStaticTypesText()

Returns a comma separated string of the unit types with a count in the Core.Set.

SET_STATIC:GetTypeNames(Delimiter)

Retrieve the type names of the Wrapper.Statics in the SET, delimited by an optional delimiter.

SET_STATIC:GetVelocity()

Get the maximum velocity of the SET_STATIC.

SET_STATIC:IsIncludeObject(MStatic)

SET_STATIC:IsNotInZone(ZoneObject, Zone)

Check if no element of the SET_STATIC is in the Zone.

SET_STATIC:IsPartiallyInZone(Zone)

Check if minimal one element of the SET_STATIC is in the Zone.

SET_STATIC:New()

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

SET_STATIC:RemoveStaticsByName(RemoveStaticNames)

Remove STATIC(s) from SET_STATIC.

Fields and Methods inherited from SET_BASE Description

SET_STATIC:Add(ObjectName, Object)

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

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.

SET_STATIC.CallScheduler

SET_STATIC:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_STATIC:CompareSets(SetA, SetB)

Compare two sets.

SET_STATIC:Count()

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

SET_STATIC.Database

SET_STATIC.Filter

Filters

SET_STATIC:FilterClear()

Clear all filters.

SET_STATIC:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_STATIC:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_STATIC:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_STATIC:FilterOnce()

Filters for the defined collection.

SET_STATIC:FilterStop()

Stops the filtering for the defined collection.

SET_STATIC:FindNearestObjectFromPointVec2(PointVec2)

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

SET_STATIC:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_STATIC: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_STATIC: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_STATIC:Get(ObjectName)

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

SET_STATIC:GetFirst()

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

SET_STATIC:GetLast()

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

SET_STATIC:GetObjectNames()

Gets a string with all the object names.

SET_STATIC:GetRandom()

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

SET_STATIC:GetRandomSurely()

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

SET_STATIC:GetSet()

Gets the Set.

SET_STATIC:GetSetComplement(SetB)

Get the complement of two sets.

SET_STATIC:GetSetIntersection(SetB)

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

SET_STATIC:GetSetNames()

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

SET_STATIC:GetSetObjects()

Returns a table of the Objects in the Set.

SET_STATIC:GetSetUnion(SetB)

Get the union of two sets.

SET_STATIC:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_STATIC.Index

Table of indices.

SET_STATIC:IsInSet(Object)

Decides whether an object is in the SET

SET_STATIC:IsIncludeObject(Object)

Decides whether to include the Object.

SET_STATIC:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_STATIC.List

Unused table.

SET_STATIC: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_STATIC:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_STATIC:Remove(ObjectName, NoTriggerEvent)

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

SET_STATIC.Set

Table of objects.

SET_STATIC:SetDatabase(BaseSet)

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

SET_STATIC:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_STATIC.SomeIteratorLimit

SET_STATIC:SortByName()

Sort the set by name.

SET_STATIC:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_STATIC:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_STATIC:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_STATIC:_FilterStart()

Starts the filtering for the defined collection.

SET_STATIC:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_STATIC.ClassID

The ID number of the class.

SET_STATIC.ClassName

The name of the class.

SET_STATIC.ClassNameAndID

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

SET_STATIC:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_STATIC:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_STATIC:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_STATIC:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_STATIC:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_STATIC:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_STATIC:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_STATIC:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_STATIC:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_STATIC:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_STATIC:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_STATIC:E(Arguments)

Log an exception which will be traced always.

SET_STATIC:EventDispatcher()

Returns the event dispatcher

SET_STATIC:EventRemoveAll()

Remove all subscribed events

SET_STATIC:F(Arguments)

Trace a function call.

SET_STATIC:F2(Arguments)

Trace a function call level 2.

SET_STATIC:F3(Arguments)

Trace a function call level 3.

SET_STATIC:GetClassID()

Get the ClassID of the class instance.

SET_STATIC:GetClassName()

Get the ClassName of the class instance.

SET_STATIC:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_STATIC:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_STATIC:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_STATIC:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_STATIC:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_STATIC:I(Arguments)

Log an information which will be traced always.

SET_STATIC:Inherit(Child, Parent)

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

SET_STATIC:IsInstanceOf(ClassName)

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

SET_STATIC:IsTrace()

Enquires if tracing is on (for the class).

SET_STATIC:New()

BASE constructor.

SET_STATIC:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_STATIC:OnEventBDA(EventData)

BDA.

SET_STATIC:OnEventBaseCaptured(EventData)

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

SET_STATIC:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_STATIC:OnEventCrash(EventData)

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

SET_STATIC:OnEventDead(EventData)

Occurs when an object is dead.

SET_STATIC:OnEventDetailedFailure(EventData)

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

SET_STATIC:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_STATIC:OnEventDynamicCargoLoaded(EventData)

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

SET_STATIC:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_STATIC:OnEventDynamicCargoUnloaded(EventData)

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

SET_STATIC:OnEventEjection(EventData)

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

SET_STATIC:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_STATIC:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_STATIC:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_STATIC:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_STATIC:OnEventKill(EventData)

Occurs on the death of a unit.

SET_STATIC:OnEventLand(EventData)

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

SET_STATIC:OnEventLandingAfterEjection(EventData)

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

SET_STATIC:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_STATIC:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_STATIC:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_STATIC:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_STATIC:OnEventMissionEnd(EventData)

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

SET_STATIC:OnEventMissionStart(EventData)

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

SET_STATIC:OnEventNewDynamicCargo(EventData)

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

SET_STATIC:OnEventParatrooperLanding(EventData)

Weapon add.

SET_STATIC:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_STATIC:OnEventPlayerEnterAircraft(EventData)

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

SET_STATIC:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_STATIC:OnEventPlayerLeaveUnit(EventData)

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

SET_STATIC:OnEventRefueling(EventData)

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

SET_STATIC:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_STATIC:OnEventScore(EventData)

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

SET_STATIC:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_STATIC:OnEventShootingStart(EventData)

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

SET_STATIC:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_STATIC:OnEventTakeoff(EventData)

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

SET_STATIC:OnEventTriggerZone(EventData)

Trigger zone.

SET_STATIC:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_STATIC:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_STATIC.Scheduler

SET_STATIC:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_STATIC:SetState(Object, Key, Value)

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

SET_STATIC:T(Arguments)

Trace a function logic level 1.

SET_STATIC:T2(Arguments)

Trace a function logic level 2.

SET_STATIC:T3(Arguments)

Trace a function logic level 3.

SET_STATIC:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_STATIC:TraceClass(Class)

Set tracing for a class

SET_STATIC:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_STATIC:TraceLevel(Level)

Set trace level

SET_STATIC:TraceOff()

Set trace off.

SET_STATIC:TraceOn()

Set trace on.

SET_STATIC: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_STATIC:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_STATIC._

SET_STATIC:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_STATIC:_Serialize(Arguments)

(Internal) Serialize arguments

SET_STATIC:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_STATIC.__

SET_STATIC:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_UNIT Description

SET_UNIT:AddInDatabase(Event)

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

SET_UNIT:AddUnit(Unit)

Add UNIT(s) to SET_UNIT.

SET_UNIT:AddUnitsByName(AddUnitNames)

Add UNIT(s) to SET_UNIT.

SET_UNIT:CalculateThreatLevelA2G()

Calculate the maximum A2G threat level of the SET_UNIT.

SET_UNIT:CountAlive()

Count Alive Units

SET_UNIT:FilterActive(Active)

Builds a set of units that are only active.

SET_UNIT:FilterAlive()

Builds a set of units which exist and are alive.

SET_UNIT:FilterCategories(Categories)

Builds a set of units out of categories.

SET_UNIT:FilterCoalitions(Coalitions)

Builds a set of units of coalitions.

SET_UNIT:FilterCountries(Countries)

Builds a set of units of defined countries.

SET_UNIT:FilterFunction(ConditionFunction, ...)

[User] Add a custom condition function.

SET_UNIT:FilterHasRadar(RadarTypes)

Builds a set of units having a radar of give types.

SET_UNIT:FilterHasSEAD()

Builds a set of SEADable units.

SET_UNIT:FilterPrefixes(Prefixes)

Builds a set of UNITs that contain a given string in their unit name.

SET_UNIT:FilterStart()

Starts the filtering.

SET_UNIT:FilterStop()

Stops the filtering.

SET_UNIT:FilterTypes(Types)

Builds a set of units of defined unit types.

SET_UNIT:FilterZoneTimer(Seconds)

Set filter timer interval for FilterZones if using active filtering with FilterStart().

SET_UNIT:FilterZones(Zones)

Builds a set of units in zones.

SET_UNIT:FindInDatabase(Event)

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

SET_UNIT:FindUnit(UnitName)

Finds a Unit based on the Unit Name.

SET_UNIT:ForEachUnit(IteratorFunction, ...)

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

SET_UNIT:ForEachUnitCompletelyInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_UNIT and call an iterator function for each alive UNIT presence completely in a Core.Zone, providing the UNIT and optional parameters to the called function.

SET_UNIT:ForEachUnitNotInZone(ZoneObject, IteratorFunction, ...)

Iterate the SET_UNIT and call an iterator function for each alive UNIT presence not in a Core.Zone, providing the UNIT and optional parameters to the called function.

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.

SET_UNIT:GetAliveSet()

Gets the alive set.

SET_UNIT:GetCoordinate()

Get the center coordinate of the SET_UNIT.

SET_UNIT:GetFirst()

Get the first unit from the set.

SET_UNIT:GetHeading()

Get the average heading of the SET_UNIT.

SET_UNIT:GetSetPerThreatLevel(FromThreatLevel, ToThreatLevel)

Get the SET of the SET_UNIT sorted per Threat Level.

SET_UNIT:GetTypeNames(Delimiter)

Retrieve the type names of the Wrapper.Units in the SET, delimited by an optional delimiter.

SET_UNIT:GetUnitThreatLevels()

Returns map of unit threat levels.

SET_UNIT:GetUnitTypes()

Returns map of unit types.

SET_UNIT:GetUnitTypesText()

Returns a comma separated string of the unit types with a count in the Core.Set.

SET_UNIT:GetVelocity()

Get the maximum velocity of the SET_UNIT.

SET_UNIT:HasAirUnits()

Returns if the Core.Set has air targets.

SET_UNIT:HasFriendlyUnits(FriendlyCoalition)

Returns if the Core.Set has friendly ground units.

SET_UNIT:HasGroundUnits()

Returns if the Core.Set has ground targets.

SET_UNIT:HasRadar(RadarType)

Returns if the Core.Set has targets having a radar (of a given type).

SET_UNIT:HasSEAD()

Returns if the Core.Set has targets that can be SEADed.

SET_UNIT:IsIncludeObject(MUnit)

SET_UNIT:IsNotInZone(ZoneObject, Zone)

Check if no element of the SET_UNIT is in the Zone.

SET_UNIT:IsPartiallyInZone(ZoneTest)

Check if minimal one element of the SET_UNIT is in the Zone.

SET_UNIT:New()

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

SET_UNIT:RemoveUnitsByName(RemoveUnitNames)

Remove UNIT(s) from SET_UNIT.

SET_UNIT:SetCargoBayWeightLimit()

Iterate the SET_UNIT and set for each unit the default cargo bay weight limit.

SET_UNIT.ZoneTimer

SET_UNIT.ZoneTimerInterval

SET_UNIT:_ContinousZoneFilter()

[Internal] Private function for use of continous zone filter

Fields and Methods inherited from SET_BASE Description

SET_UNIT:Add(ObjectName, Object)

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

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.

SET_UNIT.CallScheduler

SET_UNIT:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_UNIT:CompareSets(SetA, SetB)

Compare two sets.

SET_UNIT:Count()

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

SET_UNIT.Database

SET_UNIT.Filter

Filters

SET_UNIT:FilterClear()

Clear all filters.

SET_UNIT:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_UNIT:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_UNIT:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_UNIT:FilterOnce()

Filters for the defined collection.

SET_UNIT:FilterStop()

Stops the filtering for the defined collection.

SET_UNIT:FindNearestObjectFromPointVec2(PointVec2)

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

SET_UNIT:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_UNIT: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_UNIT: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_UNIT:Get(ObjectName)

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

SET_UNIT:GetFirst()

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

SET_UNIT:GetLast()

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

SET_UNIT:GetObjectNames()

Gets a string with all the object names.

SET_UNIT:GetRandom()

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

SET_UNIT:GetRandomSurely()

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

SET_UNIT:GetSet()

Gets the Set.

SET_UNIT:GetSetComplement(SetB)

Get the complement of two sets.

SET_UNIT:GetSetIntersection(SetB)

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

SET_UNIT:GetSetNames()

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

SET_UNIT:GetSetObjects()

Returns a table of the Objects in the Set.

SET_UNIT:GetSetUnion(SetB)

Get the union of two sets.

SET_UNIT:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_UNIT.Index

Table of indices.

SET_UNIT:IsInSet(Object)

Decides whether an object is in the SET

SET_UNIT:IsIncludeObject(Object)

Decides whether to include the Object.

SET_UNIT:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_UNIT.List

Unused table.

SET_UNIT: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_UNIT:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_UNIT:Remove(ObjectName, NoTriggerEvent)

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

SET_UNIT.Set

Table of objects.

SET_UNIT:SetDatabase(BaseSet)

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

SET_UNIT:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_UNIT.SomeIteratorLimit

SET_UNIT:SortByName()

Sort the set by name.

SET_UNIT:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_UNIT:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_UNIT:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_UNIT:_FilterStart()

Starts the filtering for the defined collection.

SET_UNIT:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_UNIT.ClassID

The ID number of the class.

SET_UNIT.ClassName

The name of the class.

SET_UNIT.ClassNameAndID

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

SET_UNIT:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_UNIT:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_UNIT:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_UNIT:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_UNIT:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_UNIT:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_UNIT:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_UNIT:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_UNIT:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_UNIT:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_UNIT:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_UNIT:E(Arguments)

Log an exception which will be traced always.

SET_UNIT:EventDispatcher()

Returns the event dispatcher

SET_UNIT:EventRemoveAll()

Remove all subscribed events

SET_UNIT:F(Arguments)

Trace a function call.

SET_UNIT:F2(Arguments)

Trace a function call level 2.

SET_UNIT:F3(Arguments)

Trace a function call level 3.

SET_UNIT:GetClassID()

Get the ClassID of the class instance.

SET_UNIT:GetClassName()

Get the ClassName of the class instance.

SET_UNIT:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_UNIT:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_UNIT:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_UNIT:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_UNIT:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_UNIT:I(Arguments)

Log an information which will be traced always.

SET_UNIT:Inherit(Child, Parent)

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

SET_UNIT:IsInstanceOf(ClassName)

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

SET_UNIT:IsTrace()

Enquires if tracing is on (for the class).

SET_UNIT:New()

BASE constructor.

SET_UNIT:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_UNIT:OnEventBDA(EventData)

BDA.

SET_UNIT:OnEventBaseCaptured(EventData)

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

SET_UNIT:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_UNIT:OnEventCrash(EventData)

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

SET_UNIT:OnEventDead(EventData)

Occurs when an object is dead.

SET_UNIT:OnEventDetailedFailure(EventData)

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

SET_UNIT:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_UNIT:OnEventDynamicCargoLoaded(EventData)

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

SET_UNIT:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_UNIT:OnEventDynamicCargoUnloaded(EventData)

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

SET_UNIT:OnEventEjection(EventData)

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

SET_UNIT:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_UNIT:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_UNIT:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_UNIT:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_UNIT:OnEventKill(EventData)

Occurs on the death of a unit.

SET_UNIT:OnEventLand(EventData)

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

SET_UNIT:OnEventLandingAfterEjection(EventData)

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

SET_UNIT:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_UNIT:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_UNIT:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_UNIT:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_UNIT:OnEventMissionEnd(EventData)

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

SET_UNIT:OnEventMissionStart(EventData)

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

SET_UNIT:OnEventNewDynamicCargo(EventData)

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

SET_UNIT:OnEventParatrooperLanding(EventData)

Weapon add.

SET_UNIT:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_UNIT:OnEventPlayerEnterAircraft(EventData)

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

SET_UNIT:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_UNIT:OnEventPlayerLeaveUnit(EventData)

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

SET_UNIT:OnEventRefueling(EventData)

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

SET_UNIT:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_UNIT:OnEventScore(EventData)

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

SET_UNIT:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_UNIT:OnEventShootingStart(EventData)

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

SET_UNIT:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_UNIT:OnEventTakeoff(EventData)

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

SET_UNIT:OnEventTriggerZone(EventData)

Trigger zone.

SET_UNIT:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_UNIT:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_UNIT.Scheduler

SET_UNIT:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_UNIT:SetState(Object, Key, Value)

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

SET_UNIT:T(Arguments)

Trace a function logic level 1.

SET_UNIT:T2(Arguments)

Trace a function logic level 2.

SET_UNIT:T3(Arguments)

Trace a function logic level 3.

SET_UNIT:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_UNIT:TraceClass(Class)

Set tracing for a class

SET_UNIT:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_UNIT:TraceLevel(Level)

Set trace level

SET_UNIT:TraceOff()

Set trace off.

SET_UNIT:TraceOn()

Set trace on.

SET_UNIT: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_UNIT:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_UNIT._

SET_UNIT:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_UNIT:_Serialize(Arguments)

(Internal) Serialize arguments

SET_UNIT:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_UNIT.__

SET_UNIT:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_ZONE Description

SET_ZONE:AddInDatabase(Event)

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

SET_ZONE:AddZone(Zone)

Add ZONEs to SET_ZONE.

SET_ZONE:AddZonesByName(AddZoneNames)

Add ZONEs by a search name to SET_ZONE.

SET_ZONE.Checktime

SET_ZONE:DrawZone(Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly)

Draw all zones in the set on the F10 map.

SET_ZONE:FilterPrefixes(Prefixes)

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

SET_ZONE:FilterStart()

Starts the filtering.

SET_ZONE:FilterStop()

Stops the filtering for the defined collection.

SET_ZONE:FindInDatabase(Event)

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

SET_ZONE:FindZone(ZoneName)

Finds a Zone based on the Zone Name.

SET_ZONE:ForEachZone(IteratorFunction, ...)

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

SET_ZONE:GetAverageCoordinate()

Get the average aggregated coordinate of this set of zones.

SET_ZONE:GetClosestZone(Coordinate)

Get the closest zone to a given coordinate.

SET_ZONE:GetRandomZone(margin)

Get a random zone from the set.

SET_ZONE:IsCoordinateInZone(Coordinate)

Validate if a coordinate is in one of the zones in the set.

SET_ZONE:IsIncludeObject(MZone)

Private function.

SET_ZONE:New()

Creates a new SET_ZONE object, building a set of zones.

SET_ZONE:OnAfterEnteredZone(From, Event, To, Controllable, Zone)

On After "EnteredZone" event.

SET_ZONE:OnAfterLeftZone(From, Event, To, Controllable, Zone)

On After "LeftZone" event.

SET_ZONE:OnEventDeleteZone(EventData)

Handles the OnDead or OnCrash event for alive units set.

SET_ZONE:OnEventNewZone(EventData)

Handles the OnEventNewZone event for the Set.

SET_ZONE:RemoveZonesByName(RemoveZoneNames)

Remove ZONEs from SET_ZONE.

SET_ZONE:SetCheckTime(seconds)

Set the check time for SET_ZONE:Trigger()

SET_ZONE:SetZoneProbability(ZoneName, ZoneProbability)

Set a zone probability.

SET_ZONE:Trigger(Objects)

Start watching if the Object or Objects move into or out of our set of zones.

SET_ZONE:TriggerStop()

Triggers the FSM event "TriggerStop".

SET_ZONE:_TriggerCheck(fromstart)

(Internal) Check the assigned objects for being in/out of the zone

SET_ZONE:__TriggerStop(delay)

Triggers the FSM event "TriggerStop" after a delay.

SET_ZONE.checkobjects

SET_ZONE.objectset

SET_ZONE:onafterTriggerRunCheck(From, Event, to, To)

(Internal) Check the assigned objects for being in/out of the zone

Fields and Methods inherited from SET_BASE Description

SET_ZONE:Add(ObjectName, Object)

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

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.

SET_ZONE.CallScheduler

SET_ZONE:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_ZONE:CompareSets(SetA, SetB)

Compare two sets.

SET_ZONE:Count()

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

SET_ZONE.Database

SET_ZONE.Filter

Filters

SET_ZONE:FilterClear()

Clear all filters.

SET_ZONE:FilterCrashes()

Starts the filtering of the Crash events for the collection.

SET_ZONE:FilterDeads()

Starts the filtering of the Dead events for the collection.

SET_ZONE:FilterFunction(ConditionFunction, ...)

[Internal] Add a functional filter

SET_ZONE:FilterOnce()

Filters for the defined collection.

SET_ZONE:FilterStop()

Stops the filtering for the defined collection.

SET_ZONE:FindNearestObjectFromPointVec2(PointVec2)

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

SET_ZONE:Flush(MasterObject)

Flushes the current SET_BASE contents in the log ...

SET_ZONE: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_ZONE: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_ZONE:Get(ObjectName)

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

SET_ZONE:GetFirst()

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

SET_ZONE:GetLast()

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

SET_ZONE:GetObjectNames()

Gets a string with all the object names.

SET_ZONE:GetRandom()

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

SET_ZONE:GetRandomSurely()

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

SET_ZONE:GetSet()

Gets the Set.

SET_ZONE:GetSetComplement(SetB)

Get the complement of two sets.

SET_ZONE:GetSetIntersection(SetB)

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

SET_ZONE:GetSetNames()

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

SET_ZONE:GetSetObjects()

Returns a table of the Objects in the Set.

SET_ZONE:GetSetUnion(SetB)

Get the union of two sets.

SET_ZONE:GetSomeIteratorLimit()

Get the SET iterator "limit".

SET_ZONE.Index

Table of indices.

SET_ZONE:IsInSet(Object)

Decides whether an object is in the SET

SET_ZONE:IsIncludeObject(Object)

Decides whether to include the Object.

SET_ZONE:IsNotInSet(Object)

Decides whether an object is not in the SET

SET_ZONE.List

Unused table.

SET_ZONE: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_ZONE:OnAfterAdded(From, Event, To, ObjectName, Object)

Added Handler OnAfter for SET_BASE

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

Removed Handler OnAfter for SET_BASE

SET_ZONE:Remove(ObjectName, NoTriggerEvent)

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

SET_ZONE.Set

Table of objects.

SET_ZONE:SetDatabase(BaseSet)

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

SET_ZONE:SetSomeIteratorLimit(Limit)

Define the SET iterator "limit".

SET_ZONE.SomeIteratorLimit

SET_ZONE:SortByName()

Sort the set by name.

SET_ZONE:_EvalFilterFunctions(Object)

[Internal] Check if the condition functions returns true.

SET_ZONE:_EventOnBirth(Event)

Handles the OnBirth event for the Set.

SET_ZONE:_EventOnDeadOrCrash(Event)

Handles the OnDead or OnCrash event for alive units set.

SET_ZONE:_FilterStart()

Starts the filtering for the defined collection.

SET_ZONE:_Find(ObjectName)

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

Fields and Methods inherited from BASE Description

SET_ZONE.ClassID

The ID number of the class.

SET_ZONE.ClassName

The name of the class.

SET_ZONE.ClassNameAndID

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

SET_ZONE:ClearState(Object, StateName)

Clear the state of an object.

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

Creation of a Birth Event.

SET_ZONE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

Creation of a Crash Event.

SET_ZONE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

Creation of a Dead Event.

SET_ZONE:CreateEventDynamicCargoLoaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_LOADED event.

SET_ZONE:CreateEventDynamicCargoRemoved(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_REMOVED event.

SET_ZONE:CreateEventDynamicCargoUnloaded(DynamicCargo)

Creation of a S_EVENT_DYNAMIC_CARGO_UNLOADED event.

SET_ZONE:CreateEventNewDynamicCargo(DynamicCargo)

Creation of a S_EVENT_NEW_DYNAMIC_CARGO event.

SET_ZONE:CreateEventPlayerEnterAircraft(PlayerUnit)

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

SET_ZONE:CreateEventRemoveUnit(EventTime, Initiator)

Creation of a Remove Unit Event.

SET_ZONE:CreateEventTakeoff(EventTime, Initiator)

Creation of a Takeoff Event.

SET_ZONE:CreateEventUnitLost(EventTime, Initiator)

Creation of a Crash Event.

SET_ZONE:E(Arguments)

Log an exception which will be traced always.

SET_ZONE:EventDispatcher()

Returns the event dispatcher

SET_ZONE:EventRemoveAll()

Remove all subscribed events

SET_ZONE:F(Arguments)

Trace a function call.

SET_ZONE:F2(Arguments)

Trace a function call level 2.

SET_ZONE:F3(Arguments)

Trace a function call level 3.

SET_ZONE:GetClassID()

Get the ClassID of the class instance.

SET_ZONE:GetClassName()

Get the ClassName of the class instance.

SET_ZONE:GetClassNameAndID()

Get the ClassName + ClassID of the class instance.

SET_ZONE:GetEventPriority()

Get the Class Core.Event processing Priority.

SET_ZONE:GetParent(Child, FromClass)

This is the worker method to retrieve the Parent class.

SET_ZONE:GetState(Object, Key)

Get a Value given a Key from the Object.

SET_ZONE:HandleEvent(EventID, EventFunction)

Subscribe to a DCS Event.

SET_ZONE:I(Arguments)

Log an information which will be traced always.

SET_ZONE:Inherit(Child, Parent)

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

SET_ZONE:IsInstanceOf(ClassName)

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

SET_ZONE:IsTrace()

Enquires if tracing is on (for the class).

SET_ZONE:New()

BASE constructor.

SET_ZONE:OnEvent(EventData)

Occurs when an Event for an object is triggered.

SET_ZONE:OnEventBDA(EventData)

BDA.

SET_ZONE:OnEventBaseCaptured(EventData)

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

SET_ZONE:OnEventBirth(EventData)

Occurs when any object is spawned into the mission.

SET_ZONE:OnEventCrash(EventData)

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

SET_ZONE:OnEventDead(EventData)

Occurs when an object is dead.

SET_ZONE:OnEventDetailedFailure(EventData)

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

SET_ZONE:OnEventDiscardChairAfterEjection(EventData)

Discard chair after ejection.

SET_ZONE:OnEventDynamicCargoLoaded(EventData)

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

SET_ZONE:OnEventDynamicCargoRemoved(EventData)

Occurs when a dynamic cargo crate is removed.

SET_ZONE:OnEventDynamicCargoUnloaded(EventData)

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

SET_ZONE:OnEventEjection(EventData)

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

SET_ZONE:OnEventEngineShutdown(EventData)

Occurs when any aircraft shuts down its engines.

SET_ZONE:OnEventEngineStartup(EventData)

Occurs when any aircraft starts its engines.

SET_ZONE:OnEventHit(EventData)

Occurs whenever an object is hit by a weapon.

SET_ZONE:OnEventHumanFailure(EventData)

Occurs when any system fails on a human controlled aircraft.

SET_ZONE:OnEventKill(EventData)

Occurs on the death of a unit.

SET_ZONE:OnEventLand(EventData)

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

SET_ZONE:OnEventLandingAfterEjection(EventData)

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

SET_ZONE:OnEventLandingQualityMark(EventData)

Landing quality mark.

SET_ZONE:OnEventMarkAdded(EventData)

Occurs when a new mark was added.

SET_ZONE:OnEventMarkChange(EventData)

Occurs when a mark text was changed.

SET_ZONE:OnEventMarkRemoved(EventData)

Occurs when a mark was removed.

SET_ZONE:OnEventMissionEnd(EventData)

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

SET_ZONE:OnEventMissionStart(EventData)

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

SET_ZONE:OnEventNewDynamicCargo(EventData)

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

SET_ZONE:OnEventParatrooperLanding(EventData)

Weapon add.

SET_ZONE:OnEventPilotDead(EventData)

Occurs when the pilot of an aircraft is killed.

SET_ZONE:OnEventPlayerEnterAircraft(EventData)

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

SET_ZONE:OnEventPlayerEnterUnit(EventData)

Occurs when any player assumes direct control of a unit.

SET_ZONE:OnEventPlayerLeaveUnit(EventData)

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

SET_ZONE:OnEventRefueling(EventData)

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

SET_ZONE:OnEventRefuelingStop(EventData)

Occurs when an aircraft is finished taking fuel.

SET_ZONE:OnEventScore(EventData)

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

SET_ZONE:OnEventShootingEnd(EventData)

Occurs when any unit stops firing its weapon.

SET_ZONE:OnEventShootingStart(EventData)

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

SET_ZONE:OnEventShot(EventData)

Occurs whenever any unit in a mission fires a weapon.

SET_ZONE:OnEventTakeoff(EventData)

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

SET_ZONE:OnEventTriggerZone(EventData)

Trigger zone.

SET_ZONE:OnEventUnitLost(EventData)

Occurs when the game thinks an object is destroyed.

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

Schedule a new time event.

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

Schedule a new time event.

SET_ZONE:ScheduleStop(SchedulerID)

Stops the Schedule.

SET_ZONE.Scheduler

SET_ZONE:SetEventPriority(EventPriority)

Set the Class Core.Event processing Priority.

SET_ZONE:SetState(Object, Key, Value)

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

SET_ZONE:T(Arguments)

Trace a function logic level 1.

SET_ZONE:T2(Arguments)

Trace a function logic level 2.

SET_ZONE:T3(Arguments)

Trace a function logic level 3.

SET_ZONE:TraceAll(TraceAll)

Trace all methods in MOOSE

SET_ZONE:TraceClass(Class)

Set tracing for a class

SET_ZONE:TraceClassMethod(Class, Method)

Set tracing for a specific method of class

SET_ZONE:TraceLevel(Level)

Set trace level

SET_ZONE:TraceOff()

Set trace off.

SET_ZONE:TraceOn()

Set trace on.

SET_ZONE: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_ZONE:UnHandleEvent(EventID)

UnSubscribe to a DCS event.

SET_ZONE._

SET_ZONE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function call.

SET_ZONE:_Serialize(Arguments)

(Internal) Serialize arguments

SET_ZONE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

Trace a function logic.

SET_ZONE.__

SET_ZONE:onEvent(event)

The main event handling function...

Fields and Methods inherited from SET_ZONE_GOAL Description

SET_ZONE_GOAL:AddInDatabase(Event)

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

SET_ZONE_GOAL:AddZone(Zone)

Add ZONEs to SET_ZONE_GOAL.

SET_ZONE_GOAL:FilterPrefixes(Prefixes)

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

SET_ZONE_GOAL:FilterStart()

Starts the filtering.

SET_ZONE_GOAL:FilterStop()

Stops the filtering for the defined collection.

SET_ZONE_GOAL:FindInDatabase(Event)

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

SET_ZONE_GOAL:FindZone(ZoneName)

Finds a Zone based on the Zone Name.

SET_ZONE_GOAL:ForEachZone(IteratorFunction, ...)

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

SET_ZONE_GOAL:GetRandomZone()

Get a random zone from the set.

SET_ZONE_GOAL:IsCoordinateInZone(Coordinate)

Validate if a coordinate is in one of the zones in the set.

SET_ZONE_GOAL:IsIncludeObject(MZone)

SET_ZONE_GOAL:New()

Creates a new SET_ZONE_GOAL object, building a set of zones.

SET_ZONE_GOAL:OnEventDeleteZoneGoal(EventData)

Handles the OnDead or OnCrash event for alive units set.

SET_ZONE_GOAL:OnEventNewZoneGoal(EventData)

Handles the OnEventNewZone event for the Set.

SET_ZONE_GOAL:RemoveZonesByName(RemoveZoneNames)

Remove ZONEs from SET_ZONE_GOAL.

SET_ZONE_GOAL:SetZoneProbability(ZoneName, ZoneProbability)

Set a zone probability.

Fields and Methods inherited from SET_BASE Description

SET_ZONE_GOAL:Add(ObjectName, Object)

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

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.

SET_ZONE_GOAL.CallScheduler

SET_ZONE_GOAL:Clear(TriggerEvent)

Clear the Objects in the Set.

SET_ZONE_GOAL:CompareSets(SetA, SetB)

Compare two sets.

SET_ZONE_GOAL:Count()

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

SET_ZONE_GOAL.Database