From 98900621ce5e679af1eee358187995eec39165fd Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Thu, 14 Dec 2023 10:15:41 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_A2A_Dispatcher.html | 20 +- Documentation/AI.AI_A2G_Dispatcher.html | 20 +- Documentation/AI.AI_Air.html | 44 - Documentation/AI.AI_Air_Dispatcher.html | 44 - Documentation/AI.AI_Air_Squadron.html | 22 - Documentation/AI.AI_Cargo.html | 8 +- Documentation/AI.AI_Cargo_Airplane.html | 68 +- Documentation/Cargo.CargoCrate.html | 22 - Documentation/Cargo.CargoGroup.html | 62 +- Documentation/Cargo.CargoUnit.html | 22 - Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 4053 ++++++++++++++++- Documentation/Core.Settings.html | 36 +- Documentation/Core.Spawn.html | 198 +- Documentation/Core.SpawnStatic.html | 84 + Documentation/Core.Spot.html | 99 + Documentation/Functional.ATC_Ground.html | 10 +- Documentation/Functional.Detection.html | 99 +- Documentation/Functional.Mantis.html | 96 +- Documentation/Functional.RAT.html | 57 + Documentation/Ops.Airboss.html | 22 +- Documentation/Ops.CTLD.html | 194 +- Documentation/Sound.SRS.html | 32 +- Documentation/Tasking.Task.html | 22 + Documentation/Tasking.Task_CARGO.html | 13 +- .../Tasking.Task_Cargo_Dispatcher.html | 220 - Documentation/Utilities.FiFo.html | 44 +- Documentation/Wrapper.Group.html | 78 +- Documentation/Wrapper.Marker.html | 72 +- Documentation/Wrapper.Positionable.html | 44 - 30 files changed, 5010 insertions(+), 799 deletions(-) diff --git a/Documentation/AI.AI_A2A_Dispatcher.html b/Documentation/AI.AI_A2A_Dispatcher.html index 218364666..0dbf08969 100644 --- a/Documentation/AI.AI_A2A_Dispatcher.html +++ b/Documentation/AI.AI_A2A_Dispatcher.html @@ -4876,14 +4876,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -11543,14 +11540,11 @@ They will lock the parking spot.

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -12808,14 +12802,11 @@ They will lock the parking spot.

- #boolean + AI_A2A_DISPATCHER.SetSendPlayerMessages - -

Flash messages to player

-
@@ -14375,14 +14366,11 @@ 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 60720110e..bcb6fab4c 100644 --- a/Documentation/AI.AI_A2G_Dispatcher.html +++ b/Documentation/AI.AI_A2G_Dispatcher.html @@ -4878,11 +4878,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -13400,11 +13403,14 @@ multiplied by the Overhead and rounded up to the smallest integer.

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -14728,11 +14734,14 @@ multiplied by the Overhead and rounded up to the smallest integer.

- + #boolean AI_A2G_DISPATCHER.SetSendPlayerMessages + +

flash messages to players

+
@@ -16358,11 +16367,14 @@ 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.html b/Documentation/AI.AI_Air.html index 20850b47e..24807f361 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3078,17 +3078,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -5917,17 +5906,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -6675,17 +6653,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
@@ -8321,17 +8288,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.IdleCount - - -
diff --git a/Documentation/AI.AI_Air_Dispatcher.html b/Documentation/AI.AI_Air_Dispatcher.html index 16ab626f0..e5f79260b 100644 --- a/Documentation/AI.AI_Air_Dispatcher.html +++ b/Documentation/AI.AI_Air_Dispatcher.html @@ -4516,17 +4516,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 - - -
@@ -9824,17 +9813,6 @@ multiplied by the Overhead and rounded up to the smallest integer.

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

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

The Defender Default Settings over all Squadrons.

- - - -
-
- - #number -AI_AIR_DISPATCHER.DefenderPatrolIndex - - -
diff --git a/Documentation/AI.AI_Air_Squadron.html b/Documentation/AI.AI_Air_Squadron.html index ca3a03ff5..7f173ddbf 100644 --- a/Documentation/AI.AI_Air_Squadron.html +++ b/Documentation/AI.AI_Air_Squadron.html @@ -2563,17 +2563,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
@@ -3645,17 +3634,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -AI_AIR_SQUADRON.ResourceCount - - -
diff --git a/Documentation/AI.AI_Cargo.html b/Documentation/AI.AI_Cargo.html index 6cbfca874..ad13105cf 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2759,7 +2759,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -4789,7 +4789,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -5401,7 +5401,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier @@ -6901,7 +6901,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- Wrapper.Group#GROUP + AI_CARGO.CargoCarrier diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 43dc65147..4d9605eea 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2746,6 +2746,20 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + + +

Set destination airbase for next :Route() command.

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

Aircraft is on a pickup mission.

-
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index e7b130cb3..912d4862a 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1867,17 +1867,6 @@ Therefore, this class is considered to be deprecated

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
@@ -2546,17 +2535,6 @@ Therefore, this class is considered to be deprecated

Field(s)

-
-
- - -CARGO_CRATE.CargoCarrier - - - -
- -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index dbf7cc4c0..2ceff13c5 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1938,27 +1938,10 @@ Therefore, this class is considered to be deprecated

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup - -

Then we register the new group in the database

-
@@ -1970,6 +1953,20 @@ Therefore, this class is considered to be deprecated

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

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

+
@@ -3259,27 +3256,10 @@ This works for ground only groups.

-CARGO_GROUP.CargoCarrier - - - - -

self.CargoObject:Destroy()

- -
- -
-
-
- - CARGO_GROUP.CargoGroup - -

Then we register the new group in the database

-
@@ -3291,6 +3271,20 @@ This works for ground only groups.

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

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

+
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 72c02aadb..0fec1ae3d 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1816,17 +1816,6 @@ Therefore, this class is considered to be deprecated

-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir @@ -2531,17 +2520,6 @@ Therefore, this class is considered to be deprecated

-CARGO_UNIT.CargoCarrier - - - -
- -
-
-
- - CARGO_UNIT.CargoInAir diff --git a/Documentation/Core.Fsm.html b/Documentation/Core.Fsm.html index e2b6bc060..383eaa450 100644 --- a/Documentation/Core.Fsm.html +++ b/Documentation/Core.Fsm.html @@ -5796,7 +5796,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState @@ -7395,7 +7395,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + FSM._StartState diff --git a/Documentation/Core.Point.html b/Documentation/Core.Point.html index 0ea66ab26..f16c09c96 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -1975,6 +1975,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these

Type COORDINATE

COORDINATE +, extends Core.Base#BASE
@@ -2046,6 +2047,12 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these + + + + @@ -2417,7 +2424,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these @@ -2849,7 +2856,7 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these @@ -2939,19 +2946,555 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these + +

COORDINATE:CircleToAll(Radius, Coalition, Color, Alpha, FillColor, FillAlpha, LineType, ReadOnly, Text)

Circle to all.

+

COORDINATE.ClassName

 +

Name of the class

COORDINATE.Heading

 - +

Heading in degrees. Needs to be set first.

COORDINATE.Velocity

 - +

Velocity in meters per second. Needs to be set first.

COORDINATE.x

 - +

Component of the 3D vector.

COORDINATE.y

 - +

Component of the 3D vector.

COORDINATE.z

 +

Component of the 3D vector.

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

COORDINATE.ClassID

 +

The ID number of the class.

+

COORDINATE.ClassName

 +

The name of the class.

+

COORDINATE.ClassNameAndID

 +

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

+

COORDINATE:ClearState(Object, StateName)

 +

Clear the state of an object.

+

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

 +

Creation of a Birth Event.

+

COORDINATE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Crash Event.

+

COORDINATE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 +

Creation of a Dead Event.

+

COORDINATE:CreateEventPlayerEnterAircraft(PlayerUnit)

 +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+

COORDINATE:CreateEventRemoveUnit(EventTime, Initiator)

 +

Creation of a Remove Unit Event.

+

COORDINATE:CreateEventTakeoff(EventTime, Initiator)

 +

Creation of a Takeoff Event.

+

COORDINATE:CreateEventUnitLost(EventTime, Initiator)

 +

Creation of a Crash Event.

+

COORDINATE:E(Arguments)

 +

Log an exception which will be traced always.

+

COORDINATE:EventDispatcher()

 +

Returns the event dispatcher

+

COORDINATE:EventRemoveAll()

 +

Remove all subscribed events

+

COORDINATE:F(Arguments)

 +

Trace a function call.

+

COORDINATE:F2(Arguments)

 +

Trace a function call level 2.

+

COORDINATE:F3(Arguments)

 +

Trace a function call level 3.

+

COORDINATE:GetClassID()

 +

Get the ClassID of the class instance.

+

COORDINATE:GetClassName()

 +

Get the ClassName of the class instance.

+

COORDINATE:GetClassNameAndID()

 +

Get the ClassName + ClassID of the class instance.

+

COORDINATE:GetEventPriority()

 +

Get the Class Core.Event processing Priority.

+

COORDINATE:GetParent(Child, FromClass)

 +

This is the worker method to retrieve the Parent class.

+

COORDINATE:GetState(Object, Key)

 +

Get a Value given a Key from the Object.

+

COORDINATE:HandleEvent(EventID, EventFunction)

 +

Subscribe to a DCS Event.

+

COORDINATE:I(Arguments)

 +

Log an information which will be traced always.

+

COORDINATE:Inherit(Child, Parent)

 +

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

+

COORDINATE:IsInstanceOf(ClassName)

 +

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

+

COORDINATE:IsTrace()

 +

Enquires if tracing is on (for the class).

+

COORDINATE:New()

 +

BASE constructor.

+

COORDINATE:OnEvent(EventData)

 +

Occurs when an Event for an object is triggered.

+

COORDINATE:OnEventBDA(EventData)

 +

BDA.

+

COORDINATE:OnEventBaseCaptured(EventData)

 +

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

+

COORDINATE:OnEventBirth(EventData)

 +

Occurs when any object is spawned into the mission.

+

COORDINATE:OnEventCrash(EventData)

 +

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

+

COORDINATE:OnEventDead(EventData)

 +

Occurs when an object is dead.

+

COORDINATE:OnEventDetailedFailure(EventData)

 +

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

+

COORDINATE:OnEventDiscardChairAfterEjection(EventData)

 +

Discard chair after ejection.

+

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

+

COORDINATE:OnEventEngineShutdown(EventData)

 +

Occurs when any aircraft shuts down its engines.

+

COORDINATE:OnEventEngineStartup(EventData)

 +

Occurs when any aircraft starts its engines.

+

COORDINATE:OnEventHit(EventData)

 +

Occurs whenever an object is hit by a weapon.

+

COORDINATE:OnEventHumanFailure(EventData)

 +

Occurs when any system fails on a human controlled aircraft.

+

COORDINATE:OnEventKill(EventData)

 +

Occurs on the death of a unit.

+

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

+

COORDINATE:OnEventLandingAfterEjection(EventData)

 +

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

+

COORDINATE:OnEventLandingQualityMark(EventData)

 +

Landing quality mark.

+

COORDINATE:OnEventMarkAdded(EventData)

 +

Occurs when a new mark was added.

+

COORDINATE:OnEventMarkChange(EventData)

 +

Occurs when a mark text was changed.

+

COORDINATE:OnEventMarkRemoved(EventData)

 +

Occurs when a mark was removed.

+

COORDINATE:OnEventMissionEnd(EventData)

 +

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

+

COORDINATE:OnEventMissionStart(EventData)

 +

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

+

COORDINATE:OnEventParatrooperLanding(EventData)

 +

Weapon add.

+

COORDINATE:OnEventPilotDead(EventData)

 +

Occurs when the pilot of an aircraft is killed.

+

COORDINATE:OnEventPlayerEnterAircraft(EventData)

 +

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

+

COORDINATE:OnEventPlayerEnterUnit(EventData)

 +

Occurs when any player assumes direct control of a unit.

+

COORDINATE:OnEventPlayerLeaveUnit(EventData)

 +

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

+

COORDINATE:OnEventRefueling(EventData)

 +

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

+

COORDINATE:OnEventRefuelingStop(EventData)

 +

Occurs when an aircraft is finished taking fuel.

+

COORDINATE:OnEventScore(EventData)

 +

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

+

COORDINATE:OnEventShootingEnd(EventData)

 +

Occurs when any unit stops firing its weapon.

+

COORDINATE:OnEventShootingStart(EventData)

 +

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

+

COORDINATE:OnEventShot(EventData)

 +

Occurs whenever any unit in a mission fires a weapon.

+

COORDINATE:OnEventTakeoff(EventData)

 +

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

+

COORDINATE:OnEventTriggerZone(EventData)

 +

Trigger zone.

+

COORDINATE:OnEventUnitLost(EventData)

 +

Occurs when the game thinks an object is destroyed.

+

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

 +

Schedule a new time event.

+

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

 +

Schedule a new time event.

+

COORDINATE:ScheduleStop(SchedulerID)

 +

Stops the Schedule.

+

COORDINATE.Scheduler

 +

COORDINATE:SetEventPriority(EventPriority)

 +

Set the Class Core.Event processing Priority.

+

COORDINATE:SetState(Object, Key, Value)

 +

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

+

COORDINATE:T(Arguments)

 +

Trace a function logic level 1.

+

COORDINATE:T2(Arguments)

 +

Trace a function logic level 2.

+

COORDINATE:T3(Arguments)

 +

Trace a function logic level 3.

+

COORDINATE:TraceAll(TraceAll)

 +

Trace all methods in MOOSE

+

COORDINATE:TraceClass(Class)

 +

Set tracing for a class

+

COORDINATE:TraceClassMethod(Class, Method)

 +

Set tracing for a specific method of class

+

COORDINATE:TraceLevel(Level)

 +

Set trace level

+

COORDINATE:TraceOff()

 +

Set trace off.

+

COORDINATE:TraceOn()

 +

Set trace on.

+

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

+

COORDINATE:UnHandleEvent(EventID)

 +

UnSubscribe to a DCS event.

+

COORDINATE._

 + +

COORDINATE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function call.

+

COORDINATE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 +

Trace a function logic.

+

COORDINATE.__

 + +

COORDINATE:onEvent(event)

 +

The main event handling function...
@@ -3473,10 +4016,10 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
+ #string +COORDINATE.ClassName -COORDINATE.Heading - - +

Name of the class

@@ -3484,10 +4027,21 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
+ #number +COORDINATE.Heading +

Heading in degrees. Needs to be set first.

+ +
+ +
+
+
+ + #number COORDINATE.Velocity - +

Velocity in meters per second. Needs to be set first.

@@ -3528,10 +4082,10 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
- + #number COORDINATE.x - +

Component of the 3D vector.

@@ -3539,10 +4093,10 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
- + #number COORDINATE.y - +

Component of the 3D vector.

@@ -3550,10 +4104,10 @@ Note that the Set and Add methods return the current POINT_VEC3 object, so these
- + #number COORDINATE.z - +

Component of the 3D vector.

@@ -9084,26 +9638,26 @@ By default, the last point is the closest point on road of the ToCoord. Hence, t

- #number + #string Easting

-

Meters easting

+

Meters easting - string in order to allow for leading zeros, e.g. "01234". Should be 5 digits.

- #number + #string Northing

-

Meters northing

+

Meters northing - string in order to allow for leading zeros, e.g. "12340". Should be 5 digits.

@@ -12534,6 +13088,3458 @@ Creates a line on the F10 map from one point to another.

+
+

Field(s)

+
+
+
+ + #string +COORDINATE.ClassName + +

Name of the class

+ +
+ +
+
+
+ + #number +COORDINATE.Heading + +

Heading in degrees. Needs to be set first.

+ +
+ +
+
+
+ + #number +COORDINATE.Velocity + +

Velocity in meters per second. Needs to be set first.

+ +
+ +
+ + + +
+
+ + #number +COORDINATE.x + +

Component of the 3D vector.

+ +
+ +
+
+
+ + #number +COORDINATE.y + +

Component of the 3D vector.

+ +
+ +
+
+
+ + #number +COORDINATE.z + +

Component of the 3D vector.

+ +
+ +
+
+

Function(s)

+
+
+ +
+

COORDINATE:ClearState(Object, StateName)

+
+ +

Clear the state of an object.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ StateName +

+
+
+ +

The key that is should be cleared.

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

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

+
+ +

Creation of a Birth Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ #string + IniUnitName +

+
+
+ +

The initiating unit name.

+ +
+
+
+
+

+ place +

+
+
+

+
+
+
+
+

+ subplace +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:CreateEventDead(EventTime, Initiator, IniObjectCategory)

+
+ +

Creation of a Dead Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

+ +
+
+
+
+

+ IniObjectCategory +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:CreateEventPlayerEnterAircraft(PlayerUnit)

+
+ +

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Wrapper.Unit#UNIT + PlayerUnit +

+
+
+ +

The aircraft unit the player entered.

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

COORDINATE:CreateEventRemoveUnit(EventTime, Initiator)

+
+ +

Creation of a Remove Unit Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

COORDINATE:CreateEventTakeoff(EventTime, Initiator)

+
+ +

Creation of a Takeoff Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

COORDINATE:CreateEventUnitLost(EventTime, Initiator)

+
+ +

Creation of a Crash Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ DCS#Time + EventTime +

+
+
+ +

The time stamp of the event.

+ +
+
+
+
+

+ DCS#Object + Initiator +

+
+
+ +

The initiating object of the event.

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

COORDINATE:E(Arguments)

+
+ +

Log an exception which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:EventDispatcher()

+
+ +

Returns the event dispatcher

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

Core.Event#EVENT:

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

COORDINATE:EventRemoveAll()

+
+ +

Remove all subscribed events

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

COORDINATE:F(Arguments)

+
+ +

Trace a function call.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:F2(Arguments)

+
+ +

Trace a function call level 2.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:F3(Arguments)

+
+ +

Trace a function call level 3.

+ + +

Must be at the beginning of the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:GetClassID()

+
+ +

Get the ClassID of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassID of the class instance.

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

COORDINATE:GetClassName()

+
+ +

Get the ClassName of the class instance.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName of the class instance.

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

COORDINATE:GetClassNameAndID()

+
+ +

Get the ClassName + ClassID of the class instance.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#string:

+
+
+ +

The ClassName + ClassID of the class instance.

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

COORDINATE:GetEventPriority()

+
+ +

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:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#number:

+
+
+ +

The Core.Event processing Priority.

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

COORDINATE:GetParent(Child, FromClass)

+
+ +

This is the worker method to retrieve the Parent class.

+ + +

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

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

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #BASE + Child +

+
+
+ +

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

+ +
+
+
+
+

+ #BASE + FromClass +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

COORDINATE:GetState(Object, Key)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

The object that holds the Value set by the Key.

+ +
+
+
+
+

+ Key +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+
+
+ +

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

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

COORDINATE:HandleEvent(EventID, EventFunction)

+
+ +

Subscribe to a DCS Event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+
+
+

+ #function + EventFunction +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#BASE:

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

COORDINATE:I(Arguments)

+
+ +

Log an information which will be traced always.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:Inherit(Child, Parent)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Child +

+
+
+ +

is the Child class that inherits.

+ +
+
+
+
+

+ #BASE + Parent +

+
+
+ +

is the Parent class that the Child inherits from.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

Child

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

COORDINATE:IsInstanceOf(ClassName)

+
+ +

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

+ + + +

Examples:

+ +
    +

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

    • +

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

    • +

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

    • +

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

    • +

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

    • +
+ + +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ ClassName +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#boolean:

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

COORDINATE:IsTrace()

+
+ +

Enquires if tracing is on (for the class).

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#boolean:

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

COORDINATE:New()

+
+ +

BASE constructor.

+ + + +

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

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

Defined in:

+
+

Core.Base#BASE

+
+

Return value:

+
+
+

#BASE:

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

COORDINATE:OnEvent(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventBDA(EventData)

+
+ +

BDA.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventBaseCaptured(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventBirth(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventCrash(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventDead(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventDetailedFailure(EventData)

+
+ +

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

+ + +

Will update this page when new information become available.

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

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventDiscardChairAfterEjection(EventData)

+
+ +

Discard chair after ejection.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

initiator : The unit that has ejected

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventEngineShutdown(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventEngineStartup(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventHit(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventHumanFailure(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventKill(EventData)

+
+ +

Occurs on the death of a unit.

+ + +

Contains more and different information. Similar to unit_lost it will occur for aircraft before the aircraft crash event occurs. +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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventLandingAfterEjection(EventData)

+
+ +

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

+ + +

Event does not occur if the pilot lands in the water and sub combs to Davey Jones Locker. +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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventLandingQualityMark(EventData)

+
+ +

Landing quality mark.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventMarkAdded(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventMarkChange(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventMarkRemoved(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventMissionEnd(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventMissionStart(EventData)

+
+ +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventParatrooperLanding(EventData)

+
+ +

Weapon add.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventPilotDead(EventData)

+
+ +

Occurs when the pilot of an aircraft is killed.

+ + +

Can occur either if the player is alive and crashes or if a weapon kills the pilot without completely destroying the plane. +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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventPlayerEnterAircraft(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventPlayerEnterUnit(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventPlayerLeaveUnit(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventRefueling(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventRefuelingStop(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventScore(EventData)

+
+ +

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

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventShootingEnd(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventShootingStart(EventData)

+
+ +

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

+ + +

Most common with aircraft cannons (GAU-8), autocannons, and machine guns. +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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventShot(EventData)

+
+ +

Occurs whenever any unit in a mission fires a weapon.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventTakeoff(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventTriggerZone(EventData)

+
+ +

Trigger zone.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

COORDINATE:OnEventUnitLost(EventData)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTDATA + EventData +

+
+
+ +

The EventData structure.

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

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

+
+ +

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

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

+
+ +

Schedule a new time event.

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #number + Start +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Repeat +

+
+
+ +

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

+ +
+
+
+
+

+ #number + RandomizeFactor +

+
+
+ +

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

+ +
+
+
+
+

+ #number + Stop +

+
+
+ +

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

+ +
+
+
+
+

+ #function + SchedulerFunction +

+
+
+ +

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

+ +
+
+
+
+

+ #table + ... +

+
+
+ +

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

+ +
+
+

Return value:

+
+
+

#string:

+
+
+ +

The Schedule ID of the planned schedule.

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

COORDINATE:ScheduleStop(SchedulerID)

+
+ +

Stops the Schedule.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + SchedulerID +

+
+
+ +

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

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

COORDINATE:SetEventPriority(EventPriority)

+
+ +

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:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + EventPriority +

+
+
+ +

The Core.Event processing Priority.

+ +
+
+

Return value:

+
+
+

#BASE:

+
+
+ +

self

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

COORDINATE:SetState(Object, Key, Value)

+
+ +

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

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Object +

+
+
+ +

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

+ +
+
+
+
+

+ Key +

+
+
+ +

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

+ +
+
+
+
+

+ Value +

+
+
+ +

The value to is stored in the object.

+ +
+
+

Return value:

+
+
+
+
+ +

The Value set.

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

COORDINATE:T(Arguments)

+
+ +

Trace a function logic level 1.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:T2(Arguments)

+
+ +

Trace a function logic level 2.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:T3(Arguments)

+
+ +

Trace a function logic level 3.

+ + +

Can be anywhere within the function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

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

COORDINATE:TraceAll(TraceAll)

+
+ +

Trace all methods in MOOSE

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceAll +

+
+
+ +

true = trace all methods in MOOSE.

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

COORDINATE:TraceClass(Class)

+
+ +

Set tracing for a class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

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

COORDINATE:TraceClassMethod(Class, Method)

+
+ +

Set tracing for a specific method of class

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ #string + Class +

+
+
+ +

Class name.

+ +
+
+
+
+

+ #string + Method +

+
+
+ +

Method.

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

COORDINATE:TraceLevel(Level)

+
+ +

Set trace level

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #number + Level +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:TraceOff()

+
+ +

Set trace off.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

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

COORDINATE:TraceOn()

+
+ +

Set trace on.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Usage:

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

COORDINATE:TraceOnOff(TraceOnOff)

+
+ +

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

+ + +

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

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ #boolean + TraceOnOff +

+
+
+ +

Switch the tracing on or off.

+ +
+
+

Usage:

+ 

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

COORDINATE:UnHandleEvent(EventID)

+
+ +

UnSubscribe to a DCS event.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ Core.Event#EVENTS + EventID +

+
+
+ +

Event ID.

+ +
+
+

Return value:

+
+
+

#BASE:

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

COORDINATE:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function call.

+ + +

This function is private.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

+
+ +

Trace a function logic.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameters:

+
+
+

+ Arguments +

+
+
+ +

A #table or any field.

+ +
+
+
+
+

+ DebugInfoCurrentParam +

+
+
+

+
+
+
+
+

+ DebugInfoFromParam +

+
+
+

+
+
+
+ +
+
+ +
+ +
+

COORDINATE:onEvent(event)

+
+ +

The main event handling function...

+ + +

This function captures all events generated for the class.

+ +
+
+

Defined in:

+
+

Core.Base#BASE

+
+

Parameter:

+
+
+

+ DCS#Event + event +

+
+
+

+
+
+
+ +
+
+
@@ -12797,17 +16803,6 @@ Creates a line on the F10 map from one point to another.

Field(s)

-
-
- - -POINT_VEC2.x - - - -
- -

Function(s)

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index 2a5cc36af..7d9483da4 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2853,7 +2853,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2ASystem @@ -2869,6 +2869,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

BASE:E( {PlayerUnit:GetName(), A2GSystem } )

+
@@ -2908,22 +2911,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
@@ -5021,7 +5013,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2ASystem @@ -5037,6 +5029,9 @@ It is advised to use this method at the start of the mission.

+ +

BASE:E( {PlayerUnit:GetName(), A2GSystem } )

+
@@ -5076,22 +5071,11 @@ It is advised to use this method at the start of the mission.

- + #boolean SETTINGS.Metric -
- -
-
-
- - -SETTINGS.PlayerMenu - - -
diff --git a/Documentation/Core.Spawn.html b/Documentation/Core.Spawn.html index 76360a4ed..c0d149e2a 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2988,6 +2988,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

SPAWN.communication

+ + + + + +

SPAWN.frequency

+ + + + + +

SPAWN.modulation

+ + @@ -3553,14 +3571,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.

-
@@ -3685,20 +3700,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

-
@@ -3768,6 +3769,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -3892,8 +3904,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + +
@@ -3948,7 +3968,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxGroups @@ -3962,7 +3982,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + SPAWN.SpawnMaxUnitsAlive @@ -4119,17 +4139,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - #boolean -SPAWN.SpawnUnControlled - - -
@@ -4164,7 +4173,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -

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

+

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

@@ -4241,6 +4250,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
@@ -9494,14 +9536,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.

-
@@ -9626,20 +9665,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - #number -SPAWN.SpawnCount - - - - -

The internal counter of the amount of spawning the has happened since SpawnStart.

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

+ +
+
+
+ + +SPAWN.SpawnInitAirbase + + +
@@ -9833,8 +9869,16 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ -

By default, no InitLimit

+SPAWN.SpawnInitLivery + +
@@ -9889,7 +9933,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxGroups @@ -9903,7 +9947,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- #number + SPAWN.SpawnMaxUnitsAlive @@ -10060,17 +10104,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

+

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

@@ -10182,6 +10215,39 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

+ +
+
+
+ + +SPAWN.communication + + + +
+ +
+
+
+ + +SPAWN.frequency + + + +
+ +
+
+
+ + +SPAWN.modulation + + +
diff --git a/Documentation/Core.SpawnStatic.html b/Documentation/Core.SpawnStatic.html index 5285688c4..27c7a141a 100644 --- a/Documentation/Core.SpawnStatic.html +++ b/Documentation/Core.SpawnStatic.html @@ -1996,6 +1996,24 @@ such as position and heading.

SPAWNSTATIC:_SpawnStatic(Template, CountryID)

Spawns a new static using a given template.

+ + + +

SPAWNSTATIC.heliport_callsign_id

+ + + + + +

SPAWNSTATIC.heliport_frequency

+ + + + + +

SPAWNSTATIC.heliport_modulation

+ + @@ -2910,6 +2928,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
@@ -4263,6 +4314,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWNSTATIC.heliport_callsign_id + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_frequency + + + +
+ +
+
+
+ + +SPAWNSTATIC.heliport_modulation + + +
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index de04fc749..a3e956874 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2815,6 +2815,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -4098,6 +4131,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
@@ -5620,6 +5686,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + + + +
+
+ + +SPOT.ScheduleID + + + +
+ +
+
+
+ + +SPOT.SpotIR + + + +
+ +
+
+
+ + +SPOT.SpotLaser + + +
diff --git a/Documentation/Functional.ATC_Ground.html b/Documentation/Functional.ATC_Ground.html index f44b5f116..863dca688 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3878,7 +3878,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table ATC_GROUND.Airbases @@ -3894,6 +3894,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

Kickspeed

+
@@ -4463,7 +4466,7 @@ An airbase can be specified to set the maximum kick speed for.

- + #table ATC_GROUND.Airbases @@ -4479,6 +4482,9 @@ An airbase can be specified to set the maximum kick speed for.

+ +

Kickspeed

+
diff --git a/Documentation/Functional.Detection.html b/Documentation/Functional.Detection.html index a93bb141b..648c903e5 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19354,28 +19354,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -19508,6 +19486,17 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -24123,28 +24112,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -24277,6 +24244,17 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #boolean +DETECTION_BASE.Locking + + +
@@ -25887,28 +25865,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #number -DETECTION_BASE.DetectedItemCount - - - -
- -
-
-
- - #number -DETECTION_BASE.DetectedItemMax - - -
@@ -26041,6 +25997,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 ccd6e62e7..ff7b9b683 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -4305,8 +4305,8 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber @@ -4544,6 +4544,50 @@ 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 + + +
@@ -8939,8 +8983,8 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`
- -MANTIS.SkateZones + #number +MANTIS.SkateNumber @@ -9178,6 +9222,50 @@ E.g. `mymantis:SetAdvancedMode(true, 90)`

Prefix for logging

+
+ +
+
+
+ + #number +MANTIS.maxclassic + + + +
+ +
+
+
+ + #number +MANTIS.maxlongrange + + + +
+ +
+
+
+ + #number +MANTIS.maxmidrange + + + +
+ +
+
+
+ + #number +MANTIS.maxshortrange + + +
diff --git a/Documentation/Functional.RAT.html b/Documentation/Functional.RAT.html index 9e8c8ff6c..995f8045c 100644 --- a/Documentation/Functional.RAT.html +++ b/Documentation/Functional.RAT.html @@ -3471,6 +3471,12 @@ manager:Stop(7200)

RAT.termtype

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

+ + + +

RAT.type

+ + @@ -4564,6 +4570,24 @@ and any spaces before and after the resulting name are removed.

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

+ + + +

RAT.communication

+ + + + + +

RAT.frequency

+ + + + + +

RAT.modulation

+ + @@ -6961,6 +6985,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 + + +
@@ -14841,6 +14876,17 @@ Initializes the ratcraft array and group menu.

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

+ + + +
+
+ + +RAT.type + + +
@@ -21279,6 +21325,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 1d8c7822f..c30c7a811 100644 --- a/Documentation/Ops.Airboss.html +++ b/Documentation/Ops.Airboss.html @@ -40625,20 +40625,6 @@ When moose is loading dynamically (for moose class development), tracing is swit
-AIRBOSS.PlayerData.flag - - - - -

Decrease stack/flag. Human player needs to take care himself.

- -
- - -
-
- - AIRBOSS.PlayerData.grade @@ -40792,9 +40778,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set section lead of player flight.

-
@@ -40817,9 +40800,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - -

Set Stable Hover

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

Set time stamp.

+

Set new time stamp.

diff --git a/Documentation/Ops.CTLD.html b/Documentation/Ops.CTLD.html index e31459baf..a3391ee42 100644 --- a/Documentation/Ops.CTLD.html +++ b/Documentation/Ops.CTLD.html @@ -7710,6 +7710,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Name of the class.

+ + + +
+
+ + #number +CTLD.CrateCounter + + +
@@ -7730,7 +7741,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.CtldUnits @@ -7752,7 +7763,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.DroppedTroops @@ -7777,11 +7788,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -7813,7 +7827,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeFMFrequencies @@ -7835,11 +7849,14 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #table CTLD.FreeVHFFrequencies + +

Beacons

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

tables

+
@@ -7957,14 +7977,11 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string CTLD.RadioPath - -

Folderpath.

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -8550,7 +8578,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + CTLD.troopdropzoneradius @@ -17993,6 +18021,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -18013,7 +18052,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.CtldUnits @@ -18035,7 +18074,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -18060,11 +18099,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -18096,7 +18138,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -18118,11 +18160,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeVHFFrequencies + +

Beacons

+
@@ -18207,11 +18252,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -18240,14 +18288,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -18833,7 +18889,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -20410,6 +20466,17 @@ However, if you create a new folder inside the miz file, which contains the soun

Name of the class.

+
+ +
+
+
+ + #number +CTLD.CrateCounter + + +
@@ -20430,7 +20497,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.CtldUnits @@ -20452,7 +20519,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.DroppedTroops @@ -20477,11 +20544,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.EngineersInField + +

holds #CTLD_ENGINEERING objects

+
@@ -20513,7 +20583,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeFMFrequencies @@ -20535,11 +20605,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.FreeVHFFrequencies + +

Beacons

+
@@ -20624,11 +20697,14 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #table CTLD.PilotGroups + +

tables

+
@@ -20657,14 +20733,11 @@ However, if you create a new folder inside the miz file, which contains the soun
- + #string CTLD.RadioPath - -

Folderpath.

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

#1570

+
+ +
+
+
+ + #table +CTLD.droppedBeacons + + +
@@ -21250,7 +21334,7 @@ However, if you create a new folder inside the miz file, which contains the soun
- #number + CTLD.troopdropzoneradius @@ -30186,6 +30270,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+ @@ -30839,6 +30934,17 @@ When moose is loading dynamically (for moose class development), tracing is swit +
+ +
+ @@ -34374,6 +34480,17 @@ When moose is loading dynamically (for moose class development), tracing is swit

template for a group of 10 paratroopers

+
+ +
+
+
+ + #number +CTLD_HERCULES.j + + +
@@ -35700,6 +35817,17 @@ Use either this method to integrate the Hercules **or** the one from the "normal

template for a group of 10 paratroopers

+
+ +
+
+
+ + #number +CTLD_HERCULES.j + + +
diff --git a/Documentation/Sound.SRS.html b/Documentation/Sound.SRS.html index f5889c875..472f12ec6 100644 --- a/Documentation/Sound.SRS.html +++ b/Documentation/Sound.SRS.html @@ -2162,12 +2162,6 @@ atis:Start()

MSRS.google

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

- - - -

MSRS.key

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

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

-
- -
-
-
- - -MSRS.key - - -
@@ -4004,7 +3987,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string MSRS.provider @@ -6334,17 +6317,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Full path google credentials JSON file, e.g. "C:\Users\username\Downloads\service-account-file.json".

-
- -
-
-
- - -MSRS.key - - -
@@ -6406,7 +6378,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string MSRS.provider diff --git a/Documentation/Tasking.Task.html b/Documentation/Tasking.Task.html index 23435a0e7..28ba18190 100644 --- a/Documentation/Tasking.Task.html +++ b/Documentation/Tasking.Task.html @@ -2938,6 +2938,17 @@ but can separately be modified later in your mission using the +
+ +
+
+
+ + +TASK.TaskControlMenu + + +
@@ -7574,6 +7585,17 @@ If the Unit is part of the Task, true is returned.

+
+ +
+
+
+ + +TASK.TaskControlMenu + + +
diff --git a/Documentation/Tasking.Task_CARGO.html b/Documentation/Tasking.Task_CARGO.html index c213a94f7..9547a39d6 100644 --- a/Documentation/Tasking.Task_CARGO.html +++ b/Documentation/Tasking.Task_CARGO.html @@ -3230,11 +3230,22 @@ based on the tasking capabilities defined in
- + Cargo.Cargo#CARGO FSM_PROCESS.Cargo +
+ +
+
+
+ + +FSM_PROCESS.DeployZone + + +
diff --git a/Documentation/Tasking.Task_Cargo_Dispatcher.html b/Documentation/Tasking.Task_Cargo_Dispatcher.html index beb169611..e42849fb9 100644 --- a/Documentation/Tasking.Task_Cargo_Dispatcher.html +++ b/Documentation/Tasking.Task_Cargo_Dispatcher.html @@ -3217,65 +3217,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -4367,65 +4312,10 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- - -
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -5269,65 +5159,10 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- - -
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
@@ -6802,65 +6637,10 @@ This method can only be used once!

-TASK_CARGO_DISPATCHER.CSARBriefing - - - -
- - -
-
- - -TASK_CARGO_DISPATCHER.CSARDeployZones - - - -
- -
-
-
- - -TASK_CARGO_DISPATCHER.CSARTaskName - - - -
- -
-
-
- - #boolean -TASK_CARGO_DISPATCHER.CSARTasks - - - -
- -
-
-
- - #table TASK_CARGO_DISPATCHER.DefaultDeployZones -
- -
-
-
- - -TASK_CARGO_DISPATCHER.MaxCSAR - - -
diff --git a/Documentation/Utilities.FiFo.html b/Documentation/Utilities.FiFo.html index f2adb0e1e..9f4ee0aa3 100644 --- a/Documentation/Utilities.FiFo.html +++ b/Documentation/Utilities.FiFo.html @@ -3254,6 +3254,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Stack by pointer.

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

Stack by pointer.

+ + + +
+
+ + #number +FIFO.uniquecounter + + +
@@ -7587,17 +7609,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #number -LIFO.uniquecounter - - -
@@ -8447,17 +8458,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #number -LIFO.uniquecounter - - -
diff --git a/Documentation/Wrapper.Group.html b/Documentation/Wrapper.Group.html index 91e2eabce..096b9cc06 100644 --- a/Documentation/Wrapper.Group.html +++ b/Documentation/Wrapper.Group.html @@ -5231,7 +5231,18 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ + +
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -9877,7 +9888,18 @@ So each unit of the group is respawned at exactly the same parking spot as it cu
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -22033,7 +22055,18 @@ Note that when WayPointInitialize is called, the Mission of the controllable is
-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -26122,7 +26155,18 @@ Coordinates are dependent on the position of the maps origin.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -26747,7 +26791,18 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter @@ -26989,7 +27044,18 @@ If the Identifiable is alive, true is returned.

-GROUP.InitRespawnRandomizePositionZone +GROUP.InitRespawnRandomizePositionInner + + + +
+ +
+
+
+ + +GROUP.InitRespawnRandomizePositionOuter diff --git a/Documentation/Wrapper.Marker.html b/Documentation/Wrapper.Marker.html index 616aeeaa6..70a16f17d 100644 --- a/Documentation/Wrapper.Marker.html +++ b/Documentation/Wrapper.Marker.html @@ -3022,6 +3022,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -3106,7 +3128,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -5139,6 +5161,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -5223,7 +5267,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup @@ -6727,6 +6771,28 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Coordinate of the mark.

+
+ +
+
+
+ + +MARKER.groupid + + + +
+ +
+
+
+ + +MARKER.groupname + + +
@@ -6811,7 +6877,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
#boolean -MARKER.toall +MARKER.togroup diff --git a/Documentation/Wrapper.Positionable.html b/Documentation/Wrapper.Positionable.html index 6389f78cc..961ff4fc4 100644 --- a/Documentation/Wrapper.Positionable.html +++ b/Documentation/Wrapper.Positionable.html @@ -3732,17 +3732,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - Core.Spot#SPOT -POSITIONABLE.Spot - - -
@@ -7777,17 +7766,6 @@ Coordinates are dependent on the position of the maps origin.

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

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

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