From fbd3f787ac540430eba8e83829d027d500309b7b Mon Sep 17 00:00:00 2001 From: MooseBotter Date: Thu, 28 Dec 2023 12:35:32 +0000 Subject: [PATCH] Auto commit by GitHub Actions Workflow --- Documentation/AI.AI_Air.html | 88 - Documentation/AI.AI_Air_Dispatcher.html | 44 - Documentation/AI.AI_Cargo.html | 12 - Documentation/AI.AI_Cargo_Airplane.html | 56 +- Documentation/Cargo.Cargo.html | 8729 +---------------- Documentation/Cargo.CargoCrate.html | 7 - Documentation/Cargo.CargoGroup.html | 308 +- Documentation/Cargo.CargoSlingload.html | 7 - Documentation/Cargo.CargoUnit.html | 29 +- Documentation/Core.Fsm.html | 4 +- Documentation/Core.Point.html | 22 + Documentation/Core.Settings.html | 30 +- Documentation/Core.Spawn.html | 200 +- Documentation/Core.Spot.html | 99 - Documentation/Functional.ATC_Ground.html | 6 - Documentation/Functional.Detection.html | 99 +- Documentation/Functional.Mantis.html | 48 +- Documentation/Functional.Movement.html | 28 + Documentation/Functional.RAT.html | 18 - Documentation/Functional.Scoring.html | 18 +- Documentation/Ops.Airboss.html | 84 +- Documentation/Ops.CTLD.html | 96 +- Documentation/Tasking.Task_CARGO.html | 19 +- .../Tasking.Task_Cargo_Dispatcher.html | 184 +- Documentation/Utilities.FiFo.html | 44 + Documentation/Wrapper.Marker.html | 66 - 26 files changed, 511 insertions(+), 9834 deletions(-) diff --git a/Documentation/AI.AI_Air.html b/Documentation/AI.AI_Air.html index 24807f361..860570187 100644 --- a/Documentation/AI.AI_Air.html +++ b/Documentation/AI.AI_Air.html @@ -3177,28 +3177,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6005,28 +5983,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -6752,28 +6708,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
@@ -8387,28 +8321,6 @@ A random value in this bracket is then applied in the waypoint routing generatio - - - -
-
- - #number -AI_AIR.RTBSpeedMaxFactor - - - -
- -
-
-
- - #number -AI_AIR.RTBSpeedMinFactor - - -
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_Cargo.html b/Documentation/AI.AI_Cargo.html index b29a37a21..ad13105cf 100644 --- a/Documentation/AI.AI_Cargo.html +++ b/Documentation/AI.AI_Cargo.html @@ -2797,9 +2797,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

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

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

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

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

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

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

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

- diff --git a/Documentation/AI.AI_Cargo_Airplane.html b/Documentation/AI.AI_Cargo_Airplane.html index 43dc65147..fb816bf4c 100644 --- a/Documentation/AI.AI_Cargo_Airplane.html +++ b/Documentation/AI.AI_Cargo_Airplane.html @@ -2746,6 +2746,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

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

Aircraft is on a pickup mission.

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

Field(s)

+
+
+ + +AI_CARGO_AIRPLANE.Airbase + + + +
+ +
@@ -6701,9 +6736,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.Cargo.html b/Documentation/Cargo.Cargo.html index f64538358..d071366af 100644 --- a/Documentation/Cargo.Cargo.html +++ b/Documentation/Cargo.Cargo.html @@ -1981,11 +1981,15 @@ All derived classes from CARGO follow the same state machine, expose the same ca
- #CARGO_PACKAGE + #table CARGO_PACKAGE + +

@type CARGO_PACKAGE + @extends #CARGO_REPRESENTABLE

+
@@ -2002,11 +2006,15 @@ All derived classes from CARGO follow the same state machine, expose the same ca
- #CARGO_REPORTABLE + #table CARGO_REPORTABLE + +

@type CARGO_REPORTABLE + @extends #CARGO

+
@@ -2035,10 +2043,6 @@ All derived classes from CARGO follow the same state machine, expose the same ca

Type CARGO

CARGO -, extends Core.Fsm#FSM_PROCESS -, extends Core.Fsm#FSM_CONTROLLABLE -, extends Core.Fsm#FSM -, extends Core.Base#BASE
@@ -2085,7 +2089,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2097,7 +2101,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2109,7 +2113,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2343,19 +2347,13 @@ All derived classes from CARGO follow the same state machine, expose the same ca - - - - @@ -2457,7 +2455,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2493,7 +2491,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2541,7 +2539,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2565,7 +2563,7 @@ All derived classes from CARGO follow the same state machine, expose the same ca @@ -2596,986 +2594,6 @@ All derived classes from CARGO follow the same state machine, expose the same ca - -

CARGO.CargoCarrier

 -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

+

CARGO.CargoObject

 -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

+

CARGO.Containable

 -

This flag defines if the cargo can be contained within a DCS Unit.

+

CARGO.Moveable

 -

This flag defines if the cargo is moveable.

+

CARGO.Name

 -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

-

CARGO.NearRadius

 -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

+

CARGO.Representable

 -

This flag defines if the cargo can be represented by a DCS Unit.

+

CARGO.Slingloadable

 -

This flag defines if the cargo can be slingloaded.

+

CARGO.Type

 -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

+

CARGO.Weight

 -

A number defining the weight of the cargo. The weight is expressed in kg.

+

CARGO:onenterDestroyed()

 -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from FSM_PROCESSDescription

CARGO:Assign(Task, ProcessUnit)

 -

Assign the process to a Wrapper.Unit and activate the process.

-

CARGO:Copy(Controllable, Task)

 -

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

-

CARGO:GetCommandCenter()

 -

Gets the mission of the process.

-

CARGO:GetMission()

 -

Gets the mission of the process.

-

CARGO:GetTask()

 -

Gets the task of the process.

-

CARGO:Init(FsmProcess)

 - -

CARGO:Message(Message)

 -

Send a message of the Tasking.Task to the Group of the Unit.

-

CARGO:New(Controllable, Task)

 -

Creates a new FSM_PROCESS object.

-

CARGO:Remove()

 -

Removes an FSM_PROCESS object.

-

CARGO:SetTask(Task)

 -

Sets the task of the process.

-

CARGO.Task

 - -

CARGO:_call_handler(step, trigger, params, EventName)

 - -

CARGO:onenterFailed(ProcessUnit, Task, From, Event, To)

 - -

CARGO:onstatechange(ProcessUnit, Event, From, To, Task)

 -

StateMachine callback function for a FSM_PROCESS

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from FSM_CONTROLLABLEDescription

CARGO.Controllable

 - -

CARGO:GetControllable()

 -

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

-

CARGO:New(FSMT, Controllable)

 -

Creates a new FSM_CONTROLLABLE object.

-

CARGO:OnAfterStop(Controllable, From, Event, To)

 -

OnAfter Transition Handler for Event Stop.

-

CARGO:OnBeforeStop(Controllable, From, Event, To)

 -

OnBefore Transition Handler for Event Stop.

-

CARGO:OnEnterStopped(Controllable, From, Event, To)

 -

OnEnter Transition Handler for State Stopped.

-

CARGO:OnLeaveStopped(Controllable, From, Event, To)

 -

OnLeave Transition Handler for State Stopped.

-

CARGO:SetControllable(FSMControllable)

 -

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

-

CARGO:Stop()

 -

Synchronous Event Trigger for Event Stop.

-

CARGO:__Stop(Delay)

 -

Asynchronous Event Trigger for Event Stop.

-

CARGO:_call_handler(step, trigger, params, EventName)

 - -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from FSMDescription

CARGO:AddEndState(State)

 -

Adds an End state.

-

CARGO:AddProcess(From, Event, Process, ReturnEvents)

 -

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

-

CARGO:AddScore(State, ScoreText, Score)

 -

Adds a score for the FSM to be achieved.

-

CARGO:AddScoreProcess(From, Event, State, ScoreText, Score)

 -

Adds a score for the FSM_PROCESS to be achieved.

-

CARGO:AddTransition(From, Event, To)

 -

Add a new transition rule to the FSM.

-

CARGO.CallScheduler

 -

Call scheduler.

-

CARGO.ClassName

 -

Name of the class.

-

CARGO.Events

 - -

CARGO:GetCurrentState()

 -

Get current state.

-

CARGO:GetEndStates()

 -

Returns the End states.

-

CARGO:GetProcess(From, Event)

 - -

CARGO:GetProcesses()

 -

Returns a table of the SubFSM rules defined within the FSM.

-

CARGO:GetScores()

 -

Returns a table with the scores defined.

-

CARGO:GetStartState()

 -

Returns the start state of the FSM.

-

CARGO:GetState()

 -

Get current state.

-

CARGO:GetSubs()

 -

Returns a table with the Subs defined.

-

CARGO:GetTransitions()

 -

Returns a table of the transition rules defined within the FSM.

-

CARGO:Is(State)

 -

Check if FSM is in state.

-

CARGO:LoadCallBacks(CallBackTable)

 -

Load call backs.

-

CARGO:New()

 -

Creates a new FSM object.

-

CARGO.Scores

 -

Scores.

-

CARGO:SetProcess(From, Event, Fsm)

 - -

CARGO:SetStartState(State)

 -

Sets the start state of the FSM.

-

CARGO._EndStates

 - -

CARGO._EventSchedules

 - -

CARGO._Processes

 - -

CARGO._Scores

 - -

CARGO._StartState

 - -

CARGO._Transitions

 - -

CARGO:_add_to_map(Map, Event)

 -

Add to map.

-

CARGO:_call_handler(step, trigger, params, EventName)

 -

Call handler.

-

CARGO:_create_transition(EventName)

 -

Create transition.

-

CARGO:_delayed_transition(EventName)

 -

Delayed transition.

-

CARGO:_eventmap(Events, EventStructure)

 -

Event map.

-

CARGO:_gosub(ParentFrom, ParentEvent)

 -

Go sub.

-

CARGO:_handler(EventName, ...)

 -

Handler.

-

CARGO:_isendstate(Current)

 -

Is end state.

-

CARGO:_submap(subs, sub, name)

 -

Sub maps.

-

CARGO:can(e)

 -

Check if can do an event.

-

CARGO:cannot(e)

 -

Check if cannot do an event.

-

CARGO.current

 -

Current state name.

-

CARGO.endstates

 - -

CARGO:is(State, state)

 -

Check if FSM is in state.

-

CARGO.options

 -

Options.

-

CARGO.subs

 -

Subs.

-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Fields and Methods inherited from BASEDescription

CARGO.ClassID

 -

The ID number of the class.

-

CARGO.ClassName

 -

The name of the class.

-

CARGO.ClassNameAndID

 -

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

-

CARGO:ClearState(Object, StateName)

 -

Clear the state of an object.

-

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

 -

Creation of a Birth Event.

-

CARGO:CreateEventCrash(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Crash Event.

-

CARGO:CreateEventDead(EventTime, Initiator, IniObjectCategory)

 -

Creation of a Dead Event.

-

CARGO:CreateEventPlayerEnterAircraft(PlayerUnit)

 -

Creation of a S_EVENT_PLAYER_ENTER_AIRCRAFT event.

-

CARGO:CreateEventRemoveUnit(EventTime, Initiator)

 -

Creation of a Remove Unit Event.

-

CARGO:CreateEventTakeoff(EventTime, Initiator)

 -

Creation of a Takeoff Event.

-

CARGO:CreateEventUnitLost(EventTime, Initiator)

 -

Creation of a Crash Event.

-

CARGO:E(Arguments)

 -

Log an exception which will be traced always.

-

CARGO:EventDispatcher()

 -

Returns the event dispatcher

-

CARGO:EventRemoveAll()

 -

Remove all subscribed events

-

CARGO:F(Arguments)

 -

Trace a function call.

-

CARGO:F2(Arguments)

 -

Trace a function call level 2.

-

CARGO:F3(Arguments)

 -

Trace a function call level 3.

-

CARGO:GetClassID()

 -

Get the ClassID of the class instance.

-

CARGO:GetClassName()

 -

Get the ClassName of the class instance.

-

CARGO:GetClassNameAndID()

 -

Get the ClassName + ClassID of the class instance.

-

CARGO:GetEventPriority()

 -

Get the Class Core.Event processing Priority.

-

CARGO:GetParent(Child, FromClass)

 -

This is the worker method to retrieve the Parent class.

-

CARGO:GetState(Object, Key)

 -

Get a Value given a Key from the Object.

-

CARGO:HandleEvent(EventID, EventFunction)

 -

Subscribe to a DCS Event.

-

CARGO:I(Arguments)

 -

Log an information which will be traced always.

-

CARGO:Inherit(Child, Parent)

 -

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

-

CARGO:IsInstanceOf(ClassName)

 -

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

-

CARGO:IsTrace()

 -

Enquires if tracing is on (for the class).

-

CARGO:New()

 -

BASE constructor.

-

CARGO:OnEvent(EventData)

 -

Occurs when an Event for an object is triggered.

-

CARGO:OnEventBDA(EventData)

 -

BDA.

-

CARGO:OnEventBaseCaptured(EventData)

 -

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

-

CARGO:OnEventBirth(EventData)

 -

Occurs when any object is spawned into the mission.

-

CARGO:OnEventCrash(EventData)

 -

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

-

CARGO:OnEventDead(EventData)

 -

Occurs when an object is dead.

-

CARGO:OnEventDetailedFailure(EventData)

 -

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

-

CARGO:OnEventDiscardChairAfterEjection(EventData)

 -

Discard chair after ejection.

-

CARGO:OnEventEjection(EventData)

 -

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

-

CARGO:OnEventEngineShutdown(EventData)

 -

Occurs when any aircraft shuts down its engines.

-

CARGO:OnEventEngineStartup(EventData)

 -

Occurs when any aircraft starts its engines.

-

CARGO:OnEventHit(EventData)

 -

Occurs whenever an object is hit by a weapon.

-

CARGO:OnEventHumanFailure(EventData)

 -

Occurs when any system fails on a human controlled aircraft.

-

CARGO:OnEventKill(EventData)

 -

Occurs on the death of a unit.

-

CARGO:OnEventLand(EventData)

 -

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

-

CARGO:OnEventLandingAfterEjection(EventData)

 -

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

-

CARGO:OnEventLandingQualityMark(EventData)

 -

Landing quality mark.

-

CARGO:OnEventMarkAdded(EventData)

 -

Occurs when a new mark was added.

-

CARGO:OnEventMarkChange(EventData)

 -

Occurs when a mark text was changed.

-

CARGO:OnEventMarkRemoved(EventData)

 -

Occurs when a mark was removed.

-

CARGO:OnEventMissionEnd(EventData)

 -

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

-

CARGO:OnEventMissionStart(EventData)

 -

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

-

CARGO:OnEventParatrooperLanding(EventData)

 -

Weapon add.

-

CARGO:OnEventPilotDead(EventData)

 -

Occurs when the pilot of an aircraft is killed.

-

CARGO:OnEventPlayerEnterAircraft(EventData)

 -

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

-

CARGO:OnEventPlayerEnterUnit(EventData)

 -

Occurs when any player assumes direct control of a unit.

-

CARGO:OnEventPlayerLeaveUnit(EventData)

 -

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

-

CARGO:OnEventRefueling(EventData)

 -

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

-

CARGO:OnEventRefuelingStop(EventData)

 -

Occurs when an aircraft is finished taking fuel.

-

CARGO:OnEventScore(EventData)

 -

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

-

CARGO:OnEventShootingEnd(EventData)

 -

Occurs when any unit stops firing its weapon.

-

CARGO:OnEventShootingStart(EventData)

 -

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

-

CARGO:OnEventShot(EventData)

 -

Occurs whenever any unit in a mission fires a weapon.

-

CARGO:OnEventTakeoff(EventData)

 -

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

-

CARGO:OnEventTriggerZone(EventData)

 -

Trigger zone.

-

CARGO:OnEventUnitLost(EventData)

 -

Occurs when the game thinks an object is destroyed.

-

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

 -

Schedule a new time event.

-

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

 -

Schedule a new time event.

-

CARGO:ScheduleStop(SchedulerID)

 -

Stops the Schedule.

-

CARGO.Scheduler

 - -

CARGO:SetEventPriority(EventPriority)

 -

Set the Class Core.Event processing Priority.

-

CARGO:SetState(Object, Key, Value)

 -

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

-

CARGO:T(Arguments)

 -

Trace a function logic level 1.

-

CARGO:T2(Arguments)

 -

Trace a function logic level 2.

-

CARGO:T3(Arguments)

 -

Trace a function logic level 3.

-

CARGO:TraceAll(TraceAll)

 -

Trace all methods in MOOSE

-

CARGO:TraceClass(Class)

 -

Set tracing for a class

-

CARGO:TraceClassMethod(Class, Method)

 -

Set tracing for a specific method of class

-

CARGO:TraceLevel(Level)

 -

Set trace level

-

CARGO:TraceOff()

 -

Set trace off.

-

CARGO:TraceOn()

 -

Set trace on.

-

CARGO:TraceOnOff(TraceOnOff)

 -

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

-

CARGO:UnHandleEvent(EventID)

 -

UnSubscribe to a DCS event.

-

CARGO._

 - -

CARGO:_F(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function call.

-

CARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

 -

Trace a function logic.

-

CARGO.__

 - -

CARGO:onEvent(event)

 -

The main event handling function...
@@ -3584,7 +2602,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type CARGO_PACKAGE

CARGO_PACKAGE -, extends #CARGO_REPRESENTABLE
@@ -3602,92 +2619,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

CARGO_PACKAGE.CargoInAir

 -

CARGO_PACKAGE.ClassName

 - -

CARGO_PACKAGE:IsNear(CargoCarrier)

 -

Check if CargoCarrier is near the Cargo to be Loaded.

-

CARGO_PACKAGE:New(CargoCarrier, Type, Name, Weight, LoadRadius, NearRadius)

 -

CARGO_PACKAGE Constructor.

-

CARGO_PACKAGE:onafterLoad(Event, From, To, CargoCarrier, Speed, LoadDistance, Angle)

 -

Load Event.

-

CARGO_PACKAGE:onafterOnBoard(Event, From, To, CargoCarrier, Speed, BoardDistance, Angle, LoadDistance)

 -

Board Event.

-

CARGO_PACKAGE:onafterOnBoarded(Event, From, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle)

 -

Boarded Event.

-

CARGO_PACKAGE:onafterUnBoard(Event, From, To, CargoCarrier, Speed, UnLoadDistance, UnBoardDistance, Radius, Angle)

 -

UnBoard Event.

-

CARGO_PACKAGE:onafterUnBoarded(Event, From, To, CargoCarrier, Speed)

 -

UnBoarded Event.

-

CARGO_PACKAGE:onafterUnLoad(Event, From, To, CargoCarrier, Speed, Distance, Angle)

 -

UnLoad Event.

-
-
- -

Type CARGO_REPORTABLE

-
- CARGO_REPORTABLE -, extends #CARGO -
-
- - - - - - - - - - - - - - - -
Fields and Methods inherited from CARGO_REPORTABLEDescription

CARGO_REPORTABLE.ClassName

 - -

CARGO_REPORTABLE:MessageToGroup(Message, TaskGroup, Name)

 -

Send a CC message to a Wrapper.Group.

-

CARGO_REPORTABLE:New(Type, Name, Weight, LoadRadius, NearRadius)

 -

CARGO_REPORTABLE Constructor.
@@ -3696,7 +2627,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau

Type CARGO_REPRESENTABLE

CARGO_REPRESENTABLE -, extends #CARGO
@@ -3726,12 +2656,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -

CARGO_REPRESENTABLE:RouteTo(ToPointVec2, Speed)

Route a cargo unit to a PointVec2.

-

CARGO_REPRESENTABLE.test

 -
@@ -3755,7 +2679,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau Wrapper.Client#CLIENT CARGO.CargoCarrier -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

+
@@ -3768,17 +2692,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - Wrapper.Unit#UNIT -CARGO.CargoObject - -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

-
@@ -3799,7 +2712,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean CARGO.Containable -

This flag defines if the cargo can be contained within a DCS Unit.

+ @@ -3821,7 +2734,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean CARGO.Moveable -

This flag defines if the cargo is moveable.

+ @@ -3829,21 +2742,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + CARGO.Name -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

-
- -
-
-
- - #number -CARGO.NearRadius - -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

@@ -3876,7 +2778,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean CARGO.Representable -

This flag defines if the cargo can be represented by a DCS Unit.

+
@@ -3887,7 +2789,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau #boolean CARGO.Slingloadable -

This flag defines if the cargo can be slingloaded.

+ @@ -3895,10 +2797,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #string + CARGO.Type -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

+
@@ -3917,10 +2819,10 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- #number + CARGO.Weight -

A number defining the weight of the cargo. The weight is expressed in kg.

+
@@ -6557,6652 +5459,6 @@ The cargo must be in the Loaded state.

-
-

Field(s)

-
-
-
- - Wrapper.Client#CLIENT -CARGO.CargoCarrier - -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

- -
- -
-
-
- - #number -CARGO.CargoLimit - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CARGO.CargoObject - -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

- -
- -
-
-
- - -CARGO.CargoScheduler - - - -
- -
-
-
- - #boolean -CARGO.Containable - -

This flag defines if the cargo can be contained within a DCS Unit.

- -
- -
-
-
- - -CARGO.Deployed - - - -
- -
-
-
- - #boolean -CARGO.Moveable - -

This flag defines if the cargo is moveable.

- -
- -
-
-
- - #string -CARGO.Name - -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

- -
- -
-
-
- - #number -CARGO.NearRadius - -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

- -
- -
-
-
- - -CARGO.ReportFlareColor - - - -
- -
-
-
- - -CARGO.ReportSmokeColor - - - -
- -
-
-
- - #boolean -CARGO.Representable - -

This flag defines if the cargo can be represented by a DCS Unit.

- -
- -
-
-
- - #boolean -CARGO.Slingloadable - -

This flag defines if the cargo can be slingloaded.

- -
- -
-
-
- - #string -CARGO.Type - -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

- -
- -
-
-
- - -CARGO.Volume - - - -
- -
-
-
- - #number -CARGO.Weight - -

A number defining the weight of the cargo. The weight is expressed in kg.

- -
- -
-
-

Function(s)

-
-
- -
-

CARGO:Assign(Task, ProcessUnit)

-
- -

Assign the process to a Wrapper.Unit and activate the process.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- Tasking.Task#TASK - Task -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - ProcessUnit -

-
-
-

-
-
-

Return value:

-
-
-

#FSM_PROCESS:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

CARGO:Copy(Controllable, Task)

-
- -

Creates a new FSM_PROCESS object based on this FSM_PROCESS.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- Controllable -

-
-
-

-
-
-
-
-

- Task -

-
-
-

-
-
-

Return value:

-
-
-

#FSM_PROCESS:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:GetCommandCenter()

-
- -

Gets the mission of the process.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Return value:

-
-
-

Tasking.CommandCenter#COMMANDCENTER:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:GetMission()

-
- -

Gets the mission of the process.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Return value:

-
-
-

Tasking.Mission#MISSION:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:GetTask()

-
- -

Gets the task of the process.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Return value:

-
-
-

Tasking.Task#TASK:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:Init(FsmProcess)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameter:

-
-
-

- FsmProcess -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:Message(Message)

-
- -

Send a message of the Tasking.Task to the Group of the Unit.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameter:

-
-
-

- Message -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:New(Controllable, Task)

-
- -

Creates a new FSM_PROCESS object.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- Controllable -

-
-
-

-
-
-
-
-

- Task -

-
-
-

-
-
-

Return value:

-
-
-

#FSM_PROCESS:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:Remove()

-
- -

Removes an FSM_PROCESS object.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Return value:

-
-
-

#FSM_PROCESS:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:SetTask(Task)

-
- -

Sets the task of the process.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameter:

-
-
-

- Tasking.Task#TASK - Task -

-
-
-

-
-
-

Return value:

-
-
-

#FSM_PROCESS:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:_call_handler(step, trigger, params, EventName)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- step -

-
-
-

-
-
-
-
-

- trigger -

-
-
-

-
-
-
-
-

- params -

-
-
-

-
-
-
-
-

- EventName -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:onenterFailed(ProcessUnit, Task, From, Event, To)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- ProcessUnit -

-
-
-

-
-
-
-
-

- Task -

-
-
-

-
-
-
-
-

- From -

-
-
-

-
-
-
-
-

- Event -

-
-
-

-
-
-
-
-

- To -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:onstatechange(ProcessUnit, Event, From, To, Task)

-
- -

StateMachine callback function for a FSM_PROCESS

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_PROCESS

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - ProcessUnit -

-
-
-

-
-
-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Task -

-
-
-

-
-
-
- -
-
- -
-

Field(s)

-
-
-
- - Wrapper.Client#CLIENT -CARGO.CargoCarrier - -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

- -
- -
-
-
- - #number -CARGO.CargoLimit - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CARGO.CargoObject - -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

- -
- -
-
-
- - -CARGO.CargoScheduler - - - -
- -
-
-
- - #boolean -CARGO.Containable - -

This flag defines if the cargo can be contained within a DCS Unit.

- -
- -
-
-
- - -CARGO.Deployed - - - -
- -
-
-
- - #boolean -CARGO.Moveable - -

This flag defines if the cargo is moveable.

- -
- -
-
-
- - #string -CARGO.Name - -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

- -
- -
-
-
- - #number -CARGO.NearRadius - -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

- -
- -
-
-
- - -CARGO.ReportFlareColor - - - -
- -
-
-
- - -CARGO.ReportSmokeColor - - - -
- -
-
-
- - #boolean -CARGO.Representable - -

This flag defines if the cargo can be represented by a DCS Unit.

- -
- -
-
-
- - #boolean -CARGO.Slingloadable - -

This flag defines if the cargo can be slingloaded.

- -
- -
-
-
- - #string -CARGO.Type - -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

- -
- -
-
-
- - -CARGO.Volume - - - -
- -
-
-
- - #number -CARGO.Weight - -

A number defining the weight of the cargo. The weight is expressed in kg.

- -
- -
-
-

Function(s)

-
-
- -
-

CARGO:GetControllable()

-
- -

Gets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Return value:

-
-
-

Wrapper.Controllable#CONTROLLABLE:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:New(FSMT, Controllable)

-
- -

Creates a new FSM_CONTROLLABLE object.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- #table - FSMT -

-
-
- -

Finite State Machine Table

- -
-
-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

(optional) The CONTROLLABLE object that the FSM_CONTROLLABLE governs.

- -
-
-

Return value:

-
-
-

#FSM_CONTROLLABLE:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:OnAfterStop(Controllable, From, Event, To)

-
- -

OnAfter Transition Handler for Event Stop.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

The Controllable Object managed by the FSM.

- -
-
-
-
-

- #string - From -

-
-
- -

The From State string.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event string.

- -
-
-
-
-

- #string - To -

-
-
- -

The To State string.

- -
-
-
- -
-
- -
- -
-

CARGO:OnBeforeStop(Controllable, From, Event, To)

-
- -

OnBefore Transition Handler for Event Stop.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

The Controllable Object managed by the FSM.

- -
-
-
-
-

- #string - From -

-
-
- -

The From State string.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event string.

- -
-
-
-
-

- #string - To -

-
-
- -

The To State string.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

Return false to cancel Transition.

- -
-
-
- -
-
- -
- -
-

CARGO:OnEnterStopped(Controllable, From, Event, To)

-
- -

OnEnter Transition Handler for State Stopped.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

The Controllable Object managed by the FSM.

- -
-
-
-
-

- #string - From -

-
-
- -

The From State string.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event string.

- -
-
-
-
-

- #string - To -

-
-
- -

The To State string.

- -
-
-
- -
-
- -
- -
-

CARGO:OnLeaveStopped(Controllable, From, Event, To)

-
- -

OnLeave Transition Handler for State Stopped.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - Controllable -

-
-
- -

The Controllable Object managed by the FSM.

- -
-
-
-
-

- #string - From -

-
-
- -

The From State string.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event string.

- -
-
-
-
-

- #string - To -

-
-
- -

The To State string.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

Return false to cancel Transition.

- -
-
-
- -
-
- -
- -
-

CARGO:SetControllable(FSMControllable)

-
- -

Sets the CONTROLLABLE object that the FSM_CONTROLLABLE governs.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameter:

-
-
-

- Wrapper.Controllable#CONTROLLABLE - FSMControllable -

-
-
-

-
-
-

Return value:

-
-
-

#FSM_CONTROLLABLE:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:Stop()

-
- -

Synchronous Event Trigger for Event Stop.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-
- -
-
- -
- -
-

CARGO:__Stop(Delay)

-
- -

Asynchronous Event Trigger for Event Stop.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameter:

-
-
-

- #number - Delay -

-
-
- -

The delay in seconds.

- -
-
-
- -
-
- -
- -
-

CARGO:_call_handler(step, trigger, params, EventName)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM_CONTROLLABLE

-
-

Parameters:

-
-
-

- step -

-
-
-

-
-
-
-
-

- trigger -

-
-
-

-
-
-
-
-

- params -

-
-
-

-
-
-
-
-

- EventName -

-
-
-

-
-
-
- -
-
- -
-

Field(s)

-
-
-
- - Wrapper.Client#CLIENT -CARGO.CargoCarrier - -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

- -
- -
-
-
- - #number -CARGO.CargoLimit - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CARGO.CargoObject - -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

- -
- -
-
-
- - -CARGO.CargoScheduler - - - -
- -
-
-
- - #boolean -CARGO.Containable - -

This flag defines if the cargo can be contained within a DCS Unit.

- -
- -
-
-
- - -CARGO.Deployed - - - -
- -
-
-
- - #boolean -CARGO.Moveable - -

This flag defines if the cargo is moveable.

- -
- -
-
-
- - #string -CARGO.Name - -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

- -
- -
-
-
- - #number -CARGO.NearRadius - -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

- -
- -
-
-
- - -CARGO.ReportFlareColor - - - -
- -
-
-
- - -CARGO.ReportSmokeColor - - - -
- -
-
-
- - #boolean -CARGO.Representable - -

This flag defines if the cargo can be represented by a DCS Unit.

- -
- -
-
-
- - #boolean -CARGO.Slingloadable - -

This flag defines if the cargo can be slingloaded.

- -
- -
-
-
- - #string -CARGO.Type - -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

- -
- -
-
-
- - -CARGO.Volume - - - -
- -
-
-
- - #number -CARGO.Weight - -

A number defining the weight of the cargo. The weight is expressed in kg.

- -
- -
-
-

Function(s)

-
-
- -
-

CARGO:AddEndState(State)

-
- -

Adds an End state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - State -

-
-
- -

The FSM state.

- -
-
-
- -
-
- -
- -
-

CARGO:AddProcess(From, Event, Process, ReturnEvents)

-
- -

Set the default #FSM_PROCESS template with key ProcessName providing the ProcessClass and the process object when it is assigned to a Wrapper.Controllable by the task.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #table - From -

-
-
- -

Can contain a string indicating the From state or a table of strings containing multiple From states.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event name.

- -
-
-
-
-

- Core.Fsm#FSM_PROCESS - Process -

-
-
- -

An sub-process FSM.

- -
-
-
-
-

- #table - ReturnEvents -

-
-
- -

A table indicating for which returned events of the SubFSM which Event must be triggered in the FSM.

- -
-
-

Return value:

-
-
-

Core.Fsm#FSM_PROCESS:

-
-
- -

The SubFSM.

- -
-
-
- -
-
- -
- -
-

CARGO:AddScore(State, ScoreText, Score)

-
- -

Adds a score for the FSM to be achieved.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - State -

-
-
- -

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

- -
-
-
-
-

- #string - ScoreText -

-
-
- -

is a text describing the score that is given according the status.

- -
-
-
-
-

- #number - Score -

-
-
- -

is a number providing the score of the status.

- -
-
-

Return value:

-
-
-

#FSM:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

CARGO:AddScoreProcess(From, Event, State, ScoreText, Score)

-
- -

Adds a score for the FSM_PROCESS to be achieved.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - From -

-
-
- -

is the From State of the main process.

- -
-
-
-
-

- #string - Event -

-
-
- -

is the Event of the main process.

- -
-
-
-
-

- #string - State -

-
-
- -

is the state of the process when the score needs to be given. (See the relevant state descriptions of the process).

- -
-
-
-
-

- #string - ScoreText -

-
-
- -

is a text describing the score that is given according the status.

- -
-
-
-
-

- #number - Score -

-
-
- -

is a number providing the score of the status.

- -
-
-

Return value:

-
-
-

#FSM:

-
-
- -

self

- -
-
-
- -
-
- -
- -
-

CARGO:AddTransition(From, Event, To)

-
- -

Add a new transition rule to the FSM.

- - -

A transition rule defines when and if the FSM can transition from a state towards another state upon a triggered event.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #table - From -

-
-
- -

Can contain a string indicating the From state or a table of strings containing multiple From states.

- -
-
-
-
-

- #string - Event -

-
-
- -

The Event name.

- -
-
-
-
-

- #string - To -

-
-
- -

The To state.

- -
-
-
- -
-
- -
- -
-

CARGO:GetCurrentState()

-
- -

Get current state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#string:

-
-
- -

Current FSM state.

- -
-
-
- -
-
- -
- -
-

CARGO:GetEndStates()

-
- -

Returns the End states.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#table:

-
-
- -

End states.

- -
-
-
- -
-
- -
- -
-

CARGO:GetProcess(From, Event)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- From -

-
-
-

-
-
-
-
-

- Event -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:GetProcesses()

-
- -

Returns a table of the SubFSM rules defined within the FSM.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#table:

-
-
- -

Sub processes.

- -
-
-
- -
-
- -
- -
-

CARGO:GetScores()

-
- -

Returns a table with the scores defined.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#table:

-
-
- -

Scores.

- -
-
-
- -
-
- -
- -
-

CARGO:GetStartState()

-
- -

Returns the start state of the FSM.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#string:

-
-
- -

A string containing the start state.

- -
-
-
- -
-
- -
- -
-

CARGO:GetState()

-
- -

Get current state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#string:

-
-
- -

Current FSM state.

- -
-
-
- -
-
- -
- -
-

CARGO:GetSubs()

-
- -

Returns a table with the Subs defined.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#table:

-
-
- -

Sub processes.

- -
-
-
- -
-
- -
- -
-

CARGO:GetTransitions()

-
- -

Returns a table of the transition rules defined within the FSM.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#table:

-
-
- -

Transitions.

- -
-
-
- -
-
- -
- -
-

CARGO:Is(State)

-
- -

Check if FSM is in state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - State -

-
-
- -

State name.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, FSM is in this state.

- -
-
-
- -
-
- -
- -
-

CARGO:LoadCallBacks(CallBackTable)

-
- -

Load call backs.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #table - CallBackTable -

-
-
- -

Table of call backs.

- -
-
-
- -
-
- -
- -
-

CARGO:New()

-
- -

Creates a new FSM object.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Return value:

-
-
-

#FSM:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:SetProcess(From, Event, Fsm)

-
- - - -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- From -

-
-
-

-
-
-
-
-

- Event -

-
-
-

-
-
-
-
-

- Fsm -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:SetStartState(State)

-
- -

Sets the start state of the FSM.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - State -

-
-
- -

A string defining the start state.

- -
-
-
- -
-
- -
- -
-

CARGO:_add_to_map(Map, Event)

-
- -

Add to map.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #table - Map -

-
-
- -

Map.

- -
-
-
-
-

- #table - Event -

-
-
- -

Event table.

- -
-
-
- -
-
- -
- -
-

CARGO:_call_handler(step, trigger, params, EventName)

-
- -

Call handler.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - step -

-
-
- -

Step "onafter", "onbefore", "onenter", "onleave".

- -
-
-
-
-

- #string - trigger -

-
-
- -

Trigger.

- -
-
-
-
-

- #table - params -

-
-
- -

Parameters.

- -
-
-
-
-

- #string - EventName -

-
-
- -

Event name.

- -
-
-

Return value:

-
-
-
-
- -

Value.

- -
-
-
- -
-
- -
- -
-

CARGO:_create_transition(EventName)

-
- -

Create transition.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - EventName -

-
-
- -

Event name.

- -
-
-

Return value:

-
-
-

#function:

-
-
- -

Function.

- -
-
-
- -
-
- -
- -
-

CARGO:_delayed_transition(EventName)

-
- -

Delayed transition.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - EventName -

-
-
- -

Event name.

- -
-
-

Return value:

-
-
-

#function:

-
-
- -

Function.

- -
-
-
- -
-
- -
- -
-

CARGO:_eventmap(Events, EventStructure)

-
- -

Event map.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #table - Events -

-
-
- -

Events.

- -
-
-
-
-

- #table - EventStructure -

-
-
- -

Event structure.

- -
-
-
- -
-
- -
- -
-

CARGO:_gosub(ParentFrom, ParentEvent)

-
- -

Go sub.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - ParentFrom -

-
-
- -

Parent from state.

- -
-
-
-
-

- #string - ParentEvent -

-
-
- -

Parent event name.

- -
-
-

Return value:

-
-
-

#table:

-
-
- -

Subs.

- -
-
-
- -
-
- -
- -
-

CARGO:_handler(EventName, ...)

-
- -

Handler.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - EventName -

-
-
- -

Event name.

- -
-
-
-
-

- ... -

-
-
- -

Arguments.

- -
-
-
- -
-
- -
- -
-

CARGO:_isendstate(Current)

-
- -

Is end state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - Current -

-
-
- -

Current state name.

- -
-
-

Return values:

-
-
-

#table:

-
-
- -

FSM parent.

- -
-
-

#string:

-
-
- -

Event name.

- -
-
-
- -
-
- -
- -
-

CARGO:_submap(subs, sub, name)

-
- -

Sub maps.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #table - subs -

-
-
- -

Subs.

- -
-
-
-
-

- #table - sub -

-
-
- -

Sub.

- -
-
-
-
-

- #string - name -

-
-
- -

Name.

- -
-
-
- -
-
- -
- -
-

CARGO:can(e)

-
- -

Check if can do an event.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - e -

-
-
- -

Event name.

- -
-
-

Return values:

-
-
-

#boolean:

-
-
- -

If true, FSM can do the event.

- -
-
-

#string:

-
-
- -

To state.

- -
-
-
- -
-
- -
- -
-

CARGO:cannot(e)

-
- -

Check if cannot do an event.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameter:

-
-
-

- #string - e -

-
-
- -

Event name.

- -
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, FSM cannot do the event.

- -
-
-
- -
-
- -
- -
-

CARGO:is(State, state)

-
- -

Check if FSM is in state.

- -
-
-

Defined in:

-
-

Core.Fsm#FSM

-
-

Parameters:

-
-
-

- #string - State -

-
-
- -

State name.

- -
-
-
-
-

- state -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- -

If true, FSM is in this state.

- -
-
-
- -
-
- -
-

Field(s)

-
-
-
- - Wrapper.Client#CLIENT -CARGO.CargoCarrier - -

The alive DCS object carrying the cargo. This value can be nil, meaning, that the cargo is not contained anywhere...

- -
- -
-
-
- - #number -CARGO.CargoLimit - - - -
- -
-
-
- - Wrapper.Unit#UNIT -CARGO.CargoObject - -

The alive DCS object representing the cargo. This value can be nil, meaning, that the cargo is not represented anywhere...

- -
- -
-
-
- - -CARGO.CargoScheduler - - - -
- -
-
-
- - #boolean -CARGO.Containable - -

This flag defines if the cargo can be contained within a DCS Unit.

- -
- -
-
-
- - -CARGO.Deployed - - - -
- -
-
-
- - #boolean -CARGO.Moveable - -

This flag defines if the cargo is moveable.

- -
- -
-
-
- - #string -CARGO.Name - -

A string defining the name of the cargo. The name is the unique identifier of the cargo.

- -
- -
-
-
- - #number -CARGO.NearRadius - -

(optional) A number defining the radius in meters when the cargo is near to a Carrier, so that it can be loaded.

- -
- -
-
-
- - -CARGO.ReportFlareColor - - - -
- -
-
-
- - -CARGO.ReportSmokeColor - - - -
- -
-
-
- - #boolean -CARGO.Representable - -

This flag defines if the cargo can be represented by a DCS Unit.

- -
- -
-
-
- - #boolean -CARGO.Slingloadable - -

This flag defines if the cargo can be slingloaded.

- -
- -
-
-
- - #string -CARGO.Type - -

A string defining the type of the cargo. eg. Engineers, Equipment, Screwdrivers.

- -
- -
-
-
- - -CARGO.Volume - - - -
- -
-
-
- - #number -CARGO.Weight - -

A number defining the weight of the cargo. The weight is expressed in kg.

- -
- -
-
-

Function(s)

-
-
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

-
-
-

-
-
-
- -
-
- -
- -
-

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

-
-
-

-
-
-
- -
-
- -
- -
-

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

-
-
-

-
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:EventDispatcher()

-
- -

Returns the event dispatcher

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

Core.Event#EVENT:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:EventRemoveAll()

-
- -

Remove all subscribed events

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:GetClassID()

-
- -

Get the ClassID of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassID of the class instance.

- -
-
-
- -
-
- -
- -
-

CARGO:GetClassName()

-
- -

Get the ClassName of the class instance.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#string:

-
-
- -

The ClassName of the class instance.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:IsInstanceOf(ClassName)

-
- -

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

- - - -

Examples:

- - - - -
-
-

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:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO:IsTrace()

-
- -

Enquires if tracing is on (for the class).

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

-
-
- - - -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:OnEventDetailedFailure(EventData)

-
- -

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

- - -

Will update this page when new information become available.

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:OnEventEjection(EventData)

-
- -

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

- - -

initiator : The unit that has ejected

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

CARGO:OnEventLand(EventData)

-
- -

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

- - -

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.

- -
-
-
- -
-
- -
- -
-

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

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- - - - -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTDATA - EventData -

-
-
- -

The EventData structure.

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

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

- -
-
-
- -
-
- -
- -
-

CARGO:TraceAll(TraceAll)

-
- -

Trace all methods in MOOSE

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #boolean - TraceAll -

-
-
- -

true = trace all methods in MOOSE.

- -
-
-
- -
-
- -
- -
-

CARGO:TraceClass(Class)

-
- -

Set tracing for a class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
- -
-
- -
- -
-

CARGO:TraceClassMethod(Class, Method)

-
- -

Set tracing for a specific method of class

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- #string - Class -

-
-
- -

Class name.

- -
-
-
-
-

- #string - Method -

-
-
- -

Method.

- -
-
-
- -
-
- -
- -
-

CARGO:TraceLevel(Level)

-
- -

Set trace level

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- #number - Level -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:TraceOff()

-
- -

Set trace off.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

CARGO:TraceOn()

-
- -

Set trace on.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Usage:

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

CARGO:TraceOnOff(TraceOnOff)

-
- -

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

- - -

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

CARGO:UnHandleEvent(EventID)

-
- -

UnSubscribe to a DCS event.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameter:

-
-
-

- Core.Event#EVENTS - EventID -

-
-
- -

Event ID.

- -
-
-

Return value:

-
-
-

#BASE:

-
-
- - - -
-
-
- -
-
- -
- -
-

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

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO:_T(Arguments, DebugInfoCurrentParam, DebugInfoFromParam)

-
- -

Trace a function logic.

- -
-
-

Defined in:

-
-

Core.Base#BASE

-
-

Parameters:

-
-
-

- Arguments -

-
-
- -

A #table or any field.

- -
-
-
-
-

- DebugInfoCurrentParam -

-
-
-

-
-
-
-
-

- DebugInfoFromParam -

-
-
-

-
-
-
- -
-
- -
- -
-

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

-
-
-

-
-
-
- -
-
- @@ -13231,939 +5487,12 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #string -CARGO_PACKAGE.ClassName - - -

Function(s)

-
- -
-

CARGO_PACKAGE:IsNear(CargoCarrier)

-
- -

Check if CargoCarrier is near the Cargo to be Loaded.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameter:

-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-

Return value:

-
-
-

#boolean:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:New(CargoCarrier, Type, Name, Weight, LoadRadius, NearRadius)

-
- -

CARGO_PACKAGE Constructor.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
- -

The UNIT carrying the package.

- -
-
-
-
-

- #string - Type -

-
-
-

-
-
-
-
-

- #string - Name -

-
-
-

-
-
-
-
-

- #number - Weight -

-
-
-

-
-
-
-
-

- #number - LoadRadius -

-
-
- -

(optional)

- -
-
-
-
-

- #number - NearRadius -

-
-
- -

(optional)

- -
-
-

Return value:

-
-
-

#CARGO_PACKAGE:

-
-
- - - -
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterLoad(Event, From, To, CargoCarrier, Speed, LoadDistance, Angle)

-
- -

Load Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
-
-

- #number - LoadDistance -

-
-
-

-
-
-
-
-

- #number - Angle -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterOnBoard(Event, From, To, CargoCarrier, Speed, BoardDistance, Angle, LoadDistance)

-
- -

Board Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
-
-

- #number - BoardDistance -

-
-
-

-
-
-
-
-

- #number - Angle -

-
-
-

-
-
-
-
-

- LoadDistance -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterOnBoarded(Event, From, To, CargoCarrier, Speed, BoardDistance, LoadDistance, Angle)

-
- -

Boarded Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
-
-

- #number - BoardDistance -

-
-
-

-
-
-
-
-

- #number - LoadDistance -

-
-
-

-
-
-
-
-

- #number - Angle -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterUnBoard(Event, From, To, CargoCarrier, Speed, UnLoadDistance, UnBoardDistance, Radius, Angle)

-
- -

UnBoard Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
-
-

- #number - UnLoadDistance -

-
-
-

-
-
-
-
-

- #number - UnBoardDistance -

-
-
-

-
-
-
-
-

- #number - Radius -

-
-
-

-
-
-
-
-

- #number - Angle -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterUnBoarded(Event, From, To, CargoCarrier, Speed)

-
- -

UnBoarded Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
- -
-
- -
- -
-

CARGO_PACKAGE:onafterUnLoad(Event, From, To, CargoCarrier, Speed, Distance, Angle)

-
- -

UnLoad Event.

- -
-
-

Defined in:

-
-

CARGO_PACKAGE

-
-

Parameters:

-
-
-

- #string - Event -

-
-
-

-
-
-
-
-

- #string - From -

-
-
-

-
-
-
-
-

- #string - To -

-
-
-

-
-
-
-
-

- Wrapper.Unit#UNIT - CargoCarrier -

-
-
-

-
-
-
-
-

- #number - Speed -

-
-
-

-
-
-
-
-

- #number - Distance -

-
-
-

-
-
-
-
-

- #number - Angle -

-
-
-

-
-
-
- -
-
- - - - -

Type CARGO_REPORTABLE

-
-
-
-

Field(s)

-
-
-
- - #string -CARGO_REPORTABLE.ClassName - - - -
- -
-
-

Function(s)

-
-
- -
-

CARGO_REPORTABLE:MessageToGroup(Message, TaskGroup, Name)

-
- -

Send a CC message to a Wrapper.Group.

- -
-
-

Defined in:

-
-

CARGO_REPORTABLE

-
-

Parameters:

-
-
-

- #string - Message -

-
-
-

-
-
-
-
-

- Wrapper.Group#GROUP - TaskGroup -

-
-
-

-
-
-
-
-

- #string - Name -

-
-
- -

(optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.

- -
-
-
- -
-
- -
- -
-

CARGO_REPORTABLE:New(Type, Name, Weight, LoadRadius, NearRadius)

-
- -

CARGO_REPORTABLE Constructor.

- -
-
-

Defined in:

-
-

CARGO_REPORTABLE

-
-

Parameters:

-
-
-

- #string - Type -

-
-
-

-
-
-
-
-

- #string - Name -

-
-
-

-
-
-
-
-

- #number - Weight -

-
-
-

-
-
-
-
-

- #number - LoadRadius -

-
-
- -

(optional)

- -
-
-
-
-

- #number - NearRadius -

-
-
- -

(optional)

- -
-
-

Return value:

-
-
-

#CARGO_REPORTABLE:

-
-
- - - -
-
-
- -
-
-
diff --git a/Documentation/Cargo.CargoCrate.html b/Documentation/Cargo.CargoCrate.html index 912d4862a..8d527ced2 100644 --- a/Documentation/Cargo.CargoCrate.html +++ b/Documentation/Cargo.CargoCrate.html @@ -1677,7 +1677,6 @@ Therefore, this class is considered to be deprecated

CARGO_CRATE , extends Cargo.Cargo#CARGO_REPRESENTABLE -, extends #CARGO
@@ -1841,12 +1840,6 @@ Therefore, this class is considered to be deprecated

- - - -

CARGO_CRATE:RouteTo(ToPointVec2, Speed)

Route a cargo unit to a PointVec2.

-

CARGO_CRATE.test

 -
diff --git a/Documentation/Cargo.CargoGroup.html b/Documentation/Cargo.CargoGroup.html index e93ddd11c..519d110cc 100644 --- a/Documentation/Cargo.CargoGroup.html +++ b/Documentation/Cargo.CargoGroup.html @@ -1675,7 +1675,6 @@ Therefore, this class is considered to be deprecated

CARGO_GROUP , extends Cargo.Cargo#CARGO_REPORTABLE -, extends #CARGO
@@ -1891,32 +1890,6 @@ Therefore, this class is considered to be deprecated

- -

CARGO_GROUP:onafterUnLoad(Event, From, To, ToPointVec2, ...)

Enter UnLoaded State.

-
-
-
- - - - - - - - - - - - - - - -
Fields and Methods inherited from CARGO_REPORTABLEDescription

CARGO_GROUP.ClassName

 - -

CARGO_GROUP:MessageToGroup(Message, TaskGroup, Name)

 -

Send a CC message to a Wrapper.Group.

-

CARGO_GROUP:New(Type, Name, Weight, LoadRadius, NearRadius)

 -

CARGO_REPORTABLE Constructor.
@@ -1938,6 +1911,20 @@ Therefore, this class is considered to be deprecated

+CARGO_GROUP.CargoCarrier + + + + +

self.CargoObject:Destroy()

+ +
+ +
+
+
+ + CARGO_GROUP.CargoGroup @@ -1956,6 +1943,20 @@ Therefore, this class is considered to be deprecated

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

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

+
@@ -3238,259 +3239,6 @@ This works for ground only groups.

-
-

Field(s)

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

Then we register the new group in the database

- -
- -
-
-
- - -CARGO_GROUP.CargoName - - - -
- -
-
-
- - Core.Set#SET_CARGO -CARGO_GROUP.CargoSet - -

The collection of derived CARGO objects.

- -
- -
-
-
- - -CARGO_GROUP.CargoTemplate - - - -
- -
-
-
- - #table -CARGO_GROUP.CargoUnitTemplate - - - -
- -
-
-
- - #string -CARGO_GROUP.GroupName - -

The name of the CargoGroup.

- -
- -
-
-
- - -CARGO_GROUP.GroupTemplate - - - -
- -
-
-
- - #boolean -CARGO_GROUP.Grouped - - - -
- -
-
-
- - -CARGO_GROUP.NearRadius - - - -
- -
-
-

Function(s)

-
-
- -
-

CARGO_GROUP:MessageToGroup(Message, TaskGroup, Name)

-
- -

Send a CC message to a Wrapper.Group.

- -
-
-

Defined in:

-
-

Cargo.Cargo#CARGO_REPORTABLE

-
-

Parameters:

-
-
-

- #string - Message -

-
-
-

-
-
-
-
-

- Wrapper.Group#GROUP - TaskGroup -

-
-
-

-
-
-
-
-

- #string - Name -

-
-
- -

(optional) The name of the Group used as a prefix for the message to the Group. If not provided, there will be nothing shown.

- -
-
-
- -
-
- -
- -
-

CARGO_GROUP:New(Type, Name, Weight, LoadRadius, NearRadius)

-
- -

CARGO_REPORTABLE Constructor.

- -
-
-

Defined in:

-
-

Cargo.Cargo#CARGO_REPORTABLE

-
-

Parameters:

-
-
-

- #string - Type -

-
-
-

-
-
-
-
-

- #string - Name -

-
-
-

-
-
-
-
-

- #number - Weight -

-
-
-

-
-
-
-
-

- #number - LoadRadius -

-
-
- -

(optional)

- -
-
-
-
-

- #number - NearRadius -

-
-
- -

(optional)

- -
-
-

Return value:

-
-
-

#CARGO_REPORTABLE:

-
-
- - - -
-
-
- -
-
- diff --git a/Documentation/Cargo.CargoSlingload.html b/Documentation/Cargo.CargoSlingload.html index b122be961..61ee17e0b 100644 --- a/Documentation/Cargo.CargoSlingload.html +++ b/Documentation/Cargo.CargoSlingload.html @@ -1668,7 +1668,6 @@ Therefore, this class is considered to be deprecated

CARGO_SLINGLOAD , extends Cargo.Cargo#CARGO_REPRESENTABLE -, extends #CARGO
@@ -1820,12 +1819,6 @@ Therefore, this class is considered to be deprecated

- - - -

CARGO_SLINGLOAD:RouteTo(ToPointVec2, Speed)

Route a cargo unit to a PointVec2.

-

CARGO_SLINGLOAD.test

 -
diff --git a/Documentation/Cargo.CargoUnit.html b/Documentation/Cargo.CargoUnit.html index 0fec1ae3d..96c7fc07e 100644 --- a/Documentation/Cargo.CargoUnit.html +++ b/Documentation/Cargo.CargoUnit.html @@ -1664,7 +1664,6 @@ Therefore, this class is considered to be deprecated

CARGO_UNIT , extends Cargo.Cargo#CARGO_REPRESENTABLE -, extends #CARGO
@@ -1786,12 +1785,6 @@ Therefore, this class is considered to be deprecated

- - - -

CARGO_UNIT:RouteTo(ToPointVec2, Speed)

Route a cargo unit to a PointVec2.

-

CARGO_UNIT.test

 -
@@ -1816,6 +1809,17 @@ Therefore, this class is considered to be deprecated

+CARGO_UNIT.CargoCarrier + + + +
+ +
+
+
+ + CARGO_UNIT.CargoInAir @@ -2520,6 +2524,17 @@ 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 383eaa450..e2b6bc060 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 f16c09c96..b91101721 100644 --- a/Documentation/Core.Point.html +++ b/Documentation/Core.Point.html @@ -16803,6 +16803,28 @@ When moose is loading dynamically (for moose class development), tracing is swit

Field(s)

+
+
+ + +POINT_VEC2.x + + + +
+ +
+
+
+ + +POINT_VEC2.z + + + +
+ +

Function(s)

diff --git a/Documentation/Core.Settings.html b/Documentation/Core.Settings.html index f19a85050..72d12ddf4 100644 --- a/Documentation/Core.Settings.html +++ b/Documentation/Core.Settings.html @@ -2864,7 +2864,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #string SETTINGS.A2GSystem @@ -2908,11 +2908,22 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #boolean SETTINGS.Metric +
+ +
+
+
+ + +SETTINGS.PlayerMenu + + +
@@ -5021,7 +5032,7 @@ It is advised to use this method at the start of the mission.

- + #string SETTINGS.A2GSystem @@ -5065,11 +5076,22 @@ 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 b31fdd1ee..7da0963a9 100644 --- a/Documentation/Core.Spawn.html +++ b/Documentation/Core.Spawn.html @@ -2988,36 +2988,18 @@ and any spaces before and after the resulting name are removed.

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

- - - -

SPAWN.communication

- -

SPAWN.frequency

- - - -

SPAWN.livery_id

- -

SPAWN.modulation

- - - -

SPAWN.skill

- - @@ -3583,11 +3565,14 @@ 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.

+
@@ -3759,17 +3744,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.SpawnGrouping - - -
@@ -3861,6 +3835,17 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau +
+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -3927,6 +3912,9 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau + +

By default, no InitLimit

+
@@ -3945,29 +3933,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
-SPAWN.SpawnInitModex - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPrefix +SPAWN.SpawnInitModu @@ -4024,7 +3990,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxGroups @@ -4038,7 +4004,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
- + #number SPAWN.SpawnMaxUnitsAlive @@ -4317,17 +4283,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.communication - - -
@@ -4339,17 +4294,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.livery_id - - -
@@ -4361,17 +4305,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- -
-
-
- - -SPAWN.skill - - -
@@ -9625,11 +9558,14 @@ 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.

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

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

+ +
+
+
+ + +SPAWN.SpawnInitFreq + + +
@@ -9969,6 +9905,9 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

By default, no InitLimit

+
@@ -9987,29 +9926,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

-SPAWN.SpawnInitModex - - - - - - -
-
- - -SPAWN.SpawnInitModexPostfix - - - -
- -
-
-
- - -SPAWN.SpawnInitModexPrefix +SPAWN.SpawnInitModu @@ -10066,7 +9983,7 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

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

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

- -
-
-
- - -SPAWN.communication - - -
@@ -10381,17 +10287,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - -SPAWN.livery_id - - -
@@ -10403,17 +10298,6 @@ This is needed to ensure that Re-SPAWNing only is done for landed AIR Groups.

- -
-
-
- - -SPAWN.skill - - -
diff --git a/Documentation/Core.Spot.html b/Documentation/Core.Spot.html index a3e956874..de04fc749 100644 --- a/Documentation/Core.Spot.html +++ b/Documentation/Core.Spot.html @@ -2815,39 +2815,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau -
- - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -4131,39 +4098,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - - - -
-
- - -SPOT.ScheduleID - - - -
- -
-
-
- - -SPOT.SpotIR - - - -
- -
-
-
- - -SPOT.SpotLaser - - -
@@ -5686,39 +5620,6 @@ 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 6baccaf35..f44b5f116 100644 --- a/Documentation/Functional.ATC_Ground.html +++ b/Documentation/Functional.ATC_Ground.html @@ -3894,9 +3894,6 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau - -

Kickspeed

- @@ -4482,9 +4479,6 @@ 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 648c903e5..a93bb141b 100644 --- a/Documentation/Functional.Detection.html +++ b/Documentation/Functional.Detection.html @@ -19354,6 +19354,28 @@ When moose is loading dynamically (for moose class development), tracing is swit + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -19486,17 +19508,6 @@ When moose is loading dynamically (for moose class development), tracing is swit - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -24112,6 +24123,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -24244,17 +24277,6 @@ zones that reflect cloudy areas where detected units may not be so easily visual - - - -
-
- - #boolean -DETECTION_BASE.Locking - - -
@@ -25865,6 +25887,28 @@ zones that reflect cloudy areas where detected units may not be so easily visual + + + +
+
+ + #number +DETECTION_BASE.DetectedItemCount + + + +
+ +
+
+
+ + #number +DETECTION_BASE.DetectedItemMax + + +
@@ -25997,17 +26041,6 @@ 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 2914127c9..452238839 100644 --- a/Documentation/Functional.Mantis.html +++ b/Documentation/Functional.Mantis.html @@ -1698,7 +1698,7 @@ This is case-sensitive, so "sa-11" is not equal to "SA-11" is not equal to "Sa-1