diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 883c7b56e..3d5c23ecf 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -4986,11 +4986,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -11650,11 +11653,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -12912,11 +12918,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
@@ -14476,11 +14485,14 @@ They will lock the parking spot.

- + #boolean AI_A2A_DISPATCHER.SetSendPlayerMessages + +

Flash messages to player

+
diff --git a/Documentation/AI.AI_A2G_Dispatcher.html b/Documentation/AI.AI_A2G_Dispatcher.html index 2947b2057..2564069d6 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4855,17 +4855,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -4983,14 +4972,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -13420,17 +13406,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -13548,14 +13523,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -14760,17 +14732,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -14888,14 +14849,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
@@ -16402,17 +16360,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_A2G_DISPATCHER.DefenderPatrolIndex - - -
@@ -16530,14 +16477,11 @@ multiplied by the Overhead and rounded up to the smallest integer.

- #boolean + AI_A2G_DISPATCHER.SetSendPlayerMessages - -

flash messages to players

-
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index aa6ba7651..20c801a15 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -4615,17 +4615,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 7255a11e7..e008f9cd6 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -1973,7 +1973,7 @@ Therefore, this class is considered to be deprecated

- + Wrapper.Group#GROUP AI_CARGO.CargoCarrier diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 16f5f4f00..33d4addd3 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2865,6 +2865,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

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

Set destination airbase for next :Route() command.

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

Aircraft is on a depoly mission.

+ diff --git a/Documentation/AI.AI_Patrol.html b/Documentation/AI.AI_Patrol.html index fc04caee4..f42da9617 100644 --- a/Documentation/AI.AI_Patrol.html +++ b/Documentation/AI.AI_Patrol.html @@ -3373,9 +3373,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

This table contains the targets detected during patrol.

- @@ -6643,9 +6640,6 @@ The default interval is 30 seconds.

- -

This table contains the targets detected during patrol.

- @@ -7390,9 +7384,6 @@ The default interval is 30 seconds.

- -

This table contains the targets detected during patrol.

- @@ -9025,9 +9016,6 @@ The default interval is 30 seconds.

- -

This table contains the targets detected during patrol.

- diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index 914709ec0..342054a25 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -2016,20 +2016,6 @@ Therefore, this class is considered to be deprecated

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- - -
-
- - CARGO_GROUP.CargoGroup diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 14092a68c..d1d2215ce 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -17010,6 +17010,17 @@ When moose is loading dynamically (for moose class development), tracing is swit
+POINT_VEC2.x + + + +
+ +
+
+
+ + POINT_VEC2.z diff --git a/Documentation/Core.Set.html b/Documentation/Core.Set.html index b1f2b62ac..9aa4e552c 100644 --- a/Documentation/Core.Set.html +++ b/Documentation/Core.Set.html @@ -2060,6 +2060,31 @@ 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.

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

SET_AIRBASE:SetDatabase(BaseSet)

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

- - - -

SET_AIRBASE:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -3320,18 +3339,6 @@ The following iterator methods are currently available within the SET_ZONE_GOAL:

SET_AIRBASE:SortByName()

Sort the set by name.

- - - -

SET_AIRBASE.TimeInterval

- - - - - -

SET_AIRBASE.YieldInterval

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

SET_BASE:SetDatabase(BaseSet)

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

- - - -

SET_BASE:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -4200,18 +4201,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_BASE:SortByName()

Sort the set by name.

- - - -

SET_BASE.TimeInterval

- - - - - -

SET_BASE.YieldInterval

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

SET_CARGO:SetDatabase(BaseSet)

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

- - - -

SET_CARGO:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -5264,18 +5247,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_CARGO:SortByName()

Sort the set by name.

- - - -

SET_CARGO.TimeInterval

- - - - - -

SET_CARGO.YieldInterval

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

SET_CLIENT:SetDatabase(BaseSet)

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

- - - -

SET_CLIENT:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -6340,18 +6305,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_CLIENT:SortByName()

Sort the set by name.

- - - -

SET_CLIENT.TimeInterval

- - - - - -

SET_CLIENT.YieldInterval

- - @@ -6924,6 +6877,1112 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_CLIENT:onEvent(event)

The main event handling function...

+ + + +
+ +

Type SET_DYNAMICCARGO

+
+ SET_DYNAMICCARGO +, extends Core.Set#SET_BASE +, extends Core.Base#BASE +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from SET_DYNAMICCARGODescription

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

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 BASEDescription

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

+
+
+ +

Type SET_DYNAMICCARGO.Filters

+
+ SET_DYNAMICCARGO.Filters +
+
+ + + + + + + + + + + + + + + + + + + + + + + +
Fields and Methods inherited from SET_DYNAMICCARGO.FiltersDescription

SET_DYNAMICCARGO.Filters.Coalitions

+ +

SET_DYNAMICCARGO.Filters.Countries

+ +

SET_DYNAMICCARGO.Filters.StaticPrefixes

+ +

SET_DYNAMICCARGO.Filters.Types

+ +

SET_DYNAMICCARGO.Filters.Zones

+
@@ -7515,12 +8574,6 @@ mission designer to add a dedicated method

SET_GROUP:SetDatabase(BaseSet)

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

- - - -

SET_GROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -7539,18 +8592,6 @@ mission designer to add a dedicated method

SET_GROUP:SortByName()

Sort the set by name.

- - - -

SET_GROUP.TimeInterval

- - - - - -

SET_GROUP.YieldInterval

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

SET_OPSGROUP:SetDatabase(BaseSet)

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

- - - -

SET_OPSGROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -8602,18 +9637,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_OPSGROUP:SortByName()

Sort the set by name.

- - - -

SET_OPSGROUP.TimeInterval

- - - - - -

SET_OPSGROUP.YieldInterval

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

SET_OPSZONE:SetDatabase(BaseSet)

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

- - - -

SET_OPSZONE:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -9617,18 +10634,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_OPSZONE:SortByName()

Sort the set by name.

- - - -

SET_OPSZONE.TimeInterval

- - - - - -

SET_OPSZONE.YieldInterval

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

SET_PLAYER:SetDatabase(BaseSet)

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

- - - -

SET_PLAYER:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -10608,18 +11607,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_PLAYER:SortByName()

Sort the set by name.

- - - -

SET_PLAYER.TimeInterval

- - - - - -

SET_PLAYER.YieldInterval

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

SET_SCENERY:SetDatabase(BaseSet)

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

- - - -

SET_SCENERY:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -11605,18 +12586,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_SCENERY:SortByName()

Sort the set by name.

- - - -

SET_SCENERY.TimeInterval

- - - - - -

SET_SCENERY.YieldInterval

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

SET_STATIC:SetDatabase(BaseSet)

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

- - - -

SET_STATIC:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -12686,18 +13649,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_STATIC:SortByName()

Sort the set by name.

- - - -

SET_STATIC.TimeInterval

- - - - - -

SET_STATIC.YieldInterval

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

SET_UNIT:SetDatabase(BaseSet)

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

- - - -

SET_UNIT:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -13871,18 +14816,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_UNIT:SortByName()

Sort the set by name.

- - - -

SET_UNIT.TimeInterval

- - - - - -

SET_UNIT.YieldInterval

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

SET_ZONE:SetDatabase(BaseSet)

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

- - - -

SET_ZONE:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -14946,18 +15873,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_ZONE:SortByName()

Sort the set by name.

- - - -

SET_ZONE.TimeInterval

- - - - - -

SET_ZONE.YieldInterval

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

SET_ZONE_GOAL:SetDatabase(BaseSet)

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

- - - -

SET_ZONE_GOAL:SetIteratorIntervals(YieldInterval, TimeInterval)

- -

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

@@ -15931,18 +16840,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

SET_ZONE_GOAL:SortByName()

Sort the set by name.

- - - -

SET_ZONE_GOAL.TimeInterval

- - - - - -

SET_ZONE_GOAL.YieldInterval

- - @@ -18879,63 +19776,6 @@ DBObject = SET_BASE:New()
- - - -
- -
-

SET_AIRBASE:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -22661,28 +23501,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Table of objects.

- - - -
-
- - -SET_BASE.TimeInterval - - - -
- -
-
-
- - -SET_BASE.YieldInterval - - -
@@ -24303,63 +25121,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_BASE:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

-
-

SET_BASE

-
-

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -24684,28 +25445,6 @@ DBObject = SET_BASE:New()

Table of objects.

- - - -
-
- - -SET_BASE.TimeInterval - - - -
- -
-
-
- - -SET_BASE.YieldInterval - - -
@@ -30725,63 +31464,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_CARGO:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -37414,63 +38096,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_CLIENT:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -41143,6 +41768,6547 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +

Type SET_DYNAMICCARGO

+
+
+
+

Field(s)

+
+
+ + +
+
+ + +
+
+
+ + #table +SET_DYNAMICCARGO.Index + +

Table of indices.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.List + +

Unused table.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.Set + +

Table of objects.

+ +
+ +
+
+
+ + Core.Timer#TIMER +SET_DYNAMICCARGO.ZoneTimer + +

Timer for active filtering of zones.

+ +
+ +
+
+ + +
+
+

Function(s)

+
+
+ + + +

Builds a set of dynamic cargo of defined coalitions.

+ + +

Possible current coalitions are red, blue and neutral.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + Coalitions +

+
+
+ +

Can take the following values: "red", "blue", "neutral".

+ +
+
+

Return value:

+
+ +
+ +

self

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

Builds a set of dynamic cargo of defined countries.

+ + +

Possible current countries are those known within DCS world.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + Countries +

+
+
+ +

Can take those country strings known within DCS world.

+ +
+
+

Return value:

+
+ +
+ +

self

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

This filter is N/A for SET_DYNAMICCARGO

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + PlayerName +

+
+
+

+
+
+

Return value:

+
+ +
+ +

self

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

This filter is N/A for SET_DYNAMICCARGO

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

[User] Add a custom condition function.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameters:

+
+
+

+ #function + ConditionFunction +

+
+
+ +

If this function returns true, the object is added to the SET. The function needs to take a DYNAMICCARGO object as first argument.

+ +
+
+
+
+

+ ... +

+
+
+ +

Condition function arguments if any.

+ +
+
+

Return value:

+
+ +
+ +

self

+ +
+
+

Usage:

+
         -- Image you want to exclude a specific DYNAMICCARGO from a SET:
+         local cargoset = SET_DYNAMICCARGO:New():FilterCoalitions("blue"):FilterFunction(
+         -- The function needs to take a DYNAMICCARGO object as first - and in this case, only - argument.
+         function(dynamiccargo)
+             local isinclude = true
+             if dynamiccargo:GetName() == "Exclude Me" then isinclude = false end
+             return isinclude
+         end
+         ):FilterOnce()
+         BASE:I(cargoset:Flush())
+ +
+ +
+
+ +
+ + + +

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

+ + +

is on board of a Chinook).

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

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

+ + +

new and never loaded into a Chinook).

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

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

+ + +

was on board of a Chinook previously and is now unloaded).

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

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

+ + +

Attention! LUA Regex applies!

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + Patterns +

+
+
+ +

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

+ +
+
+

Return value:

+
+ +
+ +

self

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

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

+ + +

Attention! Bad naming convention as this does not filter only prefixes but all names that contain the string. LUA Regex applies.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + Prefixes +

+
+
+ +

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

+ +
+
+

Return value:

+
+ +
+ +

self

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

Starts the filtering.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

Stops the filtering.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #string + Types +

+
+
+ +

Can take those type name strings known within DCS world.

+ +
+
+

Return value:

+
+ +
+ +

self

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #number + Seconds +

+
+
+ +

Seconds between check intervals, defaults to 30. Caution - do not be too agressive with timing! Objects are usually not moving fast enough +to warrant a check of below 10 seconds.

+ +
+
+

Return value:

+
+ +
+ +

self

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

Builds a set of dynamic cargo in zones.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ #table + Zones +

+
+
+ +

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

+ +
+
+

Return value:

+
+ +
+ +

self

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

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

+ + +

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + Event +

+
+
+

+
+
+

Return values:

+
+
+

#string:

+
+
+ +

The name of the DYNAMICCARGO

+ +
+ +
+ +

The DYNAMICCARGO object

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+
+

#list<#string>:

+
+
+ +

Ownerlist

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+
+

#list<#string>:

+
+
+ +

Ownerlist

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+
+

#list<Wrapper.Storage#STORAGE>:

+
+
+ +

Storagelist

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

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+ +
+

+
+
+

Return value:

+
+ +
+ +

self

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

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

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ + + +
+
+

Usage:

+
-- Define a new SET_DYNAMICCARGO Object. This DBObject will contain a reference to all alive Statics.
+DBObject = SET_DYNAMICCARGO:New()
+ +
+ +
+
+ +
+ + + +

[Internal] Private function for use of continous zone filter

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Return value:

+
+ +
+ +

self

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

Handles the events for the Set.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + Event +

+
+
+

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

Handles the remove event for dynamic cargo set.

+ +
+
+

Defined in:

+
+

SET_DYNAMICCARGO

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + Event +

+
+
+

+
+
+
+ +
+
+ +
+

Field(s)

+
+
+ + +
+
+ + +
+
+
+ + #table +SET_DYNAMICCARGO.Index + +

Table of indices.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.List + +

Unused table.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.Set + +

Table of objects.

+ +
+ +
+
+
+ + Core.Timer#TIMER +SET_DYNAMICCARGO.ZoneTimer + +

Timer for active filtering of zones.

+ +
+ +
+
+ + +
+
+

Function(s)

+
+
+ + + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + ObjectName +

+
+
+ +

The name of the object.

+ +
+
+
+
+

+ Core.Base#BASE + Object +

+
+
+ +

The object itself.

+ +
+
+

Return value:

+
+ +
+ +

The added BASE Object.

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Wrapper.Object#OBJECT + Object +

+
+
+

+
+
+

Return value:

+
+ +
+ +

The added BASE Object.

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

Add a SET to this set.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetToAdd +

+
+
+ +

Set to add.

+ +
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Clear the Objects in the Set.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #boolean + TriggerEvent +

+
+
+ +

If true, an event remove is triggered for each group that is removed from the set.

+ +
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Compare two sets.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Set#SET_BASE + SetA +

+
+
+ +

First set.

+ +
+
+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set to be merged into first set.

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#number:

+
+
+ +

Count

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

Clear all filters.

+ + +

You still need to apply :FilterOnce()

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Starts the filtering of the Crash events for the collection.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Starts the filtering of the Dead events for the collection.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

[Internal] Add a functional filter

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #function + ConditionFunction +

+
+
+ +

If this function returns true, the object is added to the SET. The function needs to take a CONTROLLABLE object as first argument.

+ +
+
+
+
+

+ ... +

+
+
+ +

Condition function arguments, if any.

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, at least one condition is true

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

Filters for the defined collection.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Stops the filtering for the defined collection.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Point#POINT_VEC2 + PointVec2 +

+
+
+ +

A Core.Point#COORDINATE or Core.Point#POINT_VEC2 object (but not a simple DCS#Vec2!) from where to evaluate the closest object in the set.

+ +
+
+

Return value:

+
+ +
+ +

The closest object.

+ +
+
+

Usage:

+
         myset:FindNearestObjectFromPointVec2( ZONE:New("Test Zone"):GetCoordinate() )
+ +
+ +
+
+ +
+ + + +

Flushes the current SET_BASE contents in the log ...

+ + +

(for debugging reasons).

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Base#BASE + MasterObject +

+
+
+ +

(Optional) The master object as a reference.

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

A string with the names of the objects.

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

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #function + IteratorFunction +

+
+
+ +

The function that will be called.

+ +
+
+
+
+

+ #table + arg +

+
+
+ +

Arguments of the IteratorFunction.

+ +
+
+
+
+

+ #SET_BASE + Set +

+
+
+ +

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

+ +
+
+
+
+

+ #function + Function +

+
+
+ +

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

+ +
+
+
+
+

+ #table + FunctionArguments +

+
+
+ +

(Optional) Function arguments.

+ +
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #function + IteratorFunction +

+
+
+ +

The function that will be called.

+ +
+
+
+
+

+ arg +

+
+
+

+
+
+
+
+

+ Set +

+
+
+

+
+
+
+
+

+ Function +

+
+
+

+
+
+
+
+

+ FunctionArguments +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #string + ObjectName +

+
+
+

+
+
+

Return value:

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

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

+ +
+
+

Defined in:

+ +

Return value:

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

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

+ +
+
+

Defined in:

+ +

Return value:

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

Gets a string with all the object names.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

A string with the names of the objects.

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

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

+ +
+
+

Defined in:

+ +

Return value:

+
+ +
+ +

or nil if none found or the SET is empty!

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

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

+ + +

A bit slower than SET_BASE.GetRandom() but tries to ensure you get an object back if the SET is not empty.

+ +
+
+

Defined in:

+ +

Return value:

+
+ +
+ +

or nil if the SET is empty!

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

Gets the Set.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Get the complement of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set other set, called B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#table:

+
+
+ +

Table of names.

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

Returns a table of the Objects in the Set.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#table:

+
+
+ +

Table of objects.

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

Get the union of two sets.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Set#SET_BASE + SetB +

+
+
+ +

Set B .

+ +
+
+

Return value:

+
+ +
+ +

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

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

Get the SET iterator "limit".

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#number:

+
+
+ +

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

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

Decides whether an object is in the SET

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #table + Object +

+
+
+

+
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

true if object is in set and false otherwise.

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

Decides whether to include the Object.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #table + Object +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Decides whether an object is not in the SET

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #table + Object +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Database +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ + + +
+
+

Usage:

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

Added Handler OnAfter for SET_BASE

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + From +

+
+
+

+
+
+
+
+

+ #string + Event +

+
+
+

+
+
+
+
+

+ #string + To +

+
+
+

+
+
+
+
+

+ #string + ObjectName +

+
+
+ +

The name of the object.

+ +
+
+
+
+

+ Object +

+
+
+ +

The object.

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

Removed Handler OnAfter for SET_BASE

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + From +

+
+
+

+
+
+
+
+

+ #string + Event +

+
+
+

+
+
+
+
+

+ #string + To +

+
+
+

+
+
+
+
+

+ #string + ObjectName +

+
+
+ +

The name of the object.

+ +
+
+
+
+

+ Object +

+
+
+ +

The object.

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

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + ObjectName +

+
+
+

+
+
+
+
+

+ #boolean + NoTriggerEvent +

+
+
+ +

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

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #SET_BASE + BaseSet +

+
+
+

+
+
+

Return value:

+
+
+

#SET_BASE:

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

Define the SET iterator "limit".

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #number + Limit +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

Sort the set by name.

+ +
+
+

Defined in:

+ +

Return value:

+
+ +
+ +

The added BASE Object.

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

[Internal] Check if the condition functions returns true.

+ +
+
+

Defined in:

+ +

Parameter:

+
+ +
+ +

The object to filter for

+ +
+
+

Return value:

+
+
+

#boolean:

+
+
+ +

If true, if all conditions are true

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

Handles the OnBirth event for the Set.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + Event +

+
+
+

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

Handles the OnDead or OnCrash event for alive units set.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + Event +

+
+
+

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

Starts the filtering for the defined collection.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#SET_BASE:

+
+
+ +

self

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #string + ObjectName +

+
+
+

+
+
+

Return value:

+
+ +
+ +

The Object found.

+ +
+
+
+ +
+
+ +
+

Field(s)

+
+
+ + +
+
+ + +
+
+
+ + #table +SET_DYNAMICCARGO.Index + +

Table of indices.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.List + +

Unused table.

+ +
+ +
+
+
+ + #table +SET_DYNAMICCARGO.Set + +

Table of objects.

+ +
+ +
+
+
+ + Core.Timer#TIMER +SET_DYNAMICCARGO.ZoneTimer + +

Timer for active filtering of zones.

+ +
+ +
+
+ + +
+
+

Function(s)

+
+
+ + + +

Clear the state of an object.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

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

Creation of a Birth Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

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

Creation of a Crash Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

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

Creation of a Dead Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

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

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

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

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Creation of a Crash Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Returns the event dispatcher

+ +
+
+

Defined in:

+ +

Return value:

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

Remove all subscribed events

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#BASE:

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

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

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

Get the Class Core.Event processing Priority.

+ + +

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

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#number:

+
+
+ +

The Core.Event processing Priority.

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

This is the worker method to retrieve the Parent class.

+ + +

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

+ +
self:GetParent(self):ParentMethod()
+
+ + + +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

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

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

Get a Value given a Key from the Object.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+
+
+ +

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

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

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

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

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

+ + + +

Examples:

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

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

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

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

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

  • +
+ + +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ ClassName +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#boolean:

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

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+ +

Return value:

+
+
+

#boolean:

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

BASE constructor.

+ + + +

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

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

Defined in:

+ +

Return value:

+
+
+

#BASE:

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

Occurs when an Event for an object is triggered.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

BDA.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any object is spawned into the mission.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when an object is dead.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Will update this page when new information become available.

+ +
    +
  • initiator: The unit that had the failure.
  • +
+ + +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Discard chair after ejection.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that has ejected

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any aircraft shuts down its engines.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any aircraft starts its engines.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs whenever an object is hit by a weapon.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any system fails on a human controlled aircraft.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs on the death of a unit.

+ + +

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

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Landing quality mark.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a new mark was added.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mark text was changed.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when a mark was removed.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Weapon add.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when the pilot of an aircraft is killed.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any player assumes direct control of a unit.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when an aircraft is finished taking fuel.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when any unit stops firing its weapon.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs whenever any unit in a mission fires a weapon.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

Have a look at the class Core.Event#EVENT as these are just the prototypes. +initiator : The unit that tookoff +place: Object from where the AI took-off from. Can be an Airbase Object, FARP, or Ships

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Trigger zone.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Occurs when the game thinks an object is destroyed.

+ + +

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

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

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

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

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

Stops the Schedule.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #string + SchedulerID +

+
+
+ +

(Optional) Scheduler ID to be stopped. If nil, all pending schedules are stopped.

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

Set the Class Core.Event processing Priority.

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Core.Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Object +

+
+
+ +

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

+ +
+
+
+
+

+ Key +

+
+
+ +

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

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

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

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

Trace all methods in MOOSE

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

Set tracing for a class

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

Set tracing for a specific method of class

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

Set trace level

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #number + Level +

+
+
+

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

Set trace off.

+ +
+
+

Defined in:

+ +

Usage:

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

Set trace on.

+ +
+
+

Defined in:

+ +

Usage:

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

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

+ + +

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

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+

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

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

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

(Internal) Serialize arguments

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ #table + Arguments +

+
+
+

+
+
+

Return value:

+
+
+

#string:

+
+
+ +

Text

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

Trace a function logic.

+ +
+
+

Defined in:

+ +

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

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

The main event handling function...

+ + +

This function captures all events generated for the class.

+ +
+
+

Defined in:

+ +

Parameter:

+
+
+

+ DCS#Event + event +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

Type SET_DYNAMICCARGO.Filters

+
+
+
+

Field(s)

+
+
+ + +
+
+ + +
+
+ + +
+
+
+ + #string +SET_DYNAMICCARGO.Filters.Types + + + +
+ +
+
+
+ + #string +SET_DYNAMICCARGO.Filters.Zones + + + +
+ +
+
+

Function(s)

+
@@ -45193,63 +52359,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_GROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -51836,63 +58945,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_OPSGROUP:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -58048,63 +65100,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_OPSZONE:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -64194,63 +71189,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_PLAYER:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -70260,63 +77198,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_SCENERY:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -77020,63 +83901,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_STATIC:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -84395,63 +91219,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_UNIT:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -91188,63 +97955,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_ZONE:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
@@ -97219,63 +103929,6 @@ DBObject = SET_BASE:New() - - - -
- -
-

SET_ZONE_GOAL:SetIteratorIntervals(YieldInterval, TimeInterval)

-
- -

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

- -
-
-

Defined in:

- -

Parameters:

-
-
-

- #number - YieldInterval -

-
-
- -

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

- -
-
-
-
-

- #number - TimeInterval -

-
-
- -

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

- -
-
-

Return value:

-
-
-

#SET_BASE:

-
-
- -

self

- -
-
-
-
diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 59902cec4..1c5526265 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2964,7 +2964,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -5121,7 +5121,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 4c688fdbb..28edf4f1a 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -3206,6 +3206,42 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.frequency

+ + + + + +

SPAWN.hidden

+ + + + + +

SPAWN.livery_id

+ + + + + +

SPAWN.modulation

+ + + + + +

SPAWN.skill

+ + @@ -3808,14 +3844,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

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

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

-
@@ -4001,6 +4031,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnGrouping + + +
@@ -4197,6 +4238,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

By default, no InitLimit

+ + + +
+
+ + +SPAWN.SpawnInitLivery + + +
@@ -4208,6 +4260,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -4410,17 +4473,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -4455,7 +4507,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

+

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

@@ -4529,6 +4581,72 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
@@ -10139,14 +10257,11 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #boolean + SPAWN.AIOnOff - -

The AI is on by default when spawning a group.

-
@@ -10227,9 +10342,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+ + +
+
+ + +SPAWN.SpawnGrouping + + +
@@ -10528,6 +10651,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

+ + + +
+
+ + +SPAWN.SpawnInitLivery + + +
@@ -10539,6 +10673,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + #string +SPAWN.SpawnInitSkill + + +
@@ -10741,17 +10886,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+

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

@@ -10860,6 +10994,72 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ + +
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.hidden + + + +
+ +
+
+
+ + +SPAWN.livery_id + + + +
+ +
+
+
+ + +SPAWN.modulation + + + +
+ +
+
+
+ + +SPAWN.skill + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index e24172e6d..a17f33ffa 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -3075,7 +3075,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table SPAWNSTATIC.TemplateStaticUnit @@ -4687,7 +4687,7 @@ Handy if you spawn from cargo statics which have resources already set.

- + #table SPAWNSTATIC.TemplateStaticUnit diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index e811973f2..6d3554cac 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3993,7 +3993,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + ATC_GROUND.Airbases @@ -4578,7 +4578,7 @@ An airbase can be specified to set the maximum kick speed for.

- #table + ATC_GROUND.Airbases diff --git a/Documentation/Functional.Designate.html b/Documentation/Functional.Designate.html index 6f0ee156b..5bd5aaedf 100644 --- a/Documentation/Functional.Designate.html +++ b/Documentation/Functional.Designate.html @@ -2679,17 +2679,6 @@ Use the method DESIGNATE.SetMission() to -
- -
-
-
- - #table -DESIGNATE.LaserCodes - - -
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index c314506e4..60e1cf604 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19657,6 +19657,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -24404,6 +24415,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -26146,6 +26168,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual +
+ +
+
+
+ + #boolean +DETECTION_BASE.Locking + + +
diff --git a/Documentation/Functional.Mantis.html b/Documentation/Functional.Mantis.html index b0c0e4674..aa8df5cf2 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -2132,6 +2132,12 @@ in the mission editor are absolute maximum ranges; in-game this is rather 50-75%

MANTIS:GetCommandCenter()

Function to get the HQ object for further use

+ + + +

MANTIS.Groupset

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

Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects.

+ + + +
+
+ + +MANTIS.Groupset + + +
@@ -4683,50 +4700,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -4796,6 +4769,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

switch alarm state RED

+ @@ -8893,6 +8869,17 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Table of Core.Zone#ZONE Zones Consider SAM groups in this zone(s) only for this MANTIS instance, must be handed as #table of Zone objects.

+ + + +
+
+ + +MANTIS.Groupset + + +
@@ -9383,50 +9370,6 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

- - - -
-
- - #number -MANTIS.maxclassic - - - -
- -
-
-
- - #number -MANTIS.maxlongrange - - - -
- -
-
-
- - #number -MANTIS.maxmidrange - - - -
- -
-
-
- - #number -MANTIS.maxshortrange - - -
@@ -9496,6 +9439,9 @@ E.g. `mymantis:SetAdvancedMode(true, 90)` + +

switch alarm state RED

+ diff --git a/Documentation/Functional.Movement.html b/Documentation/Functional.Movement.html index ffa98b126..62684ec36 100644 --- a/Documentation/Functional.Movement.html +++ b/Documentation/Functional.Movement.html @@ -2379,20 +2379,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive.

- -
- -
@@ -2623,20 +2609,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

-
-
- - #number -MOVEMENT.AliveUnits - - - - -

Contains the counter how many units are currently alive.

- -
- -
diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 05bc6aed9..edc0f887c 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -3573,6 +3573,12 @@ manager:Stop(7200)

RAT.termtype

Type of terminal to be used when spawning at an airbase.

+ + + +

RAT.type

+ + @@ -4756,6 +4762,42 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.communication

+ + + + + +

RAT.frequency

+ + + + + +

RAT.hidden

+ + + + + +

RAT.livery_id

+ + + + + +

RAT.modulation

+ + + + + +

RAT.skill

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

Type of terminal to be used when spawning at an airbase.

+
+ +
+
+
+ + +RAT.type + + +
@@ -15039,6 +15092,17 @@ Initializes the ratcraft array and group menu.

Type of terminal to be used when spawning at an airbase.

+
+ +
+
+
+ + +RAT.type + + +
@@ -21845,6 +21909,17 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

Type of terminal to be used when spawning at an airbase.

+ + + +
+
+ + +RAT.type + + +
diff --git a/Documentation/Ops.Airboss.html b/Documentation/Ops.Airboss.html index 0e647c142..dd6963ec0 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -9729,17 +9729,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

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

Radio queue of LSO.

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

Radio queue of marshal.

- - - -
-
- - -AIRBOSS.RQMid - - -
@@ -40904,9 +40838,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set current case.

- @@ -41138,7 +41069,7 @@ When moose is loading dynamically (for moose class development), tracing is swit -

Set section lead of player flight.

+

Make player section lead if he was not before.

@@ -41359,6 +41290,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

Band modulation.

+ + + +
+
+ + +AIRBOSS.Radio.voice + + +
diff --git a/Documentation/Ops.CSAR.html b/Documentation/Ops.CSAR.html index 3421b5974..41493866b 100644 --- a/Documentation/Ops.CSAR.html +++ b/Documentation/Ops.CSAR.html @@ -4947,20 +4947,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

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

counter for successful rescue landings at FARP/AFB/MASH

- -
-
@@ -11093,20 +11065,6 @@ callsigns from playername or group name.

-
-
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

- -
-
@@ -11132,20 +11090,6 @@ callsigns from playername or group name.

-
-
-
- - #number -CSAR.rescues - - - - -

counter for successful rescue landings at FARP/AFB/MASH

- -
-
@@ -13635,20 +13579,6 @@ callsigns from playername or group name.

-
-
-
- - #number -CSAR.rescuedpilots - - - - -

counter for saved pilots

- -
-
@@ -13674,20 +13604,6 @@ callsigns from playername or group name.

-
-
-
- - #number -CSAR.rescues - - - - -

counter for successful rescue landings at FARP/AFB/MASH

- -
-
diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index 9f611c387..583a56ad4 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -7968,7 +7968,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.CtldUnits @@ -8076,7 +8076,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #table + CTLD.FreeVHFFrequencies @@ -8201,11 +8201,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + CTLD.RadioPath + +

Folderpath.

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -8717,7 +8731,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

time to repairor build a unit/group

+

noob catch

@@ -8805,7 +8819,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + CTLD.troopdropzoneradius @@ -18489,7 +18503,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -18597,7 +18611,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies @@ -18722,11 +18736,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -18968,6 +18985,17 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -19238,7 +19266,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -19326,7 +19354,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -20923,7 +20951,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.CtldUnits @@ -21031,7 +21059,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #table + CTLD.FreeVHFFrequencies @@ -21156,11 +21184,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- #string + CTLD.RadioPath + +

Folderpath.

+
@@ -21402,6 +21433,17 @@ However, if you create a new folder inside the miz file, which contains the soun

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -21672,7 +21714,7 @@ However, if you create a new folder inside the miz file, which contains the soun -

time to repairor build a unit/group

+

noob catch

@@ -21760,7 +21802,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -26090,17 +26132,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Location (if set) where to get this cargo item.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
@@ -27388,17 +27419,6 @@ When moose is loading dynamically (for moose class development), tracing is swit

Location (if set) where to get this cargo item.

-
- -
-
-
- - -CTLD_CARGO.Mark - - -
diff --git a/Documentation/Tasking.Task_A2A_Dispatcher.html b/Documentation/Tasking.Task_A2A_Dispatcher.html index f427a9351..ad0d6f2fd 100644 --- a/Documentation/Tasking.Task_A2A_Dispatcher.html +++ b/Documentation/Tasking.Task_A2A_Dispatcher.html @@ -3050,7 +3050,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -3775,7 +3775,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -4951,7 +4951,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask @@ -6429,7 +6429,7 @@ If too large, any airborne cap may not be able to reach the detected target area
- + #boolean TASK_A2A_DISPATCHER.FlashNewTask diff --git a/Documentation/Tasking.Task_A2G_Dispatcher.html b/Documentation/Tasking.Task_A2G_Dispatcher.html index a2f329359..981b7237e 100644 --- a/Documentation/Tasking.Task_A2G_Dispatcher.html +++ b/Documentation/Tasking.Task_A2G_Dispatcher.html @@ -3320,14 +3320,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + TASK_A2G_DISPATCHER.FlashNewTask - -

set to false to suppress flash messages

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

set to false to suppress flash messages

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

set to false to suppress flash messages

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

set to false to suppress flash messages

-
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index 425e988ff..61edc9ea1 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3387,6 +3387,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+ @@ -4537,6 +4548,17 @@ This method can only be used once!

+
+ +
+ @@ -5439,6 +5461,17 @@ This method can only be used once!

+
+ +
+ @@ -6972,6 +7005,17 @@ This method can only be used once!

+
+ +
+ diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index 7fed38508..505401364 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -3371,17 +3371,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

-
- -
-
-
- - #number -FIFO.uniquecounter - - -
@@ -4231,17 +4220,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

-
- -
-
-
- - #number -FIFO.uniquecounter - - -
diff --git a/Documentation/Wrapper.DynamicCargo.html b/Documentation/Wrapper.DynamicCargo.html index a5781a04f..eef09eba2 100644 --- a/Documentation/Wrapper.DynamicCargo.html +++ b/Documentation/Wrapper.DynamicCargo.html @@ -1857,12 +1857,18 @@

DYNAMICCARGO:GetDCSObject()

Get DCS object.

+ + + +

DYNAMICCARGO:GetLastOwner()

+ +

Get last known owner name of this DYNAMICCARGO

DYNAMICCARGO:GetLastPosition()

-

Get last know owner (player) name of this DYNAMICCARGO

+

Find last known position of this DYNAMICCARGO

@@ -1887,6 +1893,30 @@

DYNAMICCARGO.Interval

Check Interval. 20 secs default.

+ + + +

DYNAMICCARGO:IsLoaded()

+ +

Returns true if the cargo been loaded into a Helo.

+ + + +

DYNAMICCARGO:IsNew()

+ +

Returns true if the cargo is new and has never been loaded into a Helo.

+ + + +

DYNAMICCARGO:IsRemoved()

+ +

Returns true if the cargo has been removed.

+ + + +

DYNAMICCARGO:IsUnloaded()

+ +

Returns true if the cargo has been unloaded from a Helo.

@@ -3968,6 +3998,36 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+
+ + +
+ +
+

DYNAMICCARGO:GetLastOwner()

+
+ +

Get last known owner name of this DYNAMICCARGO

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Return value:

+
+
+

#string:

+
+
+ +

Owner

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

DYNAMICCARGO:GetLastPosition()

-

Get last know owner (player) name of this DYNAMICCARGO

+

Find last known position of this DYNAMICCARGO

@@ -4087,6 +4147,126 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
+ + + +
+ +
+

DYNAMICCARGO:IsLoaded()

+
+ +

Returns true if the cargo been loaded into a Helo.

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Outcome

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

DYNAMICCARGO:IsNew()

+
+ +

Returns true if the cargo is new and has never been loaded into a Helo.

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Outcome

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

DYNAMICCARGO:IsRemoved()

+
+ +

Returns true if the cargo has been removed.

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Outcome

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

DYNAMICCARGO:IsUnloaded()

+
+ +

Returns true if the cargo has been unloaded from a Helo.

+ +
+
+

Defined in:

+
+

DYNAMICCARGO

+
+

Return value:

+
+
+

#boolean:

+
+
+ +

Outcome

+ +
+
+
+
diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index ca414715e..9906e7793 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -5474,7 +5474,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ + +
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -10288,7 +10299,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu + +
+
+ +
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -27294,7 +27327,18 @@ Coordinates are dependent on the position of the maps origin.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -27949,7 +27993,18 @@ If the Identifiable is alive, true is returned.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -28205,7 +28260,18 @@ If the Identifiable is alive, true is returned.

+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index be499938e..de69c03bf 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -3133,6 +3133,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -3210,28 +3232,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

-
- -
-
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -5272,6 +5272,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5349,28 +5371,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

-
- - -
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -
@@ -6882,6 +6882,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+ + + +
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6959,28 +6981,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Text displayed in the mark panel.

- - - -
-
- - #boolean -MARKER.toall - - - -
- -
-
-
- - #boolean -MARKER.tocoalition - - -